3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
14 @version @PACKAGE_VERSION@
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @section organization Organization
27 One can divide Elemementary into three main groups:
28 @li @ref infralist - These are modules that deal with Elementary as a whole.
29 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
30 @li @ref containerslist - These are the containers in which the widgets will be
33 @section license License
35 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
36 all files in the source tree.
38 @section ack Acknowledgements
39 There is a lot that goes into making a widget set, and they don't happen out of
40 nothing. It's like trying to make everyone everywhere happy, regardless of age,
41 gender, race or nationality - and that is really tough. So thanks to people and
42 organisations behind this, as listed in the @ref authors page.
47 @author Carsten Haitzler <raster@@rasterman.com>
48 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
49 @author Cedric Bail <cedric.bail@@free.fr>
50 @author Vincent Torri <vtorri@@univ-evry.fr>
51 @author Daniel Kolesa <quaker66@@gmail.com>
52 @author Jaime Thomas <avi.thomas@@gmail.com>
53 @author Swisscom - http://www.swisscom.ch/
54 @author Christopher Michael <devilhorns@@comcast.net>
55 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
56 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
57 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
58 @author Brian Wang <brian.wang.0721@@gmail.com>
59 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
60 @author Samsung Electronics <tbd>
61 @author Samsung SAIT <tbd>
62 @author Brett Nash <nash@@nash.id.au>
63 @author Bruno Dilly <bdilly@@profusion.mobi>
64 @author Rafael Fonseca <rfonseca@@profusion.mobi>
65 @author Chuneon Park <hermet@@hermet.pe.kr>
66 @author Woohyun Jung <wh0705.jung@@samsung.com>
67 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
68 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
69 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
70 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
71 @author Gustavo Lima Chaves <glima@@profusion.mobi>
72 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
73 @author Tiago Falcão <tiago@@profusion.mobi>
74 @author Otavio Pontes <otavio@@profusion.mobi>
75 @author Viktor Kojouharov <vkojouharov@@gmail.com>
76 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
77 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
78 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
79 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
80 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
81 @author Jihoon Kim <jihoon48.kim@@samsung.com>
82 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
83 @author Tom Hacohen <tom@@stosb.com>
84 @author Aharon Hillel <a.hillel@@partner.samsung.com>
85 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
86 @author Shinwoo Kim <kimcinoo@@gmail.com>
87 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
88 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
90 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
91 contact with the developers and maintainers.
99 * @brief Elementary's API
104 @ELM_UNIX_DEF@ ELM_UNIX
105 @ELM_WIN32_DEF@ ELM_WIN32
106 @ELM_WINCE_DEF@ ELM_WINCE
107 @ELM_EDBUS_DEF@ ELM_EDBUS
108 @ELM_EFREET_DEF@ ELM_EFREET
109 @ELM_ETHUMB_DEF@ ELM_ETHUMB
110 @ELM_EMAP_DEF@ ELM_EMAP
111 @ELM_DEBUG_DEF@ ELM_DEBUG
112 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
113 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
115 /* Standard headers for standard system calls etc. */
120 #include <sys/types.h>
121 #include <sys/stat.h>
122 #include <sys/time.h>
123 #include <sys/param.h>
136 # ifdef ELM_LIBINTL_H
137 # include <libintl.h>
148 #if defined (ELM_WIN32) || defined (ELM_WINCE)
151 # define alloca _alloca
162 #include <Ecore_Evas.h>
163 #include <Ecore_File.h>
164 #include <Ecore_IMF.h>
165 #include <Ecore_Con.h>
174 # include <Efreet_Mime.h>
175 # include <Efreet_Trash.h>
179 # include <Ethumb_Client.h>
191 # ifdef ELEMENTARY_BUILD
193 # define EAPI __declspec(dllexport)
196 # endif /* ! DLL_EXPORT */
198 # define EAPI __declspec(dllimport)
199 # endif /* ! EFL_EVAS_BUILD */
203 # define EAPI __attribute__ ((visibility("default")))
210 #endif /* ! _WIN32 */
213 /* allow usage from c++ */
218 #define ELM_VERSION_MAJOR @VMAJ@
219 #define ELM_VERSION_MINOR @VMIN@
221 typedef struct _Elm_Version
229 EAPI extern Elm_Version *elm_version;
232 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
233 #define ELM_PI 3.14159265358979323846
236 * @defgroup General General
238 * @brief General Elementary API. Functions that don't relate to
239 * Elementary objects specifically.
241 * Here are documented functions which init/shutdown the library,
242 * that apply to generic Elementary objects, that deal with
243 * configuration, et cetera.
245 * @ref general_functions_example_page "This" example contemplates
246 * some of these functions.
250 * @addtogroup General
255 * Defines couple of standard Evas_Object layers to be used
256 * with evas_object_layer_set().
258 * @note whenever extending with new values, try to keep some padding
259 * to siblings so there is room for further extensions.
261 typedef enum _Elm_Object_Layer
263 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
264 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
265 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
266 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
267 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
268 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
271 /**************************************************************************/
272 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
275 * Emitted when any Elementary's policy value is changed.
277 EAPI extern int ELM_EVENT_POLICY_CHANGED;
280 * @typedef Elm_Event_Policy_Changed
282 * Data on the event when an Elementary policy has changed
284 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
287 * @struct _Elm_Event_Policy_Changed
289 * Data on the event when an Elementary policy has changed
291 struct _Elm_Event_Policy_Changed
293 unsigned int policy; /**< the policy identifier */
294 int new_value; /**< value the policy had before the change */
295 int old_value; /**< new value the policy got */
299 * Policy identifiers.
301 typedef enum _Elm_Policy
303 ELM_POLICY_QUIT, /**< under which circunstances the application
304 * should quit automatically. @see
308 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
311 typedef enum _Elm_Policy_Quit
313 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
315 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
317 * window is closed */
318 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
320 typedef enum _Elm_Focus_Direction
324 } Elm_Focus_Direction;
326 typedef enum _Elm_Text_Format
328 ELM_TEXT_FORMAT_PLAIN_UTF8,
329 ELM_TEXT_FORMAT_MARKUP_UTF8
333 * Line wrapping types.
335 typedef enum _Elm_Wrap_Type
337 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
338 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
339 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
340 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
345 * @typedef Elm_Object_Item
346 * An Elementary Object item handle.
349 typedef struct _Elm_Object_Item Elm_Object_Item;
352 * Called back when a widget's tooltip is activated and needs content.
353 * @param data user-data given to elm_object_tooltip_content_cb_set()
354 * @param obj owner widget.
355 * @param tooltip The tooltip object (affix content to this!)
357 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
360 * Called back when a widget's item tooltip is activated and needs content.
361 * @param data user-data given to elm_object_tooltip_content_cb_set()
362 * @param obj owner widget.
363 * @param tooltip The tooltip object (affix content to this!)
364 * @param item context dependent item. As an example, if tooltip was
365 * set on Elm_List_Item, then it is of this type.
367 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
369 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
371 #ifndef ELM_LIB_QUICKLAUNCH
372 #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 */
374 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
377 /**************************************************************************/
381 * Initialize Elementary
383 * @param[in] argc System's argument count value
384 * @param[in] argv System's pointer to array of argument strings
385 * @return The init counter value.
387 * This function initializes Elementary and increments a counter of
388 * the number of calls to it. It returs the new counter's value.
390 * @warning This call is exported only for use by the @c ELM_MAIN()
391 * macro. There is no need to use this if you use this macro (which
392 * is highly advisable). An elm_main() should contain the entry
393 * point code for your application, having the same prototype as
394 * elm_init(), and @b not being static (putting the @c EAPI symbol
395 * in front of its type declaration is advisable). The @c
396 * ELM_MAIN() call should be placed just after it.
399 * @dontinclude bg_example_01.c
403 * See the full @ref bg_example_01_c "example".
405 * @see elm_shutdown().
408 EAPI int elm_init(int argc, char **argv);
411 * Shut down Elementary
413 * @return The init counter value.
415 * This should be called at the end of your application, just
416 * before it ceases to do any more processing. This will clean up
417 * any permanent resources your application may have allocated via
418 * Elementary that would otherwise persist.
420 * @see elm_init() for an example
424 EAPI int elm_shutdown(void);
427 * Run Elementary's main loop
429 * This call should be issued just after all initialization is
430 * completed. This function will not return until elm_exit() is
431 * called. It will keep looping, running the main
432 * (event/processing) loop for Elementary.
434 * @see elm_init() for an example
438 EAPI void elm_run(void);
441 * Exit Elementary's main loop
443 * If this call is issued, it will flag the main loop to cease
444 * processing and return back to its parent function (usually your
445 * elm_main() function).
447 * @see elm_init() for an example. There, just after a request to
448 * close the window comes, the main loop will be left.
450 * @note By using the #ELM_POLICY_QUIT on your Elementary
451 * applications, you'll this function called automatically for you.
455 EAPI void elm_exit(void);
458 * Provide information in order to make Elementary determine the @b
459 * run time location of the software in question, so other data files
460 * such as images, sound files, executable utilities, libraries,
461 * modules and locale files can be found.
463 * @param mainfunc This is your application's main function name,
464 * whose binary's location is to be found. Providing @c NULL
465 * will make Elementary not to use it
466 * @param dom This will be used as the application's "domain", in the
467 * form of a prefix to any environment variables that may
468 * override prefix detection and the directory name, inside the
469 * standard share or data directories, where the software's
470 * data files will be looked for.
471 * @param checkfile This is an (optional) magic file's path to check
472 * for existence (and it must be located in the data directory,
473 * under the share directory provided above). Its presence will
474 * help determine the prefix found was correct. Pass @c NULL if
475 * the check is not to be done.
477 * This function allows one to re-locate the application somewhere
478 * else after compilation, if the developer wishes for easier
479 * distribution of pre-compiled binaries.
481 * The prefix system is designed to locate where the given software is
482 * installed (under a common path prefix) at run time and then report
483 * specific locations of this prefix and common directories inside
484 * this prefix like the binary, library, data and locale directories,
485 * through the @c elm_app_*_get() family of functions.
487 * Call elm_app_info_set() early on before you change working
488 * directory or anything about @c argv[0], so it gets accurate
491 * It will then try and trace back which file @p mainfunc comes from,
492 * if provided, to determine the application's prefix directory.
494 * The @p dom parameter provides a string prefix to prepend before
495 * environment variables, allowing a fallback to @b specific
496 * environment variables to locate the software. You would most
497 * probably provide a lowercase string there, because it will also
498 * serve as directory domain, explained next. For environment
499 * variables purposes, this string is made uppercase. For example if
500 * @c "myapp" is provided as the prefix, then the program would expect
501 * @c "MYAPP_PREFIX" as a master environment variable to specify the
502 * exact install prefix for the software, or more specific environment
503 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
504 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
505 * the user or scripts before launching. If not provided (@c NULL),
506 * environment variables will not be used to override compiled-in
507 * defaults or auto detections.
509 * The @p dom string also provides a subdirectory inside the system
510 * shared data directory for data files. For example, if the system
511 * directory is @c /usr/local/share, then this directory name is
512 * appended, creating @c /usr/local/share/myapp, if it @p was @c
513 * "myapp". It is expected the application installs data files in
516 * The @p checkfile is a file name or path of something inside the
517 * share or data directory to be used to test that the prefix
518 * detection worked. For example, your app will install a wallpaper
519 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
520 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
523 * @see elm_app_compile_bin_dir_set()
524 * @see elm_app_compile_lib_dir_set()
525 * @see elm_app_compile_data_dir_set()
526 * @see elm_app_compile_locale_set()
527 * @see elm_app_prefix_dir_get()
528 * @see elm_app_bin_dir_get()
529 * @see elm_app_lib_dir_get()
530 * @see elm_app_data_dir_get()
531 * @see elm_app_locale_dir_get()
533 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
536 * Provide information on the @b fallback application's binaries
537 * directory, on scenarios where they get overriden by
538 * elm_app_info_set().
540 * @param dir The path to the default binaries directory (compile time
543 * @note Elementary will as well use this path to determine actual
544 * names of binaries' directory paths, maybe changing it to be @c
545 * something/local/bin instead of @c something/bin, only, for
548 * @warning You should call this function @b before
549 * elm_app_info_set().
551 EAPI void elm_app_compile_bin_dir_set(const char *dir);
554 * Provide information on the @b fallback application's libraries
555 * directory, on scenarios where they get overriden by
556 * elm_app_info_set().
558 * @param dir The path to the default libraries directory (compile
561 * @note Elementary will as well use this path to determine actual
562 * names of libraries' directory paths, maybe changing it to be @c
563 * something/lib32 or @c something/lib64 instead of @c something/lib,
566 * @warning You should call this function @b before
567 * elm_app_info_set().
569 EAPI void elm_app_compile_lib_dir_set(const char *dir);
572 * Provide information on the @b fallback application's data
573 * directory, on scenarios where they get overriden by
574 * elm_app_info_set().
576 * @param dir The path to the default data directory (compile time
579 * @note Elementary will as well use this path to determine actual
580 * names of data directory paths, maybe changing it to be @c
581 * something/local/share instead of @c something/share, only, for
584 * @warning You should call this function @b before
585 * elm_app_info_set().
587 EAPI void elm_app_compile_data_dir_set(const char *dir);
590 * Provide information on the @b fallback application's locale
591 * directory, on scenarios where they get overriden by
592 * elm_app_info_set().
594 * @param dir The path to the default locale directory (compile time
597 * @warning You should call this function @b before
598 * elm_app_info_set().
600 EAPI void elm_app_compile_locale_set(const char *dir);
603 * Retrieve the application's run time prefix directory, as set by
604 * elm_app_info_set() and the way (environment) the application was
607 * @return The directory prefix the application is actually using
609 EAPI const char *elm_app_prefix_dir_get(void);
612 * Retrieve the application's run time binaries prefix directory, as
613 * set by elm_app_info_set() and the way (environment) the application
616 * @return The binaries directory prefix the application is actually
619 EAPI const char *elm_app_bin_dir_get(void);
622 * Retrieve the application's run time libraries prefix directory, as
623 * set by elm_app_info_set() and the way (environment) the application
626 * @return The libraries directory prefix the application is actually
629 EAPI const char *elm_app_lib_dir_get(void);
632 * Retrieve the application's run time data prefix directory, as
633 * set by elm_app_info_set() and the way (environment) the application
636 * @return The data directory prefix the application is actually
639 EAPI const char *elm_app_data_dir_get(void);
642 * Retrieve the application's run time locale prefix directory, as
643 * set by elm_app_info_set() and the way (environment) the application
646 * @return The locale directory prefix the application is actually
649 EAPI const char *elm_app_locale_dir_get(void);
651 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
652 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
653 EAPI int elm_quicklaunch_init(int argc, char **argv);
654 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
655 EAPI int elm_quicklaunch_sub_shutdown(void);
656 EAPI int elm_quicklaunch_shutdown(void);
657 EAPI void elm_quicklaunch_seed(void);
658 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
659 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
660 EAPI void elm_quicklaunch_cleanup(void);
661 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
662 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
664 EAPI Eina_Bool elm_need_efreet(void);
665 EAPI Eina_Bool elm_need_e_dbus(void);
666 EAPI Eina_Bool elm_need_ethumb(void);
669 * Set a new policy's value (for a given policy group/identifier).
671 * @param policy policy identifier, as in @ref Elm_Policy.
672 * @param value policy value, which depends on the identifier
674 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
676 * Elementary policies define applications' behavior,
677 * somehow. These behaviors are divided in policy groups (see
678 * #Elm_Policy enumeration). This call will emit the Ecore event
679 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
680 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
683 * @note Currently, we have only one policy identifier/group
684 * (#ELM_POLICY_QUIT), which has two possible values.
688 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
691 * Gets the policy value set for given policy identifier.
693 * @param policy policy identifier, as in #Elm_Policy.
694 * @return The currently set policy value, for that
695 * identifier. Will be @c 0 if @p policy passed is invalid.
699 EAPI int elm_policy_get(unsigned int policy);
702 * Set a label of an object
704 * @param obj The Elementary object
705 * @param part The text part name to set (NULL for the default label)
706 * @param label The new text of the label
708 * @note Elementary objects may have many labels (e.g. Action Slider)
712 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
714 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
717 * Get a label of an object
719 * @param obj The Elementary object
720 * @param part The text part name to get (NULL for the default label)
721 * @return text of the label or NULL for any error
723 * @note Elementary objects may have many labels (e.g. Action Slider)
727 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
729 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
732 * Set a content of an object
734 * @param obj The Elementary object
735 * @param part The content part name to set (NULL for the default content)
736 * @param content The new content of the object
738 * @note Elementary objects may have many contents
742 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
744 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
747 * Get a content of an object
749 * @param obj The Elementary object
750 * @param item The content part name to get (NULL for the default content)
751 * @return content of the object or NULL for any error
753 * @note Elementary objects may have many contents
757 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
759 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
762 * Unset a content of an object
764 * @param obj The Elementary object
765 * @param item The content part name to unset (NULL for the default content)
767 * @note Elementary objects may have many contents
771 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
773 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
776 * Set a content of an object item
778 * @param it The Elementary object item
779 * @param part The content part name to unset (NULL for the default content)
780 * @param content The new content of the object item
782 * @note Elementary object items may have many contents
786 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
788 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
791 * Get a content of an object item
793 * @param it The Elementary object item
794 * @param part The content part name to unset (NULL for the default content)
795 * @return content of the object item or NULL for any error
797 * @note Elementary object items may have many contents
801 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
803 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
806 * Unset a content of an object item
808 * @param it The Elementary object item
809 * @param part The content part name to unset (NULL for the default content)
811 * @note Elementary object items may have many contents
815 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
817 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
820 * Set a label of an objec itemt
822 * @param it The Elementary object item
823 * @param part The text part name to set (NULL for the default label)
824 * @param label The new text of the label
826 * @note Elementary object items may have many labels
830 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
832 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
835 * Get a label of an object
837 * @param it The Elementary object item
838 * @param part The text part name to get (NULL for the default label)
839 * @return text of the label or NULL for any error
841 * @note Elementary object items may have many labels
845 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
847 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
853 EAPI void elm_all_flush(void);
854 EAPI int elm_cache_flush_interval_get(void);
855 EAPI void elm_cache_flush_interval_set(int size);
856 EAPI void elm_cache_flush_interval_all_set(int size);
857 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
858 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
859 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
860 EAPI int elm_font_cache_get(void);
861 EAPI void elm_font_cache_set(int size);
862 EAPI void elm_font_cache_all_set(int size);
863 EAPI int elm_image_cache_get(void);
864 EAPI void elm_image_cache_set(int size);
865 EAPI void elm_image_cache_all_set(int size);
866 EAPI int elm_edje_file_cache_get(void);
867 EAPI void elm_edje_file_cache_set(int size);
868 EAPI void elm_edje_file_cache_all_set(int size);
869 EAPI int elm_edje_collection_cache_get(void);
870 EAPI void elm_edje_collection_cache_set(int size);
871 EAPI void elm_edje_collection_cache_all_set(int size);
874 * @defgroup Scaling Selective Widget Scaling
876 * Different widgets can be scaled independently. These functions
877 * allow you to manipulate this scaling on a per-widget basis. The
878 * object and all its children get their scaling factors multiplied
879 * by the scale factor set. This is multiplicative, in that if a
880 * child also has a scale size set it is in turn multiplied by its
881 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
882 * double size, @c 0.5 is half, etc.
884 * @ref general_functions_example_page "This" example contemplates
885 * some of these functions.
889 * Set the scaling factor for a given Elementary object
891 * @param obj The Elementary to operate on
892 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
897 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
900 * Get the scaling factor for a given Elementary object
902 * @param obj The object
903 * @return The scaling factor set by elm_object_scale_set()
907 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
908 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
909 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
910 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
911 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
913 * Set the style to use by a widget
915 * Sets the style name that will define the appearance of a widget. Styles
916 * vary from widget to widget and may also be defined by other themes
917 * by means of extensions and overlays.
919 * @param obj The Elementary widget to style
920 * @param style The style name to use
922 * @see elm_theme_extension_add()
923 * @see elm_theme_overlay_add()
927 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
929 * Get the style used by the widget
931 * This gets the style being used for that widget. Note that the string
932 * pointer is only valid as longas the object is valid and the style doesn't
935 * @param obj The Elementary widget to query for its style
936 * @return The style name used
938 * @see elm_object_style_set()
942 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
945 * @defgroup Styles Styles
947 * Widgets can have different styles of look. These generic API's
948 * set styles of widgets, if they support them (and if the theme(s)
951 * @ref general_functions_example_page "This" example contemplates
952 * some of these functions.
956 * Set the disabled state of an Elementary object.
958 * @param obj The Elementary object to operate on
959 * @param disabled The state to put in in: @c EINA_TRUE for
960 * disabled, @c EINA_FALSE for enabled
962 * Elementary objects can be @b disabled, in which state they won't
963 * receive input and, in general, will be themed differently from
964 * their normal state, usually greyed out. Useful for contexts
965 * where you don't want your users to interact with some of the
966 * parts of you interface.
968 * This sets the state for the widget, either disabling it or
973 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
976 * Get the disabled state of an Elementary object.
978 * @param obj The Elementary object to operate on
979 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
980 * if it's enabled (or on errors)
982 * This gets the state of the widget, which might be enabled or disabled.
986 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
989 * @defgroup WidgetNavigation Widget Tree Navigation.
991 * How to check if an Evas Object is an Elementary widget? How to
992 * get the first elementary widget that is parent of the given
993 * object? These are all covered in widget tree navigation.
995 * @ref general_functions_example_page "This" example contemplates
996 * some of these functions.
999 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1002 * Get the first parent of the given object that is an Elementary
1005 * @param obj the Elementary object to query parent from.
1006 * @return the parent object that is an Elementary widget, or @c
1007 * NULL, if it was not found.
1009 * Use this to query for an object's parent widget.
1011 * @note Most of Elementary users wouldn't be mixing non-Elementary
1012 * smart objects in the objects tree of an application, as this is
1013 * an advanced usage of Elementary with Evas. So, except for the
1014 * application's window, which is the root of that tree, all other
1015 * objects would have valid Elementary widget parents.
1017 * @ingroup WidgetNavigation
1019 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1020 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1021 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1023 EAPI double elm_scale_get(void);
1024 EAPI void elm_scale_set(double scale);
1025 EAPI void elm_scale_all_set(double scale);
1027 EAPI Eina_Bool elm_mirrored_get(void);
1028 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1030 EAPI Eina_Bool elm_config_save(void);
1031 EAPI void elm_config_reload(void);
1033 EAPI const char *elm_profile_current_get(void);
1034 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1035 EAPI void elm_profile_dir_free(const char *p_dir);
1036 EAPI Eina_List *elm_profile_list_get(void);
1037 EAPI void elm_profile_list_free(Eina_List *l);
1038 EAPI void elm_profile_set(const char *profile);
1039 EAPI void elm_profile_all_set(const char *profile);
1041 EAPI const char *elm_engine_current_get(void);
1042 EAPI void elm_engine_set(const char *engine);
1044 typedef struct _Elm_Text_Class
1050 typedef struct _Elm_Font_Overlay
1052 const char *text_class;
1054 Evas_Font_Size size;
1057 typedef struct _Elm_Font_Properties
1061 } Elm_Font_Properties;
1063 EAPI const Eina_List *elm_text_classes_list_get(void);
1064 EAPI void elm_text_classes_list_free(const Eina_List *list);
1066 EAPI const Eina_List *elm_font_overlay_list_get(void);
1067 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1068 EAPI void elm_font_overlay_unset(const char *text_class);
1069 EAPI void elm_font_overlay_apply(void);
1070 EAPI void elm_font_overlay_all_apply(void);
1072 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1073 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1074 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1075 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1076 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1077 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1080 * @defgroup Fingers Fingers
1082 * Elementary is designed to be finger-friendly for touchscreens,
1083 * and so in addition to scaling for display resolution, it can
1084 * also scale based on finger "resolution" (or size). You can then
1085 * customize the granularity of the areas meant to receive clicks
1088 * Different profiles may have pre-set values for finger sizes.
1090 * @ref general_functions_example_page "This" example contemplates
1091 * some of these functions.
1095 * Get the configured "finger size"
1097 * @return The finger size
1099 * This gets the globally configured finger size, <b>in pixels</b>
1103 EAPI Evas_Coord elm_finger_size_get(void);
1104 EAPI void elm_finger_size_set(Evas_Coord size);
1105 EAPI void elm_finger_size_all_set(Evas_Coord size);
1108 * @defgroup Focus Focus
1110 * An Elementary application has, at all times, one (and only one)
1111 * @b focused object. This is what determines where the input
1112 * events go to within the application's window. Also, focused
1113 * objects can be decorated differently, in order to signal to the
1114 * user where the input is, at a given moment.
1116 * Elementary applications also have the concept of <b>focus
1117 * chain</b>: one can cycle through all the windows' focusable
1118 * objects by input (tab key) or programmatically. The default
1119 * focus chain for an application is the one define by the order in
1120 * which the widgets where added in code. One will cycle through
1121 * top level widgets, and, for each one containg sub-objects, cycle
1122 * through them all, before returning to the level
1123 * above. Elementary also allows one to set @b custom focus chains
1124 * for their applications.
1126 * Besides the focused decoration a widget may exhibit, when it
1127 * gets focus, Elementary has a @b global focus highlight object
1128 * that can be enabled for a window. If one chooses to do so, this
1129 * extra highlight effect will surround the current focused object,
1132 * @note Some Elementary widgets are @b unfocusable, after
1133 * creation, by their very nature: they are not meant to be
1134 * interacted with input events, but are there just for visual
1137 * @ref general_functions_example_page "This" example contemplates
1138 * some of these functions.
1141 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1142 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1143 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1144 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1147 * Get the whether an Elementary object has the focus or not.
1149 * @param obj The Elementary object to get the information from
1150 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1151 * not (and on errors).
1153 * @see elm_object_focus()
1157 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1160 * Set/unset focus to a given Elementary object.
1162 * @param obj The Elementary object to operate on.
1163 * @param enable @c EINA_TRUE Set focus to a given object,
1164 * @c EINA_FALSE Unset focus to a given object.
1166 * @note When you set focus to this object, if it can handle focus, will
1167 * take the focus away from the one who had it previously and will, for
1168 * now on, be the one receiving input events. Unsetting focus will remove
1169 * the focus from @p obj, passing it back to the previous element in the
1172 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
1176 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
1179 * Make a given Elementary object the focused one.
1181 * @param obj The Elementary object to make focused.
1183 * @note This object, if it can handle focus, will take the focus
1184 * away from the one who had it previously and will, for now on, be
1185 * the one receiving input events.
1187 * @see elm_object_focus_get()
1188 * @deprecated use elm_object_focus_set() instead.
1192 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1195 * Remove the focus from an Elementary object
1197 * @param obj The Elementary to take focus from
1199 * This removes the focus from @p obj, passing it back to the
1200 * previous element in the focus chain list.
1202 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1203 * @deprecated use elm_object_focus_set() instead.
1207 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1210 * Set the ability for an Element object to be focused
1212 * @param obj The Elementary object to operate on
1213 * @param enable @c EINA_TRUE if the object can be focused, @c
1214 * EINA_FALSE if not (and on errors)
1216 * This sets whether the object @p obj is able to take focus or
1217 * not. Unfocusable objects do nothing when programmatically
1218 * focused, being the nearest focusable parent object the one
1219 * really getting focus. Also, when they receive mouse input, they
1220 * will get the event, but not take away the focus from where it
1225 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1228 * Get whether an Elementary object is focusable or not
1230 * @param obj The Elementary object to operate on
1231 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1232 * EINA_FALSE if not (and on errors)
1234 * @note Objects which are meant to be interacted with by input
1235 * events are created able to be focused, by default. All the
1240 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1242 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1243 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1244 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1245 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1246 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1247 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1248 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1251 * Make the elementary object and its children to be unfocusable (or focusable).
1253 * @param obj The Elementary object to operate on
1254 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1255 * @c EINA_FALSE for focusable.
1257 * This sets whether the object @p obj and its children objects
1258 * are able to take focus or not. If the tree is set as unfocusable,
1259 * newest focused object which is not in this tree will get focus.
1260 * This API can be helpful for an object to be deleted.
1261 * When an object will be deleted soon, it and its children may not
1262 * want to get focus (by focus reverting or by other focus controls).
1263 * Then, just use this API before deleting.
1265 * @see elm_object_tree_unfocusable_get()
1269 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1272 * Get whether an Elementary object and its children are unfocusable or not.
1274 * @param obj The Elementary object to get the information from
1275 * @return @c EINA_TRUE, if the tree is unfocussable,
1276 * @c EINA_FALSE if not (and on errors).
1278 * @see elm_object_tree_unfocusable_set()
1282 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1284 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1285 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1286 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1287 EAPI double elm_scroll_bounce_friction_get(void);
1288 EAPI void elm_scroll_bounce_friction_set(double friction);
1289 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1290 EAPI double elm_scroll_page_scroll_friction_get(void);
1291 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1292 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1293 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1294 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1295 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1296 EAPI double elm_scroll_zoom_friction_get(void);
1297 EAPI void elm_scroll_zoom_friction_set(double friction);
1298 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1299 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1300 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1301 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1302 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1303 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1304 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1305 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1306 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1307 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1308 EAPI double elm_scroll_thumbscroll_friction_get(void);
1309 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1310 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1311 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1312 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1313 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1315 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1316 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1317 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1318 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1319 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1320 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1321 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1322 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1324 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1325 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);
1326 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);
1328 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1329 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1332 * Adjust size of an element for finger usage.
1334 * @param times_w How many fingers should fit horizontally
1335 * @param w Pointer to the width size to adjust
1336 * @param times_h How many fingers should fit vertically
1337 * @param h Pointer to the height size to adjust
1339 * This takes width and height sizes (in pixels) as input and a
1340 * size multiple (which is how many fingers you want to place
1341 * within the area, being "finger" the size set by
1342 * elm_finger_size_set()), and adjusts the size to be large enough
1343 * to accommodate the resulting size -- if it doesn't already
1344 * accommodate it. On return the @p w and @p h sizes pointed to by
1345 * these parameters will be modified, on those conditions.
1347 * @note This is kind of a low level Elementary call, most useful
1348 * on size evaluation times for widgets. An external user wouldn't
1349 * be calling, most of the time.
1353 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1355 EAPI double elm_longpress_timeout_get(void);
1356 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1359 * don't use it unless you are sure
1361 EAPI void elm_object_tree_dump(const Evas_Object *top);
1362 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1367 * @defgroup Theme Theme
1369 * Elementary uses Edje to theme its widgets, naturally. But for the most
1370 * part this is hidden behind a simpler interface that lets the user set
1371 * extensions and choose the style of widgets in a much easier way.
1373 * Instead of thinking in terms of paths to Edje files and their groups
1374 * each time you want to change the appearance of a widget, Elementary
1375 * works so you can add any theme file with extensions or replace the
1376 * main theme at one point in the application, and then just set the style
1377 * of widgets with elm_object_style_set() and related functions. Elementary
1378 * will then look in its list of themes for a matching group and apply it,
1379 * and when the theme changes midway through the application, all widgets
1380 * will be updated accordingly.
1382 * There are three concepts you need to know to understand how Elementary
1383 * theming works: default theme, extensions and overlays.
1385 * Default theme, obviously enough, is the one that provides the default
1386 * look of all widgets. End users can change the theme used by Elementary
1387 * by setting the @c ELM_THEME environment variable before running an
1388 * application, or globally for all programs using the @c elementary_config
1389 * utility. Applications can change the default theme using elm_theme_set(),
1390 * but this can go against the user wishes, so it's not an adviced practice.
1392 * Ideally, applications should find everything they need in the already
1393 * provided theme, but there may be occasions when that's not enough and
1394 * custom styles are required to correctly express the idea. For this
1395 * cases, Elementary has extensions.
1397 * Extensions allow the application developer to write styles of its own
1398 * to apply to some widgets. This requires knowledge of how each widget
1399 * is themed, as extensions will always replace the entire group used by
1400 * the widget, so important signals and parts need to be there for the
1401 * object to behave properly (see documentation of Edje for details).
1402 * Once the theme for the extension is done, the application needs to add
1403 * it to the list of themes Elementary will look into, using
1404 * elm_theme_extension_add(), and set the style of the desired widgets as
1405 * he would normally with elm_object_style_set().
1407 * Overlays, on the other hand, can replace the look of all widgets by
1408 * overriding the default style. Like extensions, it's up to the application
1409 * developer to write the theme for the widgets it wants, the difference
1410 * being that when looking for the theme, Elementary will check first the
1411 * list of overlays, then the set theme and lastly the list of extensions,
1412 * so with overlays it's possible to replace the default view and every
1413 * widget will be affected. This is very much alike to setting the whole
1414 * theme for the application and will probably clash with the end user
1415 * options, not to mention the risk of ending up with not matching styles
1416 * across the program. Unless there's a very special reason to use them,
1417 * overlays should be avoided for the resons exposed before.
1419 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1420 * keeps one default internally and every function that receives one of
1421 * these can be called with NULL to refer to this default (except for
1422 * elm_theme_free()). It's possible to create a new instance of a
1423 * ::Elm_Theme to set other theme for a specific widget (and all of its
1424 * children), but this is as discouraged, if not even more so, than using
1425 * overlays. Don't use this unless you really know what you are doing.
1427 * But to be less negative about things, you can look at the following
1429 * @li @ref theme_example_01 "Using extensions"
1430 * @li @ref theme_example_02 "Using overlays"
1435 * @typedef Elm_Theme
1437 * Opaque handler for the list of themes Elementary looks for when
1438 * rendering widgets.
1440 * Stay out of this unless you really know what you are doing. For most
1441 * cases, sticking to the default is all a developer needs.
1443 typedef struct _Elm_Theme Elm_Theme;
1446 * Create a new specific theme
1448 * This creates an empty specific theme that only uses the default theme. A
1449 * specific theme has its own private set of extensions and overlays too
1450 * (which are empty by default). Specific themes do not fall back to themes
1451 * of parent objects. They are not intended for this use. Use styles, overlays
1452 * and extensions when needed, but avoid specific themes unless there is no
1453 * other way (example: you want to have a preview of a new theme you are
1454 * selecting in a "theme selector" window. The preview is inside a scroller
1455 * and should display what the theme you selected will look like, but not
1456 * actually apply it yet. The child of the scroller will have a specific
1457 * theme set to show this preview before the user decides to apply it to all
1460 EAPI Elm_Theme *elm_theme_new(void);
1462 * Free a specific theme
1464 * @param th The theme to free
1466 * This frees a theme created with elm_theme_new().
1468 EAPI void elm_theme_free(Elm_Theme *th);
1470 * Copy the theme fom the source to the destination theme
1472 * @param th The source theme to copy from
1473 * @param thdst The destination theme to copy data to
1475 * This makes a one-time static copy of all the theme config, extensions
1476 * and overlays from @p th to @p thdst. If @p th references a theme, then
1477 * @p thdst is also set to reference it, with all the theme settings,
1478 * overlays and extensions that @p th had.
1480 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1482 * Tell the source theme to reference the ref theme
1484 * @param th The theme that will do the referencing
1485 * @param thref The theme that is the reference source
1487 * This clears @p th to be empty and then sets it to refer to @p thref
1488 * so @p th acts as an override to @p thref, but where its overrides
1489 * don't apply, it will fall through to @p thref for configuration.
1491 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1493 * Return the theme referred to
1495 * @param th The theme to get the reference from
1496 * @return The referenced theme handle
1498 * This gets the theme set as the reference theme by elm_theme_ref_set().
1499 * If no theme is set as a reference, NULL is returned.
1501 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1503 * Return the default theme
1505 * @return The default theme handle
1507 * This returns the internal default theme setup handle that all widgets
1508 * use implicitly unless a specific theme is set. This is also often use
1509 * as a shorthand of NULL.
1511 EAPI Elm_Theme *elm_theme_default_get(void);
1513 * Prepends a theme overlay to the list of overlays
1515 * @param th The theme to add to, or if NULL, the default theme
1516 * @param item The Edje file path to be used
1518 * Use this if your application needs to provide some custom overlay theme
1519 * (An Edje file that replaces some default styles of widgets) where adding
1520 * new styles, or changing system theme configuration is not possible. Do
1521 * NOT use this instead of a proper system theme configuration. Use proper
1522 * configuration files, profiles, environment variables etc. to set a theme
1523 * so that the theme can be altered by simple confiugration by a user. Using
1524 * this call to achieve that effect is abusing the API and will create lots
1527 * @see elm_theme_extension_add()
1529 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1531 * Delete a theme overlay from the list of overlays
1533 * @param th The theme to delete from, or if NULL, the default theme
1534 * @param item The name of the theme overlay
1536 * @see elm_theme_overlay_add()
1538 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1540 * Appends a theme extension to the list of extensions.
1542 * @param th The theme to add to, or if NULL, the default theme
1543 * @param item The Edje file path to be used
1545 * This is intended when an application needs more styles of widgets or new
1546 * widget themes that the default does not provide (or may not provide). The
1547 * application has "extended" usage by coming up with new custom style names
1548 * for widgets for specific uses, but as these are not "standard", they are
1549 * not guaranteed to be provided by a default theme. This means the
1550 * application is required to provide these extra elements itself in specific
1551 * Edje files. This call adds one of those Edje files to the theme search
1552 * path to be search after the default theme. The use of this call is
1553 * encouraged when default styles do not meet the needs of the application.
1554 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1556 * @see elm_object_style_set()
1558 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1560 * Deletes a theme extension from the list of extensions.
1562 * @param th The theme to delete from, or if NULL, the default theme
1563 * @param item The name of the theme extension
1565 * @see elm_theme_extension_add()
1567 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1569 * Set the theme search order for the given theme
1571 * @param th The theme to set the search order, or if NULL, the default theme
1572 * @param theme Theme search string
1574 * This sets the search string for the theme in path-notation from first
1575 * theme to search, to last, delimited by the : character. Example:
1577 * "shiny:/path/to/file.edj:default"
1579 * See the ELM_THEME environment variable for more information.
1581 * @see elm_theme_get()
1582 * @see elm_theme_list_get()
1584 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1586 * Return the theme search order
1588 * @param th The theme to get the search order, or if NULL, the default theme
1589 * @return The internal search order path
1591 * This function returns a colon separated string of theme elements as
1592 * returned by elm_theme_list_get().
1594 * @see elm_theme_set()
1595 * @see elm_theme_list_get()
1597 EAPI const char *elm_theme_get(Elm_Theme *th);
1599 * Return a list of theme elements to be used in a theme.
1601 * @param th Theme to get the list of theme elements from.
1602 * @return The internal list of theme elements
1604 * This returns the internal list of theme elements (will only be valid as
1605 * long as the theme is not modified by elm_theme_set() or theme is not
1606 * freed by elm_theme_free(). This is a list of strings which must not be
1607 * altered as they are also internal. If @p th is NULL, then the default
1608 * theme element list is returned.
1610 * A theme element can consist of a full or relative path to a .edj file,
1611 * or a name, without extension, for a theme to be searched in the known
1612 * theme paths for Elemementary.
1614 * @see elm_theme_set()
1615 * @see elm_theme_get()
1617 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1619 * Return the full patrh for a theme element
1621 * @param f The theme element name
1622 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1623 * @return The full path to the file found.
1625 * This returns a string you should free with free() on success, NULL on
1626 * failure. This will search for the given theme element, and if it is a
1627 * full or relative path element or a simple searchable name. The returned
1628 * path is the full path to the file, if searched, and the file exists, or it
1629 * is simply the full path given in the element or a resolved path if
1630 * relative to home. The @p in_search_path boolean pointed to is set to
1631 * EINA_TRUE if the file was a searchable file andis in the search path,
1632 * and EINA_FALSE otherwise.
1634 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1636 * Flush the current theme.
1638 * @param th Theme to flush
1640 * This flushes caches that let elementary know where to find theme elements
1641 * in the given theme. If @p th is NULL, then the default theme is flushed.
1642 * Call this function if source theme data has changed in such a way as to
1643 * make any caches Elementary kept invalid.
1645 EAPI void elm_theme_flush(Elm_Theme *th);
1647 * This flushes all themes (default and specific ones).
1649 * This will flush all themes in the current application context, by calling
1650 * elm_theme_flush() on each of them.
1652 EAPI void elm_theme_full_flush(void);
1654 * Set the theme for all elementary using applications on the current display
1656 * @param theme The name of the theme to use. Format same as the ELM_THEME
1657 * environment variable.
1659 EAPI void elm_theme_all_set(const char *theme);
1661 * Return a list of theme elements in the theme search path
1663 * @return A list of strings that are the theme element names.
1665 * This lists all available theme files in the standard Elementary search path
1666 * for theme elements, and returns them in alphabetical order as theme
1667 * element names in a list of strings. Free this with
1668 * elm_theme_name_available_list_free() when you are done with the list.
1670 EAPI Eina_List *elm_theme_name_available_list_new(void);
1672 * Free the list returned by elm_theme_name_available_list_new()
1674 * This frees the list of themes returned by
1675 * elm_theme_name_available_list_new(). Once freed the list should no longer
1676 * be used. a new list mys be created.
1678 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1680 * Set a specific theme to be used for this object and its children
1682 * @param obj The object to set the theme on
1683 * @param th The theme to set
1685 * This sets a specific theme that will be used for the given object and any
1686 * child objects it has. If @p th is NULL then the theme to be used is
1687 * cleared and the object will inherit its theme from its parent (which
1688 * ultimately will use the default theme if no specific themes are set).
1690 * Use special themes with great care as this will annoy users and make
1691 * configuration difficult. Avoid any custom themes at all if it can be
1694 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1696 * Get the specific theme to be used
1698 * @param obj The object to get the specific theme from
1699 * @return The specifc theme set.
1701 * This will return a specific theme set, or NULL if no specific theme is
1702 * set on that object. It will not return inherited themes from parents, only
1703 * the specific theme set for that specific object. See elm_object_theme_set()
1704 * for more information.
1706 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1712 /** @defgroup Win Win
1714 * @image html img/widget/win/preview-00.png
1715 * @image latex img/widget/win/preview-00.eps
1717 * The window class of Elementary. Contains functions to manipulate
1718 * windows. The Evas engine used to render the window contents is specified
1719 * in the system or user elementary config files (whichever is found last),
1720 * and can be overridden with the ELM_ENGINE environment variable for
1721 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
1722 * compilation setup and modules actually installed at runtime) are (listed
1723 * in order of best supported and most likely to be complete and work to
1726 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
1727 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
1729 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
1731 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
1733 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
1735 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
1736 * rendering using SDL as the buffer)
1737 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
1738 * GDI with software)
1739 * @li "dfb", "directfb" (Rendering to a DirectFB window)
1740 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
1741 * grayscale using dedicated 8bit software engine in X11)
1742 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
1743 * X11 using 16bit software engine)
1744 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
1745 * (Windows CE rendering via GDI with 16bit software renderer)
1746 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
1747 * buffer with 16bit software renderer)
1749 * All engines use a simple string to select the engine to render, EXCEPT
1750 * the "shot" engine. This actually encodes the output of the virtual
1751 * screenshot and how long to delay in the engine string. The engine string
1752 * is encoded in the following way:
1754 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
1756 * Where options are separated by a ":" char if more than one option is
1757 * given, with delay, if provided being the first option and file the last
1758 * (order is important). The delay specifies how long to wait after the
1759 * window is shown before doing the virtual "in memory" rendering and then
1760 * save the output to the file specified by the file option (and then exit).
1761 * If no delay is given, the default is 0.5 seconds. If no file is given the
1762 * default output file is "out.png". Repeat option is for continous
1763 * capturing screenshots. Repeat range is from 1 to 999 and filename is
1764 * fixed to "out001.png" Some examples of using the shot engine:
1766 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
1767 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
1768 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
1769 * ELM_ENGINE="shot:delay=2.0" elementary_test
1770 * ELM_ENGINE="shot:" elementary_test
1772 * Signals that you can add callbacks for are:
1774 * @li "delete,request": the user requested to close the window. See
1775 * elm_win_autodel_set().
1776 * @li "focus,in": window got focus
1777 * @li "focus,out": window lost focus
1778 * @li "moved": window that holds the canvas was moved
1781 * @li @ref win_example_01
1786 * Defines the types of window that can be created
1788 * These are hints set on the window so that a running Window Manager knows
1789 * how the window should be handled and/or what kind of decorations it
1792 * Currently, only the X11 backed engines use them.
1794 typedef enum _Elm_Win_Type
1796 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
1797 window. Almost every window will be created with this
1799 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
1800 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
1801 window holding desktop icons. */
1802 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
1803 be kept on top of any other window by the Window
1805 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
1807 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
1808 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
1810 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
1811 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
1812 entry in a menubar is clicked. Typically used
1813 with elm_win_override_set(). This hint exists
1814 for completion only, as the EFL way of
1815 implementing a menu would not normally use a
1816 separate window for its contents. */
1817 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
1818 triggered by right-clicking an object. */
1819 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
1820 explanatory text that typically appear after the
1821 mouse cursor hovers over an object for a while.
1822 Typically used with elm_win_override_set() and also
1823 not very commonly used in the EFL. */
1824 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
1825 battery life or a new E-Mail received. */
1826 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
1827 usually used in the EFL. */
1828 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
1829 object being dragged across different windows, or even
1830 applications. Typically used with
1831 elm_win_override_set(). */
1832 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
1833 buffer. No actual window is created for this
1834 type, instead the window and all of its
1835 contents will be rendered to an image buffer.
1836 This allows to have children window inside a
1837 parent one just like any other object would
1838 be, and do other things like applying @c
1839 Evas_Map effects to it. This is the only type
1840 of window that requires the @c parent
1841 parameter of elm_win_add() to be a valid @c
1846 * The differents layouts that can be requested for the virtual keyboard.
1848 * When the application window is being managed by Illume, it may request
1849 * any of the following layouts for the virtual keyboard.
1851 typedef enum _Elm_Win_Keyboard_Mode
1853 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
1854 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
1855 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
1856 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
1857 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
1858 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
1859 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
1860 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
1861 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
1862 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
1863 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
1864 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
1865 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
1866 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
1867 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
1868 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
1869 } Elm_Win_Keyboard_Mode;
1872 * Available commands that can be sent to the Illume manager.
1874 * When running under an Illume session, a window may send commands to the
1875 * Illume manager to perform different actions.
1877 typedef enum _Elm_Illume_Command
1879 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
1881 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
1883 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
1885 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
1886 } Elm_Illume_Command;
1889 * Adds a window object. If this is the first window created, pass NULL as
1892 * @param parent Parent object to add the window to, or NULL
1893 * @param name The name of the window
1894 * @param type The window type, one of #Elm_Win_Type.
1896 * The @p parent paramter can be @c NULL for every window @p type except
1897 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
1898 * which the image object will be created.
1900 * @return The created object, or NULL on failure
1902 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1904 * Add @p subobj as a resize object of window @p obj.
1907 * Setting an object as a resize object of the window means that the
1908 * @p subobj child's size and position will be controlled by the window
1909 * directly. That is, the object will be resized to match the window size
1910 * and should never be moved or resized manually by the developer.
1912 * In addition, resize objects of the window control what the minimum size
1913 * of it will be, as well as whether it can or not be resized by the user.
1915 * For the end user to be able to resize a window by dragging the handles
1916 * or borders provided by the Window Manager, or using any other similar
1917 * mechanism, all of the resize objects in the window should have their
1918 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
1920 * @param obj The window object
1921 * @param subobj The resize object to add
1923 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1925 * Delete @p subobj as a resize object of window @p obj.
1927 * This function removes the object @p subobj from the resize objects of
1928 * the window @p obj. It will not delete the object itself, which will be
1929 * left unmanaged and should be deleted by the developer, manually handled
1930 * or set as child of some other container.
1932 * @param obj The window object
1933 * @param subobj The resize object to add
1935 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1937 * Set the title of the window
1939 * @param obj The window object
1940 * @param title The title to set
1942 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1944 * Get the title of the window
1946 * The returned string is an internal one and should not be freed or
1947 * modified. It will also be rendered invalid if a new title is set or if
1948 * the window is destroyed.
1950 * @param obj The window object
1953 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1955 * Set the window's autodel state.
1957 * When closing the window in any way outside of the program control, like
1958 * pressing the X button in the titlebar or using a command from the
1959 * Window Manager, a "delete,request" signal is emitted to indicate that
1960 * this event occurred and the developer can take any action, which may
1961 * include, or not, destroying the window object.
1963 * When the @p autodel parameter is set, the window will be automatically
1964 * destroyed when this event occurs, after the signal is emitted.
1965 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
1966 * and is up to the program to do so when it's required.
1968 * @param obj The window object
1969 * @param autodel If true, the window will automatically delete itself when
1972 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1974 * Get the window's autodel state.
1976 * @param obj The window object
1977 * @return If the window will automatically delete itself when closed
1979 * @see elm_win_autodel_set()
1981 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1983 * Activate a window object.
1985 * This function sends a request to the Window Manager to activate the
1986 * window pointed by @p obj. If honored by the WM, the window will receive
1987 * the keyboard focus.
1989 * @note This is just a request that a Window Manager may ignore, so calling
1990 * this function does not ensure in any way that the window will be the
1991 * active one after it.
1993 * @param obj The window object
1995 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1997 * Lower a window object.
1999 * Places the window pointed by @p obj at the bottom of the stack, so that
2000 * no other window is covered by it.
2002 * If elm_win_override_set() is not set, the Window Manager may ignore this
2005 * @param obj The window object
2007 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
2009 * Raise a window object.
2011 * Places the window pointed by @p obj at the top of the stack, so that it's
2012 * not covered by any other window.
2014 * If elm_win_override_set() is not set, the Window Manager may ignore this
2017 * @param obj The window object
2019 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2021 * Set the borderless state of a window.
2023 * This function requests the Window Manager to not draw any decoration
2024 * around the window.
2026 * @param obj The window object
2027 * @param borderless If true, the window is borderless
2029 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2031 * Get the borderless state of a window.
2033 * @param obj The window object
2034 * @return If true, the window is borderless
2036 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2038 * Set the shaped state of a window.
2040 * Shaped windows, when supported, will render the parts of the window that
2041 * has no content, transparent.
2043 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
2044 * background object or cover the entire window in any other way, or the
2045 * parts of the canvas that have no data will show framebuffer artifacts.
2047 * @param obj The window object
2048 * @param shaped If true, the window is shaped
2050 * @see elm_win_alpha_set()
2052 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2054 * Get the shaped state of a window.
2056 * @param obj The window object
2057 * @return If true, the window is shaped
2059 * @see elm_win_shaped_set()
2061 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2063 * Set the alpha channel state of a window.
2065 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
2066 * possibly making parts of the window completely or partially transparent.
2067 * This is also subject to the underlying system supporting it, like for
2068 * example, running under a compositing manager. If no compositing is
2069 * available, enabling this option will instead fallback to using shaped
2070 * windows, with elm_win_shaped_set().
2072 * @param obj The window object
2073 * @param alpha If true, the window has an alpha channel
2075 * @see elm_win_alpha_set()
2077 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2079 * Get the transparency state of a window.
2081 * @param obj The window object
2082 * @return If true, the window is transparent
2084 * @see elm_win_transparent_set()
2086 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2088 * Set the transparency state of a window.
2090 * Use elm_win_alpha_set() instead.
2092 * @param obj The window object
2093 * @param transparent If true, the window is transparent
2095 * @see elm_win_alpha_set()
2097 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2099 * Get the alpha channel state of a window.
2101 * @param obj The window object
2102 * @return If true, the window has an alpha channel
2104 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2106 * Set the override state of a window.
2108 * A window with @p override set to EINA_TRUE will not be managed by the
2109 * Window Manager. This means that no decorations of any kind will be shown
2110 * for it, moving and resizing must be handled by the application, as well
2111 * as the window visibility.
2113 * This should not be used for normal windows, and even for not so normal
2114 * ones, it should only be used when there's a good reason and with a lot
2115 * of care. Mishandling override windows may result situations that
2116 * disrupt the normal workflow of the end user.
2118 * @param obj The window object
2119 * @param override If true, the window is overridden
2121 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2123 * Get the override state of a window.
2125 * @param obj The window object
2126 * @return If true, the window is overridden
2128 * @see elm_win_override_set()
2130 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2132 * Set the fullscreen state of a window.
2134 * @param obj The window object
2135 * @param fullscreen If true, the window is fullscreen
2137 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2139 * Get the fullscreen state of a window.
2141 * @param obj The window object
2142 * @return If true, the window is fullscreen
2144 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2146 * Set the maximized state of a window.
2148 * @param obj The window object
2149 * @param maximized If true, the window is maximized
2151 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2153 * Get the maximized state of a window.
2155 * @param obj The window object
2156 * @return If true, the window is maximized
2158 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2160 * Set the iconified state of a window.
2162 * @param obj The window object
2163 * @param iconified If true, the window is iconified
2165 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2167 * Get the iconified state of a window.
2169 * @param obj The window object
2170 * @return If true, the window is iconified
2172 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2174 * Set the layer of the window.
2176 * What this means exactly will depend on the underlying engine used.
2178 * In the case of X11 backed engines, the value in @p layer has the
2179 * following meanings:
2180 * @li < 3: The window will be placed below all others.
2181 * @li > 5: The window will be placed above all others.
2182 * @li other: The window will be placed in the default layer.
2184 * @param obj The window object
2185 * @param layer The layer of the window
2187 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2189 * Get the layer of the window.
2191 * @param obj The window object
2192 * @return The layer of the window
2194 * @see elm_win_layer_set()
2196 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2198 * Set the rotation of the window.
2200 * Most engines only work with multiples of 90.
2202 * This function is used to set the orientation of the window @p obj to
2203 * match that of the screen. The window itself will be resized to adjust
2204 * to the new geometry of its contents. If you want to keep the window size,
2205 * see elm_win_rotation_with_resize_set().
2207 * @param obj The window object
2208 * @param rotation The rotation of the window, in degrees (0-360),
2209 * counter-clockwise.
2211 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2213 * Rotates the window and resizes it.
2215 * Like elm_win_rotation_set(), but it also resizes the window's contents so
2216 * that they fit inside the current window geometry.
2218 * @param obj The window object
2219 * @param layer The rotation of the window in degrees (0-360),
2220 * counter-clockwise.
2222 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2224 * Get the rotation of the window.
2226 * @param obj The window object
2227 * @return The rotation of the window in degrees (0-360)
2229 * @see elm_win_rotation_set()
2230 * @see elm_win_rotation_with_resize_set()
2232 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2234 * Set the sticky state of the window.
2236 * Hints the Window Manager that the window in @p obj should be left fixed
2237 * at its position even when the virtual desktop it's on moves or changes.
2239 * @param obj The window object
2240 * @param sticky If true, the window's sticky state is enabled
2242 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2244 * Get the sticky state of the window.
2246 * @param obj The window object
2247 * @return If true, the window's sticky state is enabled
2249 * @see elm_win_sticky_set()
2251 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2253 * Set if this window is an illume conformant window
2255 * @param obj The window object
2256 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
2258 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2260 * Get if this window is an illume conformant window
2262 * @param obj The window object
2263 * @return A boolean if this window is illume conformant or not
2265 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2267 * Set a window to be an illume quickpanel window
2269 * By default window objects are not quickpanel windows.
2271 * @param obj The window object
2272 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
2274 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2276 * Get if this window is a quickpanel or not
2278 * @param obj The window object
2279 * @return A boolean if this window is a quickpanel or not
2281 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2283 * Set the major priority of a quickpanel window
2285 * @param obj The window object
2286 * @param priority The major priority for this quickpanel
2288 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2290 * Get the major priority of a quickpanel window
2292 * @param obj The window object
2293 * @return The major priority of this quickpanel
2295 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2297 * Set the minor priority of a quickpanel window
2299 * @param obj The window object
2300 * @param priority The minor priority for this quickpanel
2302 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2304 * Get the minor priority of a quickpanel window
2306 * @param obj The window object
2307 * @return The minor priority of this quickpanel
2309 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2311 * Set which zone this quickpanel should appear in
2313 * @param obj The window object
2314 * @param zone The requested zone for this quickpanel
2316 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2318 * Get which zone this quickpanel should appear in
2320 * @param obj The window object
2321 * @return The requested zone for this quickpanel
2323 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2325 * Set the window to be skipped by keyboard focus
2327 * This sets the window to be skipped by normal keyboard input. This means
2328 * a window manager will be asked to not focus this window as well as omit
2329 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
2331 * Call this and enable it on a window BEFORE you show it for the first time,
2332 * otherwise it may have no effect.
2334 * Use this for windows that have only output information or might only be
2335 * interacted with by the mouse or fingers, and never for typing input.
2336 * Be careful that this may have side-effects like making the window
2337 * non-accessible in some cases unless the window is specially handled. Use
2340 * @param obj The window object
2341 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
2343 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2345 * Send a command to the windowing environment
2347 * This is intended to work in touchscreen or small screen device
2348 * environments where there is a more simplistic window management policy in
2349 * place. This uses the window object indicated to select which part of the
2350 * environment to control (the part that this window lives in), and provides
2351 * a command and an optional parameter structure (use NULL for this if not
2354 * @param obj The window object that lives in the environment to control
2355 * @param command The command to send
2356 * @param params Optional parameters for the command
2358 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2360 * Get the inlined image object handle
2362 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
2363 * then the window is in fact an evas image object inlined in the parent
2364 * canvas. You can get this object (be careful to not manipulate it as it
2365 * is under control of elementary), and use it to do things like get pixel
2366 * data, save the image to a file, etc.
2368 * @param obj The window object to get the inlined image from
2369 * @return The inlined image object, or NULL if none exists
2371 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2373 * Set the enabled status for the focus highlight in a window
2375 * This function will enable or disable the focus highlight only for the
2376 * given window, regardless of the global setting for it
2378 * @param obj The window where to enable the highlight
2379 * @param enabled The enabled value for the highlight
2381 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2383 * Get the enabled value of the focus highlight for this window
2385 * @param obj The window in which to check if the focus highlight is enabled
2387 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
2389 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2391 * Set the style for the focus highlight on this window
2393 * Sets the style to use for theming the highlight of focused objects on
2394 * the given window. If @p style is NULL, the default will be used.
2396 * @param obj The window where to set the style
2397 * @param style The style to set
2399 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2401 * Get the style set for the focus highlight object
2403 * Gets the style set for this windows highilght object, or NULL if none
2406 * @param obj The window to retrieve the highlights style from
2408 * @return The style set or NULL if none was. Default is used in that case.
2410 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2412 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2413 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2414 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2415 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2416 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2417 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2418 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2420 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2421 * (blank mouse, private mouse obj, defaultmouse)
2425 * Sets the keyboard mode of the window.
2427 * @param obj The window object
2428 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
2430 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2432 * Gets the keyboard mode of the window.
2434 * @param obj The window object
2435 * @return The mode, one of #Elm_Win_Keyboard_Mode
2437 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2439 * Sets whether the window is a keyboard.
2441 * @param obj The window object
2442 * @param is_keyboard If true, the window is a virtual keyboard
2444 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2446 * Gets whether the window is a keyboard.
2448 * @param obj The window object
2449 * @return If the window is a virtual keyboard
2451 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2454 * Get the screen position of a window.
2456 * @param obj The window object
2457 * @param x The int to store the x coordinate to
2458 * @param y The int to store the y coordinate to
2460 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2466 * @defgroup Inwin Inwin
2468 * @image html img/widget/inwin/preview-00.png
2469 * @image latex img/widget/inwin/preview-00.eps
2470 * @image html img/widget/inwin/preview-01.png
2471 * @image latex img/widget/inwin/preview-01.eps
2472 * @image html img/widget/inwin/preview-02.png
2473 * @image latex img/widget/inwin/preview-02.eps
2475 * An inwin is a window inside a window that is useful for a quick popup.
2476 * It does not hover.
2478 * It works by creating an object that will occupy the entire window, so it
2479 * must be created using an @ref Win "elm_win" as parent only. The inwin
2480 * object can be hidden or restacked below every other object if it's
2481 * needed to show what's behind it without destroying it. If this is done,
2482 * the elm_win_inwin_activate() function can be used to bring it back to
2483 * full visibility again.
2485 * There are three styles available in the default theme. These are:
2486 * @li default: The inwin is sized to take over most of the window it's
2488 * @li minimal: The size of the inwin will be the minimum necessary to show
2490 * @li minimal_vertical: Horizontally, the inwin takes as much space as
2491 * possible, but it's sized vertically the most it needs to fit its\
2494 * Some examples of Inwin can be found in the following:
2495 * @li @ref inwin_example_01
2500 * Adds an inwin to the current window
2502 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
2503 * Never call this function with anything other than the top-most window
2504 * as its parameter, unless you are fond of undefined behavior.
2506 * After creating the object, the widget will set itself as resize object
2507 * for the window with elm_win_resize_object_add(), so when shown it will
2508 * appear to cover almost the entire window (how much of it depends on its
2509 * content and the style used). It must not be added into other container
2510 * objects and it needs not be moved or resized manually.
2512 * @param parent The parent object
2513 * @return The new object or NULL if it cannot be created
2515 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2517 * Activates an inwin object, ensuring its visibility
2519 * This function will make sure that the inwin @p obj is completely visible
2520 * by calling evas_object_show() and evas_object_raise() on it, to bring it
2521 * to the front. It also sets the keyboard focus to it, which will be passed
2524 * The object's theme will also receive the signal "elm,action,show" with
2527 * @param obj The inwin to activate
2529 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2531 * Set the content of an inwin object.
2533 * Once the content object is set, a previously set one will be deleted.
2534 * If you want to keep that old content object, use the
2535 * elm_win_inwin_content_unset() function.
2537 * @param obj The inwin object
2538 * @param content The object to set as content
2540 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2542 * Get the content of an inwin object.
2544 * Return the content object which is set for this widget.
2546 * The returned object is valid as long as the inwin is still alive and no
2547 * other content is set on it. Deleting the object will notify the inwin
2548 * about it and this one will be left empty.
2550 * If you need to remove an inwin's content to be reused somewhere else,
2551 * see elm_win_inwin_content_unset().
2553 * @param obj The inwin object
2554 * @return The content that is being used
2556 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2558 * Unset the content of an inwin object.
2560 * Unparent and return the content object which was set for this widget.
2562 * @param obj The inwin object
2563 * @return The content that was being used
2565 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2569 /* X specific calls - won't work on non-x engines (return 0) */
2570 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2571 /* smart callbacks called:
2572 * "delete,request" - the user requested to delete the window
2573 * "focus,in" - window got focus
2574 * "focus,out" - window lost focus
2575 * "moved" - window that holds the canvas was moved
2581 * @image html img/widget/bg/preview-00.png
2582 * @image latex img/widget/bg/preview-00.eps
2584 * @brief Background object, used for setting a solid color, image or Edje
2585 * group as background to a window or any container object.
2587 * The bg object is used for setting a solid background to a window or
2588 * packing into any container object. It works just like an image, but has
2589 * some properties useful to a background, like setting it to tiled,
2590 * centered, scaled or stretched.
2592 * Here is some sample code using it:
2593 * @li @ref bg_01_example_page
2594 * @li @ref bg_02_example_page
2595 * @li @ref bg_03_example_page
2599 typedef enum _Elm_Bg_Option
2601 ELM_BG_OPTION_CENTER, /**< center the background */
2602 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2603 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2604 ELM_BG_OPTION_TILE /**< tile background at its original size */
2608 * Add a new background to the parent
2610 * @param parent The parent object
2611 * @return The new object or NULL if it cannot be created
2615 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2618 * Set the file (image or edje) used for the background
2620 * @param obj The bg object
2621 * @param file The file path
2622 * @param group Optional key (group in Edje) within the file
2624 * This sets the image file used in the background object. The image (or edje)
2625 * will be stretched (retaining aspect if its an image file) to completely fill
2626 * the bg object. This may mean some parts are not visible.
2628 * @note Once the image of @p obj is set, a previously set one will be deleted,
2629 * even if @p file is NULL.
2633 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2636 * Get the file (image or edje) used for the background
2638 * @param obj The bg object
2639 * @param file The file path
2640 * @param group Optional key (group in Edje) within the file
2644 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2647 * Set the option used for the background image
2649 * @param obj The bg object
2650 * @param option The desired background option (TILE, SCALE)
2652 * This sets the option used for manipulating the display of the background
2653 * image. The image can be tiled or scaled.
2657 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2660 * Get the option used for the background image
2662 * @param obj The bg object
2663 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2667 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2669 * Set the option used for the background color
2671 * @param obj The bg object
2676 * This sets the color used for the background rectangle. Its range goes
2681 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2683 * Get the option used for the background color
2685 * @param obj The bg object
2692 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2695 * Set the overlay object used for the background object.
2697 * @param obj The bg object
2698 * @param overlay The overlay object
2700 * This provides a way for elm_bg to have an 'overlay' that will be on top
2701 * of the bg. Once the over object is set, a previously set one will be
2702 * deleted, even if you set the new one to NULL. If you want to keep that
2703 * old content object, use the elm_bg_overlay_unset() function.
2708 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2711 * Get the overlay object used for the background object.
2713 * @param obj The bg object
2714 * @return The content that is being used
2716 * Return the content object which is set for this widget
2720 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2723 * Get the overlay object used for the background object.
2725 * @param obj The bg object
2726 * @return The content that was being used
2728 * Unparent and return the overlay object which was set for this widget
2732 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2735 * Set the size of the pixmap representation of the image.
2737 * This option just makes sense if an image is going to be set in the bg.
2739 * @param obj The bg object
2740 * @param w The new width of the image pixmap representation.
2741 * @param h The new height of the image pixmap representation.
2743 * This function sets a new size for pixmap representation of the given bg
2744 * image. It allows the image to be loaded already in the specified size,
2745 * reducing the memory usage and load time when loading a big image with load
2746 * size set to a smaller size.
2748 * NOTE: this is just a hint, the real size of the pixmap may differ
2749 * depending on the type of image being loaded, being bigger than requested.
2753 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2754 /* smart callbacks called:
2758 * @defgroup Icon Icon
2760 * @image html img/widget/icon/preview-00.png
2761 * @image latex img/widget/icon/preview-00.eps
2763 * An object that provides standard icon images (delete, edit, arrows, etc.)
2764 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
2766 * The icon image requested can be in the elementary theme, or in the
2767 * freedesktop.org paths. It's possible to set the order of preference from
2768 * where the image will be used.
2770 * This API is very similar to @ref Image, but with ready to use images.
2772 * Default images provided by the theme are described below.
2774 * The first list contains icons that were first intended to be used in
2775 * toolbars, but can be used in many other places too:
2791 * Now some icons that were designed to be used in menus (but again, you can
2792 * use them anywhere else):
2797 * @li menu/arrow_down
2798 * @li menu/arrow_left
2799 * @li menu/arrow_right
2808 * And here we have some media player specific icons:
2809 * @li media_player/forward
2810 * @li media_player/info
2811 * @li media_player/next
2812 * @li media_player/pause
2813 * @li media_player/play
2814 * @li media_player/prev
2815 * @li media_player/rewind
2816 * @li media_player/stop
2818 * Signals that you can add callbacks for are:
2820 * "clicked" - This is called when a user has clicked the icon
2822 * An example of usage for this API follows:
2823 * @li @ref tutorial_icon
2831 typedef enum _Elm_Icon_Type
2838 * @enum _Elm_Icon_Lookup_Order
2839 * @typedef Elm_Icon_Lookup_Order
2841 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
2842 * theme, FDO paths, or both?
2846 typedef enum _Elm_Icon_Lookup_Order
2848 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2849 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2850 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
2851 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
2852 } Elm_Icon_Lookup_Order;
2855 * Add a new icon object to the parent.
2857 * @param parent The parent object
2858 * @return The new object or NULL if it cannot be created
2860 * @see elm_icon_file_set()
2864 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2866 * Set the file that will be used as icon.
2868 * @param obj The icon object
2869 * @param file The path to file that will be used as icon image
2870 * @param group The group that the icon belongs to in edje file
2872 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2874 * @note The icon image set by this function can be changed by
2875 * elm_icon_standard_set().
2877 * @see elm_icon_file_get()
2881 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2883 * Set a location in memory to be used as an icon
2885 * @param obj The icon object
2886 * @param img The binary data that will be used as an image
2887 * @param size The size of binary data @p img
2888 * @param format Optional format of @p img to pass to the image loader
2889 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
2891 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2893 * @note The icon image set by this function can be changed by
2894 * elm_icon_standard_set().
2898 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);
2900 * Get the file that will be used as icon.
2902 * @param obj The icon object
2903 * @param file The path to file that will be used as icon icon image
2904 * @param group The group that the icon belongs to in edje file
2906 * @see elm_icon_file_set()
2910 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2911 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2913 * Set the icon by icon standards names.
2915 * @param obj The icon object
2916 * @param name The icon name
2918 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2920 * For example, freedesktop.org defines standard icon names such as "home",
2921 * "network", etc. There can be different icon sets to match those icon
2922 * keys. The @p name given as parameter is one of these "keys", and will be
2923 * used to look in the freedesktop.org paths and elementary theme. One can
2924 * change the lookup order with elm_icon_order_lookup_set().
2926 * If name is not found in any of the expected locations and it is the
2927 * absolute path of an image file, this image will be used.
2929 * @note The icon image set by this function can be changed by
2930 * elm_icon_file_set().
2932 * @see elm_icon_standard_get()
2933 * @see elm_icon_file_set()
2937 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2939 * Get the icon name set by icon standard names.
2941 * @param obj The icon object
2942 * @return The icon name
2944 * If the icon image was set using elm_icon_file_set() instead of
2945 * elm_icon_standard_set(), then this function will return @c NULL.
2947 * @see elm_icon_standard_set()
2951 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2953 * Set the smooth effect for an icon object.
2955 * @param obj The icon object
2956 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2957 * otherwise. Default is @c EINA_TRUE.
2959 * Set the scaling algorithm to be used when scaling the icon image. Smooth
2960 * scaling provides a better resulting image, but is slower.
2962 * The smooth scaling should be disabled when making animations that change
2963 * the icon size, since they will be faster. Animations that don't require
2964 * resizing of the icon can keep the smooth scaling enabled (even if the icon
2965 * is already scaled, since the scaled icon image will be cached).
2967 * @see elm_icon_smooth_get()
2971 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2973 * Get the smooth effect for an icon object.
2975 * @param obj The icon object
2976 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2978 * @see elm_icon_smooth_set()
2982 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2984 * Disable scaling of this object.
2986 * @param obj The icon object.
2987 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2988 * otherwise. Default is @c EINA_FALSE.
2990 * This function disables scaling of the icon object through the function
2991 * elm_object_scale_set(). However, this does not affect the object
2992 * size/resize in any way. For that effect, take a look at
2993 * elm_icon_scale_set().
2995 * @see elm_icon_no_scale_get()
2996 * @see elm_icon_scale_set()
2997 * @see elm_object_scale_set()
3001 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3003 * Get whether scaling is disabled on the object.
3005 * @param obj The icon object
3006 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3008 * @see elm_icon_no_scale_set()
3012 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3014 * Set if the object is (up/down) resizeable.
3016 * @param obj The icon object
3017 * @param scale_up A bool to set if the object is resizeable up. Default is
3019 * @param scale_down A bool to set if the object is resizeable down. Default
3022 * This function limits the icon object resize ability. If @p scale_up is set to
3023 * @c EINA_FALSE, the object can't have its height or width resized to a value
3024 * higher than the original icon size. Same is valid for @p scale_down.
3026 * @see elm_icon_scale_get()
3030 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3032 * Get if the object is (up/down) resizeable.
3034 * @param obj The icon object
3035 * @param scale_up A bool to set if the object is resizeable up
3036 * @param scale_down A bool to set if the object is resizeable down
3038 * @see elm_icon_scale_set()
3042 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3044 * Get the object's image size
3046 * @param obj The icon object
3047 * @param w A pointer to store the width in
3048 * @param h A pointer to store the height in
3052 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3054 * Set if the icon fill the entire object area.
3056 * @param obj The icon object
3057 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3058 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3060 * When the icon object is resized to a different aspect ratio from the
3061 * original icon image, the icon image will still keep its aspect. This flag
3062 * tells how the image should fill the object's area. They are: keep the
3063 * entire icon inside the limits of height and width of the object (@p
3064 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
3065 * of the object, and the icon will fill the entire object (@p fill_outside
3068 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
3069 * retain property to false. Thus, the icon image will always keep its
3070 * original aspect ratio.
3072 * @see elm_icon_fill_outside_get()
3073 * @see elm_image_fill_outside_set()
3077 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3079 * Get if the object is filled outside.
3081 * @param obj The icon object
3082 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3084 * @see elm_icon_fill_outside_set()
3088 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3090 * Set the prescale size for the icon.
3092 * @param obj The icon object
3093 * @param size The prescale size. This value is used for both width and
3096 * This function sets a new size for pixmap representation of the given
3097 * icon. It allows the icon to be loaded already in the specified size,
3098 * reducing the memory usage and load time when loading a big icon with load
3099 * size set to a smaller size.
3101 * It's equivalent to the elm_bg_load_size_set() function for bg.
3103 * @note this is just a hint, the real size of the pixmap may differ
3104 * depending on the type of icon being loaded, being bigger than requested.
3106 * @see elm_icon_prescale_get()
3107 * @see elm_bg_load_size_set()
3111 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3113 * Get the prescale size for the icon.
3115 * @param obj The icon object
3116 * @return The prescale size
3118 * @see elm_icon_prescale_set()
3122 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3124 * Sets the icon lookup order used by elm_icon_standard_set().
3126 * @param obj The icon object
3127 * @param order The icon lookup order (can be one of
3128 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
3129 * or ELM_ICON_LOOKUP_THEME)
3131 * @see elm_icon_order_lookup_get()
3132 * @see Elm_Icon_Lookup_Order
3136 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3138 * Gets the icon lookup order.
3140 * @param obj The icon object
3141 * @return The icon lookup order
3143 * @see elm_icon_order_lookup_set()
3144 * @see Elm_Icon_Lookup_Order
3148 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3155 * @defgroup Image Image
3157 * @image html img/widget/image/preview-00.png
3158 * @image latex img/widget/image/preview-00.eps
3160 * An object that allows one to load an image file to it. It can be used
3161 * anywhere like any other elementary widget.
3163 * This widget provides most of the functionality provided from @ref Bg or @ref
3164 * Icon, but with a slightly different API (use the one that fits better your
3167 * The features not provided by those two other image widgets are:
3168 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
3169 * @li change the object orientation with elm_image_orient_set();
3170 * @li and turning the image editable with elm_image_editable_set().
3172 * Signals that you can add callbacks for are:
3174 * @li @c "clicked" - This is called when a user has clicked the image
3176 * An example of usage for this API follows:
3177 * @li @ref tutorial_image
3186 * @enum _Elm_Image_Orient
3187 * @typedef Elm_Image_Orient
3189 * Possible orientation options for elm_image_orient_set().
3191 * @image html elm_image_orient_set.png
3192 * @image latex elm_image_orient_set.eps width=\textwidth
3196 typedef enum _Elm_Image_Orient
3198 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
3199 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
3200 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
3201 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
3202 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
3203 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
3204 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
3205 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
3209 * Add a new image to the parent.
3211 * @param parent The parent object
3212 * @return The new object or NULL if it cannot be created
3214 * @see elm_image_file_set()
3218 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3220 * Set the file that will be used as image.
3222 * @param obj The image object
3223 * @param file The path to file that will be used as image
3224 * @param group The group that the image belongs in edje file (if it's an
3227 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3229 * @see elm_image_file_get()
3233 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3235 * Get the file that will be used as image.
3237 * @param obj The image object
3238 * @param file The path to file
3239 * @param group The group that the image belongs in edje file
3241 * @see elm_image_file_set()
3245 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3247 * Set the smooth effect for an image.
3249 * @param obj The image object
3250 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3251 * otherwise. Default is @c EINA_TRUE.
3253 * Set the scaling algorithm to be used when scaling the image. Smooth
3254 * scaling provides a better resulting image, but is slower.
3256 * The smooth scaling should be disabled when making animations that change
3257 * the image size, since it will be faster. Animations that don't require
3258 * resizing of the image can keep the smooth scaling enabled (even if the
3259 * image is already scaled, since the scaled image will be cached).
3261 * @see elm_image_smooth_get()
3265 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3267 * Get the smooth effect for an image.
3269 * @param obj The image object
3270 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3272 * @see elm_image_smooth_get()
3276 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3278 * Gets the current size of the image.
3280 * @param obj The image object.
3281 * @param w Pointer to store width, or NULL.
3282 * @param h Pointer to store height, or NULL.
3284 * This is the real size of the image, not the size of the object.
3286 * On error, neither w or h will be written.
3290 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3292 * Disable scaling of this object.
3294 * @param obj The image object.
3295 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3296 * otherwise. Default is @c EINA_FALSE.
3298 * This function disables scaling of the elm_image widget through the
3299 * function elm_object_scale_set(). However, this does not affect the widget
3300 * size/resize in any way. For that effect, take a look at
3301 * elm_image_scale_set().
3303 * @see elm_image_no_scale_get()
3304 * @see elm_image_scale_set()
3305 * @see elm_object_scale_set()
3309 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3311 * Get whether scaling is disabled on the object.
3313 * @param obj The image object
3314 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3316 * @see elm_image_no_scale_set()
3320 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3322 * Set if the object is (up/down) resizeable.
3324 * @param obj The image object
3325 * @param scale_up A bool to set if the object is resizeable up. Default is
3327 * @param scale_down A bool to set if the object is resizeable down. Default
3330 * This function limits the image resize ability. If @p scale_up is set to
3331 * @c EINA_FALSE, the object can't have its height or width resized to a value
3332 * higher than the original image size. Same is valid for @p scale_down.
3334 * @see elm_image_scale_get()
3338 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3340 * Get if the object is (up/down) resizeable.
3342 * @param obj The image object
3343 * @param scale_up A bool to set if the object is resizeable up
3344 * @param scale_down A bool to set if the object is resizeable down
3346 * @see elm_image_scale_set()
3350 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3352 * Set if the image fill the entire object area when keeping the aspect ratio.
3354 * @param obj The image object
3355 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3356 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3358 * When the image should keep its aspect ratio even if resized to another
3359 * aspect ratio, there are two possibilities to resize it: keep the entire
3360 * image inside the limits of height and width of the object (@p fill_outside
3361 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
3362 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
3364 * @note This option will have no effect if
3365 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
3367 * @see elm_image_fill_outside_get()
3368 * @see elm_image_aspect_ratio_retained_set()
3372 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3374 * Get if the object is filled outside
3376 * @param obj The image object
3377 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3379 * @see elm_image_fill_outside_set()
3383 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3385 * Set the prescale size for the image
3387 * @param obj The image object
3388 * @param size The prescale size. This value is used for both width and
3391 * This function sets a new size for pixmap representation of the given
3392 * image. It allows the image to be loaded already in the specified size,
3393 * reducing the memory usage and load time when loading a big image with load
3394 * size set to a smaller size.
3396 * It's equivalent to the elm_bg_load_size_set() function for bg.
3398 * @note this is just a hint, the real size of the pixmap may differ
3399 * depending on the type of image being loaded, being bigger than requested.
3401 * @see elm_image_prescale_get()
3402 * @see elm_bg_load_size_set()
3406 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3408 * Get the prescale size for the image
3410 * @param obj The image object
3411 * @return The prescale size
3413 * @see elm_image_prescale_set()
3417 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3419 * Set the image orientation.
3421 * @param obj The image object
3422 * @param orient The image orientation
3423 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3424 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3425 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3426 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
3427 * Default is #ELM_IMAGE_ORIENT_NONE.
3429 * This function allows to rotate or flip the given image.
3431 * @see elm_image_orient_get()
3432 * @see @ref Elm_Image_Orient
3436 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
3438 * Get the image orientation.
3440 * @param obj The image object
3441 * @return The image orientation
3442 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3443 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3444 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3445 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
3447 * @see elm_image_orient_set()
3448 * @see @ref Elm_Image_Orient
3452 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3454 * Make the image 'editable'.
3456 * @param obj Image object.
3457 * @param set Turn on or off editability. Default is @c EINA_FALSE.
3459 * This means the image is a valid drag target for drag and drop, and can be
3460 * cut or pasted too.
3464 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3466 * Make the image 'editable'.
3468 * @param obj Image object.
3469 * @return Editability.
3471 * This means the image is a valid drag target for drag and drop, and can be
3472 * cut or pasted too.
3476 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3478 * Get the basic Evas_Image object from this object (widget).
3480 * @param obj The image object to get the inlined image from
3481 * @return The inlined image object, or NULL if none exists
3483 * This function allows one to get the underlying @c Evas_Object of type
3484 * Image from this elementary widget. It can be useful to do things like get
3485 * the pixel data, save the image to a file, etc.
3487 * @note Be careful to not manipulate it, as it is under control of
3492 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3494 * Set whether the original aspect ratio of the image should be kept on resize.
3496 * @param obj The image object.
3497 * @param retained @c EINA_TRUE if the image should retain the aspect,
3498 * @c EINA_FALSE otherwise.
3500 * The original aspect ratio (width / height) of the image is usually
3501 * distorted to match the object's size. Enabling this option will retain
3502 * this original aspect, and the way that the image is fit into the object's
3503 * area depends on the option set by elm_image_fill_outside_set().
3505 * @see elm_image_aspect_ratio_retained_get()
3506 * @see elm_image_fill_outside_set()
3510 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
3512 * Get if the object retains the original aspect ratio.
3514 * @param obj The image object.
3515 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
3520 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3522 /* smart callbacks called:
3523 * "clicked" - the user clicked the image
3531 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
3533 typedef enum _Elm_GLView_Mode
3535 ELM_GLVIEW_ALPHA = 1,
3536 ELM_GLVIEW_DEPTH = 2,
3537 ELM_GLVIEW_STENCIL = 4
3541 * Defines a policy for the glview resizing.
3543 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
3545 typedef enum _Elm_GLView_Resize_Policy
3547 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
3548 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
3549 } Elm_GLView_Resize_Policy;
3551 typedef enum _Elm_GLView_Render_Policy
3553 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
3554 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
3555 } Elm_GLView_Render_Policy;
3558 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3559 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3560 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3561 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3562 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
3563 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
3564 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
3565 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3566 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3567 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3568 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3569 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3575 * @image html img/widget/box/preview-00.png
3576 * @image latex img/widget/box/preview-00.eps width=\textwidth
3578 * @image html img/box.png
3579 * @image latex img/box.eps width=\textwidth
3581 * A box arranges objects in a linear fashion, governed by a layout function
3582 * that defines the details of this arrangement.
3584 * By default, the box will use an internal function to set the layout to
3585 * a single row, either vertical or horizontal. This layout is affected
3586 * by a number of parameters, such as the homogeneous flag set by
3587 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
3588 * elm_box_align_set() and the hints set to each object in the box.
3590 * For this default layout, it's possible to change the orientation with
3591 * elm_box_horizontal_set(). The box will start in the vertical orientation,
3592 * placing its elements ordered from top to bottom. When horizontal is set,
3593 * the order will go from left to right. If the box is set to be
3594 * homogeneous, every object in it will be assigned the same space, that
3595 * of the largest object. Padding can be used to set some spacing between
3596 * the cell given to each object. The alignment of the box, set with
3597 * elm_box_align_set(), determines how the bounding box of all the elements
3598 * will be placed within the space given to the box widget itself.
3600 * The size hints of each object also affect how they are placed and sized
3601 * within the box. evas_object_size_hint_min_set() will give the minimum
3602 * size the object can have, and the box will use it as the basis for all
3603 * latter calculations. Elementary widgets set their own minimum size as
3604 * needed, so there's rarely any need to use it manually.
3606 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
3607 * used to tell whether the object will be allocated the minimum size it
3608 * needs or if the space given to it should be expanded. It's important
3609 * to realize that expanding the size given to the object is not the same
3610 * thing as resizing the object. It could very well end being a small
3611 * widget floating in a much larger empty space. If not set, the weight
3612 * for objects will normally be 0.0 for both axis, meaning the widget will
3613 * not be expanded. To take as much space possible, set the weight to
3614 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
3616 * Besides how much space each object is allocated, it's possible to control
3617 * how the widget will be placed within that space using
3618 * evas_object_size_hint_align_set(). By default, this value will be 0.5
3619 * for both axis, meaning the object will be centered, but any value from
3620 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
3621 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
3622 * is -1.0, means the object will be resized to fill the entire space it
3625 * In addition, customized functions to define the layout can be set, which
3626 * allow the application developer to organize the objects within the box
3627 * in any number of ways.
3629 * The special elm_box_layout_transition() function can be used
3630 * to switch from one layout to another, animating the motion of the
3631 * children of the box.
3633 * @note Objects should not be added to box objects using _add() calls.
3635 * Some examples on how to use boxes follow:
3636 * @li @ref box_example_01
3637 * @li @ref box_example_02
3642 * @typedef Elm_Box_Transition
3644 * Opaque handler containing the parameters to perform an animated
3645 * transition of the layout the box uses.
3647 * @see elm_box_transition_new()
3648 * @see elm_box_layout_set()
3649 * @see elm_box_layout_transition()
3651 typedef struct _Elm_Box_Transition Elm_Box_Transition;
3654 * Add a new box to the parent
3656 * By default, the box will be in vertical mode and non-homogeneous.
3658 * @param parent The parent object
3659 * @return The new object or NULL if it cannot be created
3661 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3663 * Set the horizontal orientation
3665 * By default, box object arranges their contents vertically from top to
3667 * By calling this function with @p horizontal as EINA_TRUE, the box will
3668 * become horizontal, arranging contents from left to right.
3670 * @note This flag is ignored if a custom layout function is set.
3672 * @param obj The box object
3673 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
3674 * EINA_FALSE = vertical)
3676 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3678 * Get the horizontal orientation
3680 * @param obj The box object
3681 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
3683 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3685 * Set the box to arrange its children homogeneously
3687 * If enabled, homogeneous layout makes all items the same size, according
3688 * to the size of the largest of its children.
3690 * @note This flag is ignored if a custom layout function is set.
3692 * @param obj The box object
3693 * @param homogeneous The homogeneous flag
3695 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3697 * Get whether the box is using homogeneous mode or not
3699 * @param obj The box object
3700 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
3702 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3703 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3704 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3706 * Add an object to the beginning of the pack list
3708 * Pack @p subobj into the box @p obj, placing it first in the list of
3709 * children objects. The actual position the object will get on screen
3710 * depends on the layout used. If no custom layout is set, it will be at
3711 * the top or left, depending if the box is vertical or horizontal,
3714 * @param obj The box object
3715 * @param subobj The object to add to the box
3717 * @see elm_box_pack_end()
3718 * @see elm_box_pack_before()
3719 * @see elm_box_pack_after()
3720 * @see elm_box_unpack()
3721 * @see elm_box_unpack_all()
3722 * @see elm_box_clear()
3724 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3726 * Add an object at the end of the pack list
3728 * Pack @p subobj into the box @p obj, placing it last in the list of
3729 * children objects. The actual position the object will get on screen
3730 * depends on the layout used. If no custom layout is set, it will be at
3731 * the bottom or right, depending if the box is vertical or horizontal,
3734 * @param obj The box object
3735 * @param subobj The object to add to the box
3737 * @see elm_box_pack_start()
3738 * @see elm_box_pack_before()
3739 * @see elm_box_pack_after()
3740 * @see elm_box_unpack()
3741 * @see elm_box_unpack_all()
3742 * @see elm_box_clear()
3744 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3746 * Adds an object to the box before the indicated object
3748 * This will add the @p subobj to the box indicated before the object
3749 * indicated with @p before. If @p before is not already in the box, results
3750 * are undefined. Before means either to the left of the indicated object or
3751 * above it depending on orientation.
3753 * @param obj The box object
3754 * @param subobj The object to add to the box
3755 * @param before The object before which to add it
3757 * @see elm_box_pack_start()
3758 * @see elm_box_pack_end()
3759 * @see elm_box_pack_after()
3760 * @see elm_box_unpack()
3761 * @see elm_box_unpack_all()
3762 * @see elm_box_clear()
3764 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
3766 * Adds an object to the box after the indicated object
3768 * This will add the @p subobj to the box indicated after the object
3769 * indicated with @p after. If @p after is not already in the box, results
3770 * are undefined. After means either to the right of the indicated object or
3771 * below it depending on orientation.
3773 * @param obj The box object
3774 * @param subobj The object to add to the box
3775 * @param after The object after which to add it
3777 * @see elm_box_pack_start()
3778 * @see elm_box_pack_end()
3779 * @see elm_box_pack_before()
3780 * @see elm_box_unpack()
3781 * @see elm_box_unpack_all()
3782 * @see elm_box_clear()
3784 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
3786 * Clear the box of all children
3788 * Remove all the elements contained by the box, deleting the respective
3791 * @param obj The box object
3793 * @see elm_box_unpack()
3794 * @see elm_box_unpack_all()
3796 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3800 * Remove the object given by @p subobj from the box @p obj without
3803 * @param obj The box object
3805 * @see elm_box_unpack_all()
3806 * @see elm_box_clear()
3808 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3810 * Remove all items from the box, without deleting them
3812 * Clear the box from all children, but don't delete the respective objects.
3813 * If no other references of the box children exist, the objects will never
3814 * be deleted, and thus the application will leak the memory. Make sure
3815 * when using this function that you hold a reference to all the objects
3816 * in the box @p obj.
3818 * @param obj The box object
3820 * @see elm_box_clear()
3821 * @see elm_box_unpack()
3823 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3825 * Retrieve a list of the objects packed into the box
3827 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
3828 * The order of the list corresponds to the packing order the box uses.
3830 * You must free this list with eina_list_free() once you are done with it.
3832 * @param obj The box object
3834 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3836 * Set the space (padding) between the box's elements.
3838 * Extra space in pixels that will be added between a box child and its
3839 * neighbors after its containing cell has been calculated. This padding
3840 * is set for all elements in the box, besides any possible padding that
3841 * individual elements may have through their size hints.
3843 * @param obj The box object
3844 * @param horizontal The horizontal space between elements
3845 * @param vertical The vertical space between elements
3847 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3849 * Get the space (padding) between the box's elements.
3851 * @param obj The box object
3852 * @param horizontal The horizontal space between elements
3853 * @param vertical The vertical space between elements
3855 * @see elm_box_padding_set()
3857 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3859 * Set the alignment of the whole bouding box of contents.
3861 * Sets how the bounding box containing all the elements of the box, after
3862 * their sizes and position has been calculated, will be aligned within
3863 * the space given for the whole box widget.
3865 * @param obj The box object
3866 * @param horizontal The horizontal alignment of elements
3867 * @param vertical The vertical alignment of elements
3869 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
3871 * Get the alignment of the whole bouding box of contents.
3873 * @param obj The box object
3874 * @param horizontal The horizontal alignment of elements
3875 * @param vertical The vertical alignment of elements
3877 * @see elm_box_align_set()
3879 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
3882 * Set the layout defining function to be used by the box
3884 * Whenever anything changes that requires the box in @p obj to recalculate
3885 * the size and position of its elements, the function @p cb will be called
3886 * to determine what the layout of the children will be.
3888 * Once a custom function is set, everything about the children layout
3889 * is defined by it. The flags set by elm_box_horizontal_set() and
3890 * elm_box_homogeneous_set() no longer have any meaning, and the values
3891 * given by elm_box_padding_set() and elm_box_align_set() are up to this
3892 * layout function to decide if they are used and how. These last two
3893 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
3894 * passed to @p cb. The @c Evas_Object the function receives is not the
3895 * Elementary widget, but the internal Evas Box it uses, so none of the
3896 * functions described here can be used on it.
3898 * Any of the layout functions in @c Evas can be used here, as well as the
3899 * special elm_box_layout_transition().
3901 * The final @p data argument received by @p cb is the same @p data passed
3902 * here, and the @p free_data function will be called to free it
3903 * whenever the box is destroyed or another layout function is set.
3905 * Setting @p cb to NULL will revert back to the default layout function.
3907 * @param obj The box object
3908 * @param cb The callback function used for layout
3909 * @param data Data that will be passed to layout function
3910 * @param free_data Function called to free @p data
3912 * @see elm_box_layout_transition()
3914 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);
3916 * Special layout function that animates the transition from one layout to another
3918 * Normally, when switching the layout function for a box, this will be
3919 * reflected immediately on screen on the next render, but it's also
3920 * possible to do this through an animated transition.
3922 * This is done by creating an ::Elm_Box_Transition and setting the box
3923 * layout to this function.
3927 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
3928 * evas_object_box_layout_vertical, // start
3929 * NULL, // data for initial layout
3930 * NULL, // free function for initial data
3931 * evas_object_box_layout_horizontal, // end
3932 * NULL, // data for final layout
3933 * NULL, // free function for final data
3934 * anim_end, // will be called when animation ends
3935 * NULL); // data for anim_end function\
3936 * elm_box_layout_set(box, elm_box_layout_transition, t,
3937 * elm_box_transition_free);
3940 * @note This function can only be used with elm_box_layout_set(). Calling
3941 * it directly will not have the expected results.
3943 * @see elm_box_transition_new
3944 * @see elm_box_transition_free
3945 * @see elm_box_layout_set
3947 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
3949 * Create a new ::Elm_Box_Transition to animate the switch of layouts
3951 * If you want to animate the change from one layout to another, you need
3952 * to set the layout function of the box to elm_box_layout_transition(),
3953 * passing as user data to it an instance of ::Elm_Box_Transition with the
3954 * necessary information to perform this animation. The free function to
3955 * set for the layout is elm_box_transition_free().
3957 * The parameters to create an ::Elm_Box_Transition sum up to how long
3958 * will it be, in seconds, a layout function to describe the initial point,
3959 * another for the final position of the children and one function to be
3960 * called when the whole animation ends. This last function is useful to
3961 * set the definitive layout for the box, usually the same as the end
3962 * layout for the animation, but could be used to start another transition.
3964 * @param start_layout The layout function that will be used to start the animation
3965 * @param start_layout_data The data to be passed the @p start_layout function
3966 * @param start_layout_free_data Function to free @p start_layout_data
3967 * @param end_layout The layout function that will be used to end the animation
3968 * @param end_layout_free_data The data to be passed the @p end_layout function
3969 * @param end_layout_free_data Function to free @p end_layout_data
3970 * @param transition_end_cb Callback function called when animation ends
3971 * @param transition_end_data Data to be passed to @p transition_end_cb
3972 * @return An instance of ::Elm_Box_Transition
3974 * @see elm_box_transition_new
3975 * @see elm_box_layout_transition
3977 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);
3979 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3981 * This function is mostly useful as the @c free_data parameter in
3982 * elm_box_layout_set() when elm_box_layout_transition().
3984 * @param data The Elm_Box_Transition instance to be freed.
3986 * @see elm_box_transition_new
3987 * @see elm_box_layout_transition
3989 EAPI void elm_box_transition_free(void *data);
3996 * @defgroup Button Button
3998 * @image html img/widget/button/preview-00.png
3999 * @image html img/widget/button/preview-01.png
4000 * @image html img/widget/button/preview-02.png
4002 * This is a push-button. Press it and run some function. It can contain
4003 * a simple label and icon object and it also has an autorepeat feature.
4005 * This widgets emits the following signals:
4006 * @li "clicked": the user clicked the button (press/release).
4007 * @li "repeated": the user pressed the button without releasing it.
4008 * @li "pressed": button was pressed.
4009 * @li "unpressed": button was released after being pressed.
4010 * In all three cases, the @c event parameter of the callback will be
4013 * Also, defined in the default theme, the button has the following styles
4015 * @li default: a normal button.
4016 * @li anchor: Like default, but the button fades away when the mouse is not
4017 * over it, leaving only the text or icon.
4018 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4019 * continuous look across its options.
4020 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4022 * Follow through a complete example @ref button_example_01 "here".
4026 * Add a new button to the parent's canvas
4028 * @param parent The parent object
4029 * @return The new object or NULL if it cannot be created
4031 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4033 * Set the label used in the button
4035 * The passed @p label can be NULL to clean any existing text in it and
4036 * leave the button as an icon only object.
4038 * @param obj The button object
4039 * @param label The text will be written on the button
4040 * @deprecated use elm_object_text_set() instead.
4042 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4044 * Get the label set for the button
4046 * The string returned is an internal pointer and should not be freed or
4047 * altered. It will also become invalid when the button is destroyed.
4048 * The string returned, if not NULL, is a stringshare, so if you need to
4049 * keep it around even after the button is destroyed, you can use
4050 * eina_stringshare_ref().
4052 * @param obj The button object
4053 * @return The text set to the label, or NULL if nothing is set
4054 * @deprecated use elm_object_text_set() instead.
4056 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4058 * Set the icon used for the button
4060 * Setting a new icon will delete any other that was previously set, making
4061 * any reference to them invalid. If you need to maintain the previous
4062 * object alive, unset it first with elm_button_icon_unset().
4064 * @param obj The button object
4065 * @param icon The icon object for the button
4067 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4069 * Get the icon used for the button
4071 * Return the icon object which is set for this widget. If the button is
4072 * destroyed or another icon is set, the returned object will be deleted
4073 * and any reference to it will be invalid.
4075 * @param obj The button object
4076 * @return The icon object that is being used
4078 * @see elm_button_icon_unset()
4080 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4082 * Remove the icon set without deleting it and return the object
4084 * This function drops the reference the button holds of the icon object
4085 * and returns this last object. It is used in case you want to remove any
4086 * icon, or set another one, without deleting the actual object. The button
4087 * will be left without an icon set.
4089 * @param obj The button object
4090 * @return The icon object that was being used
4092 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4094 * Turn on/off the autorepeat event generated when the button is kept pressed
4096 * When off, no autorepeat is performed and buttons emit a normal @c clicked
4097 * signal when they are clicked.
4099 * When on, keeping a button pressed will continuously emit a @c repeated
4100 * signal until the button is released. The time it takes until it starts
4101 * emitting the signal is given by
4102 * elm_button_autorepeat_initial_timeout_set(), and the time between each
4103 * new emission by elm_button_autorepeat_gap_timeout_set().
4105 * @param obj The button object
4106 * @param on A bool to turn on/off the event
4108 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4110 * Get whether the autorepeat feature is enabled
4112 * @param obj The button object
4113 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4115 * @see elm_button_autorepeat_set()
4117 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4119 * Set the initial timeout before the autorepeat event is generated
4121 * Sets the timeout, in seconds, since the button is pressed until the
4122 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4123 * won't be any delay and the even will be fired the moment the button is
4126 * @param obj The button object
4127 * @param t Timeout in seconds
4129 * @see elm_button_autorepeat_set()
4130 * @see elm_button_autorepeat_gap_timeout_set()
4132 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4134 * Get the initial timeout before the autorepeat event is generated
4136 * @param obj The button object
4137 * @return Timeout in seconds
4139 * @see elm_button_autorepeat_initial_timeout_set()
4141 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4143 * Set the interval between each generated autorepeat event
4145 * After the first @c repeated event is fired, all subsequent ones will
4146 * follow after a delay of @p t seconds for each.
4148 * @param obj The button object
4149 * @param t Interval in seconds
4151 * @see elm_button_autorepeat_initial_timeout_set()
4153 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4155 * Get the interval between each generated autorepeat event
4157 * @param obj The button object
4158 * @return Interval in seconds
4160 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4166 * @defgroup File_Selector_Button File Selector Button
4168 * @image html img/widget/fileselector_button/preview-00.png
4169 * @image html img/widget/fileselector_button/preview-01.png
4170 * @image html img/widget/fileselector_button/preview-02.png
4172 * This is a button that, when clicked, creates an Elementary
4173 * window (or inner window) <b> with a @ref Fileselector "file
4174 * selector widget" within</b>. When a file is chosen, the (inner)
4175 * window is closed and the button emits a signal having the
4176 * selected file as it's @c event_info.
4178 * This widget encapsulates operations on its internal file
4179 * selector on its own API. There is less control over its file
4180 * selector than that one would have instatiating one directly.
4182 * The following styles are available for this button:
4185 * @li @c "hoversel_vertical"
4186 * @li @c "hoversel_vertical_entry"
4188 * Smart callbacks one can register to:
4189 * - @c "file,chosen" - the user has selected a path, whose string
4190 * pointer comes as the @c event_info data (a stringshared
4193 * Here is an example on its usage:
4194 * @li @ref fileselector_button_example
4196 * @see @ref File_Selector_Entry for a similar widget.
4201 * Add a new file selector button widget to the given parent
4202 * Elementary (container) object
4204 * @param parent The parent object
4205 * @return a new file selector button widget handle or @c NULL, on
4208 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4211 * Set the label for a given file selector button widget
4213 * @param obj The file selector button widget
4214 * @param label The text label to be displayed on @p obj
4216 * @deprecated use elm_object_text_set() instead.
4218 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4221 * Get the label set for a given file selector button widget
4223 * @param obj The file selector button widget
4224 * @return The button label
4226 * @deprecated use elm_object_text_set() instead.
4228 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4231 * Set the icon on a given file selector button widget
4233 * @param obj The file selector button widget
4234 * @param icon The icon object for the button
4236 * Once the icon object is set, a previously set one will be
4237 * deleted. If you want to keep the latter, use the
4238 * elm_fileselector_button_icon_unset() function.
4240 * @see elm_fileselector_button_icon_get()
4242 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4245 * Get the icon set for a given file selector button widget
4247 * @param obj The file selector button widget
4248 * @return The icon object currently set on @p obj or @c NULL, if
4251 * @see elm_fileselector_button_icon_set()
4253 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4256 * Unset the icon used in a given file selector button widget
4258 * @param obj The file selector button widget
4259 * @return The icon object that was being used on @p obj or @c
4262 * Unparent and return the icon object which was set for this
4265 * @see elm_fileselector_button_icon_set()
4267 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4270 * Set the title for a given file selector button widget's window
4272 * @param obj The file selector button widget
4273 * @param title The title string
4275 * This will change the window's title, when the file selector pops
4276 * out after a click on the button. Those windows have the default
4277 * (unlocalized) value of @c "Select a file" as titles.
4279 * @note It will only take any effect if the file selector
4280 * button widget is @b not under "inwin mode".
4282 * @see elm_fileselector_button_window_title_get()
4284 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4287 * Get the title set for a given file selector button widget's
4290 * @param obj The file selector button widget
4291 * @return Title of the file selector button's window
4293 * @see elm_fileselector_button_window_title_get() for more details
4295 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4298 * Set the size of a given file selector button widget's window,
4299 * holding the file selector itself.
4301 * @param obj The file selector button widget
4302 * @param width The window's width
4303 * @param height The window's height
4305 * @note it will only take any effect if the file selector button
4306 * widget is @b not under "inwin mode". The default size for the
4307 * window (when applicable) is 400x400 pixels.
4309 * @see elm_fileselector_button_window_size_get()
4311 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4314 * Get the size of a given file selector button widget's window,
4315 * holding the file selector itself.
4317 * @param obj The file selector button widget
4318 * @param width Pointer into which to store the width value
4319 * @param height Pointer into which to store the height value
4321 * @note Use @c NULL pointers on the size values you're not
4322 * interested in: they'll be ignored by the function.
4324 * @see elm_fileselector_button_window_size_set(), for more details
4326 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4329 * Set the initial file system path for a given file selector
4332 * @param obj The file selector button widget
4333 * @param path The path string
4335 * It must be a <b>directory</b> path, which will have the contents
4336 * displayed initially in the file selector's view, when invoked
4337 * from @p obj. The default initial path is the @c "HOME"
4338 * environment variable's value.
4340 * @see elm_fileselector_button_path_get()
4342 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4345 * Get the initial file system path set for a given file selector
4348 * @param obj The file selector button widget
4349 * @return path The path string
4351 * @see elm_fileselector_button_path_set() for more details
4353 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4356 * Enable/disable a tree view in the given file selector button
4357 * widget's internal file selector
4359 * @param obj The file selector button widget
4360 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4363 * This has the same effect as elm_fileselector_expandable_set(),
4364 * but now applied to a file selector button's internal file
4367 * @note There's no way to put a file selector button's internal
4368 * file selector in "grid mode", as one may do with "pure" file
4371 * @see elm_fileselector_expandable_get()
4373 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4376 * Get whether tree view is enabled for the given file selector
4377 * button widget's internal file selector
4379 * @param obj The file selector button widget
4380 * @return @c EINA_TRUE if @p obj widget's internal file selector
4381 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4383 * @see elm_fileselector_expandable_set() for more details
4385 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4388 * Set whether a given file selector button widget's internal file
4389 * selector is to display folders only or the directory contents,
4392 * @param obj The file selector button widget
4393 * @param only @c EINA_TRUE to make @p obj widget's internal file
4394 * selector only display directories, @c EINA_FALSE to make files
4395 * to be displayed in it too
4397 * This has the same effect as elm_fileselector_folder_only_set(),
4398 * but now applied to a file selector button's internal file
4401 * @see elm_fileselector_folder_only_get()
4403 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4406 * Get whether a given file selector button widget's internal file
4407 * selector is displaying folders only or the directory contents,
4410 * @param obj The file selector button widget
4411 * @return @c EINA_TRUE if @p obj widget's internal file
4412 * selector is only displaying directories, @c EINA_FALSE if files
4413 * are being displayed in it too (and on errors)
4415 * @see elm_fileselector_button_folder_only_set() for more details
4417 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4420 * Enable/disable the file name entry box where the user can type
4421 * in a name for a file, in a given file selector button widget's
4422 * internal file selector.
4424 * @param obj The file selector button widget
4425 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4426 * file selector a "saving dialog", @c EINA_FALSE otherwise
4428 * This has the same effect as elm_fileselector_is_save_set(),
4429 * but now applied to a file selector button's internal file
4432 * @see elm_fileselector_is_save_get()
4434 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4437 * Get whether the given file selector button widget's internal
4438 * file selector is in "saving dialog" mode
4440 * @param obj The file selector button widget
4441 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4442 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4445 * @see elm_fileselector_button_is_save_set() for more details
4447 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4450 * Set whether a given file selector button widget's internal file
4451 * selector will raise an Elementary "inner window", instead of a
4452 * dedicated Elementary window. By default, it won't.
4454 * @param obj The file selector button widget
4455 * @param value @c EINA_TRUE to make it use an inner window, @c
4456 * EINA_TRUE to make it use a dedicated window
4458 * @see elm_win_inwin_add() for more information on inner windows
4459 * @see elm_fileselector_button_inwin_mode_get()
4461 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4464 * Get whether a given file selector button widget's internal file
4465 * selector will raise an Elementary "inner window", instead of a
4466 * dedicated Elementary window.
4468 * @param obj The file selector button widget
4469 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4470 * if it will use a dedicated window
4472 * @see elm_fileselector_button_inwin_mode_set() for more details
4474 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4481 * @defgroup File_Selector_Entry File Selector Entry
4483 * @image html img/widget/fileselector_entry/preview-00.png
4484 * @image latex img/widget/fileselector_entry/preview-00.eps
4486 * This is an entry made to be filled with or display a <b>file
4487 * system path string</b>. Besides the entry itself, the widget has
4488 * a @ref File_Selector_Button "file selector button" on its side,
4489 * which will raise an internal @ref Fileselector "file selector widget",
4490 * when clicked, for path selection aided by file system
4493 * This file selector may appear in an Elementary window or in an
4494 * inner window. When a file is chosen from it, the (inner) window
4495 * is closed and the selected file's path string is exposed both as
4496 * an smart event and as the new text on the entry.
4498 * This widget encapsulates operations on its internal file
4499 * selector on its own API. There is less control over its file
4500 * selector than that one would have instatiating one directly.
4502 * Smart callbacks one can register to:
4503 * - @c "changed" - The text within the entry was changed
4504 * - @c "activated" - The entry has had editing finished and
4505 * changes are to be "committed"
4506 * - @c "press" - The entry has been clicked
4507 * - @c "longpressed" - The entry has been clicked (and held) for a
4509 * - @c "clicked" - The entry has been clicked
4510 * - @c "clicked,double" - The entry has been double clicked
4511 * - @c "focused" - The entry has received focus
4512 * - @c "unfocused" - The entry has lost focus
4513 * - @c "selection,paste" - A paste action has occurred on the
4515 * - @c "selection,copy" - A copy action has occurred on the entry
4516 * - @c "selection,cut" - A cut action has occurred on the entry
4517 * - @c "unpressed" - The file selector entry's button was released
4518 * after being pressed.
4519 * - @c "file,chosen" - The user has selected a path via the file
4520 * selector entry's internal file selector, whose string pointer
4521 * comes as the @c event_info data (a stringshared string)
4523 * Here is an example on its usage:
4524 * @li @ref fileselector_entry_example
4526 * @see @ref File_Selector_Button for a similar widget.
4531 * Add a new file selector entry widget to the given parent
4532 * Elementary (container) object
4534 * @param parent The parent object
4535 * @return a new file selector entry widget handle or @c NULL, on
4538 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4541 * Set the label for a given file selector entry widget's button
4543 * @param obj The file selector entry widget
4544 * @param label The text label to be displayed on @p obj widget's
4547 * @deprecated use elm_object_text_set() instead.
4549 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4552 * Get the label set for a given file selector entry widget's button
4554 * @param obj The file selector entry widget
4555 * @return The widget button's label
4557 * @deprecated use elm_object_text_set() instead.
4559 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4562 * Set the icon on a given file selector entry widget's button
4564 * @param obj The file selector entry widget
4565 * @param icon The icon object for the entry's button
4567 * Once the icon object is set, a previously set one will be
4568 * deleted. If you want to keep the latter, use the
4569 * elm_fileselector_entry_button_icon_unset() function.
4571 * @see elm_fileselector_entry_button_icon_get()
4573 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4576 * Get the icon set for a given file selector entry widget's button
4578 * @param obj The file selector entry widget
4579 * @return The icon object currently set on @p obj widget's button
4580 * or @c NULL, if none is
4582 * @see elm_fileselector_entry_button_icon_set()
4584 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4587 * Unset the icon used in a given file selector entry widget's
4590 * @param obj The file selector entry widget
4591 * @return The icon object that was being used on @p obj widget's
4592 * button or @c NULL, on errors
4594 * Unparent and return the icon object which was set for this
4597 * @see elm_fileselector_entry_button_icon_set()
4599 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4602 * Set the title for a given file selector entry widget's window
4604 * @param obj The file selector entry widget
4605 * @param title The title string
4607 * This will change the window's title, when the file selector pops
4608 * out after a click on the entry's button. Those windows have the
4609 * default (unlocalized) value of @c "Select a file" as titles.
4611 * @note It will only take any effect if the file selector
4612 * entry widget is @b not under "inwin mode".
4614 * @see elm_fileselector_entry_window_title_get()
4616 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4619 * Get the title set for a given file selector entry widget's
4622 * @param obj The file selector entry widget
4623 * @return Title of the file selector entry's window
4625 * @see elm_fileselector_entry_window_title_get() for more details
4627 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4630 * Set the size of a given file selector entry widget's window,
4631 * holding the file selector itself.
4633 * @param obj The file selector entry widget
4634 * @param width The window's width
4635 * @param height The window's height
4637 * @note it will only take any effect if the file selector entry
4638 * widget is @b not under "inwin mode". The default size for the
4639 * window (when applicable) is 400x400 pixels.
4641 * @see elm_fileselector_entry_window_size_get()
4643 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4646 * Get the size of a given file selector entry widget's window,
4647 * holding the file selector itself.
4649 * @param obj The file selector entry widget
4650 * @param width Pointer into which to store the width value
4651 * @param height Pointer into which to store the height value
4653 * @note Use @c NULL pointers on the size values you're not
4654 * interested in: they'll be ignored by the function.
4656 * @see elm_fileselector_entry_window_size_set(), for more details
4658 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4661 * Set the initial file system path and the entry's path string for
4662 * a given file selector entry widget
4664 * @param obj The file selector entry widget
4665 * @param path The path string
4667 * It must be a <b>directory</b> path, which will have the contents
4668 * displayed initially in the file selector's view, when invoked
4669 * from @p obj. The default initial path is the @c "HOME"
4670 * environment variable's value.
4672 * @see elm_fileselector_entry_path_get()
4674 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4677 * Get the entry's path string for a given file selector entry
4680 * @param obj The file selector entry widget
4681 * @return path The path string
4683 * @see elm_fileselector_entry_path_set() for more details
4685 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4688 * Enable/disable a tree view in the given file selector entry
4689 * widget's internal file selector
4691 * @param obj The file selector entry widget
4692 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4695 * This has the same effect as elm_fileselector_expandable_set(),
4696 * but now applied to a file selector entry's internal file
4699 * @note There's no way to put a file selector entry's internal
4700 * file selector in "grid mode", as one may do with "pure" file
4703 * @see elm_fileselector_expandable_get()
4705 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4708 * Get whether tree view is enabled for the given file selector
4709 * entry widget's internal file selector
4711 * @param obj The file selector entry widget
4712 * @return @c EINA_TRUE if @p obj widget's internal file selector
4713 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4715 * @see elm_fileselector_expandable_set() for more details
4717 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4720 * Set whether a given file selector entry widget's internal file
4721 * selector is to display folders only or the directory contents,
4724 * @param obj The file selector entry widget
4725 * @param only @c EINA_TRUE to make @p obj widget's internal file
4726 * selector only display directories, @c EINA_FALSE to make files
4727 * to be displayed in it too
4729 * This has the same effect as elm_fileselector_folder_only_set(),
4730 * but now applied to a file selector entry's internal file
4733 * @see elm_fileselector_folder_only_get()
4735 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4738 * Get whether a given file selector entry widget's internal file
4739 * selector is displaying folders only or the directory contents,
4742 * @param obj The file selector entry widget
4743 * @return @c EINA_TRUE if @p obj widget's internal file
4744 * selector is only displaying directories, @c EINA_FALSE if files
4745 * are being displayed in it too (and on errors)
4747 * @see elm_fileselector_entry_folder_only_set() for more details
4749 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4752 * Enable/disable the file name entry box where the user can type
4753 * in a name for a file, in a given file selector entry widget's
4754 * internal file selector.
4756 * @param obj The file selector entry widget
4757 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4758 * file selector a "saving dialog", @c EINA_FALSE otherwise
4760 * This has the same effect as elm_fileselector_is_save_set(),
4761 * but now applied to a file selector entry's internal file
4764 * @see elm_fileselector_is_save_get()
4766 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4769 * Get whether the given file selector entry widget's internal
4770 * file selector is in "saving dialog" mode
4772 * @param obj The file selector entry widget
4773 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4774 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4777 * @see elm_fileselector_entry_is_save_set() for more details
4779 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4782 * Set whether a given file selector entry widget's internal file
4783 * selector will raise an Elementary "inner window", instead of a
4784 * dedicated Elementary window. By default, it won't.
4786 * @param obj The file selector entry widget
4787 * @param value @c EINA_TRUE to make it use an inner window, @c
4788 * EINA_TRUE to make it use a dedicated window
4790 * @see elm_win_inwin_add() for more information on inner windows
4791 * @see elm_fileselector_entry_inwin_mode_get()
4793 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4796 * Get whether a given file selector entry widget's internal file
4797 * selector will raise an Elementary "inner window", instead of a
4798 * dedicated Elementary window.
4800 * @param obj The file selector entry widget
4801 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4802 * if it will use a dedicated window
4804 * @see elm_fileselector_entry_inwin_mode_set() for more details
4806 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4809 * Set the initial file system path for a given file selector entry
4812 * @param obj The file selector entry widget
4813 * @param path The path string
4815 * It must be a <b>directory</b> path, which will have the contents
4816 * displayed initially in the file selector's view, when invoked
4817 * from @p obj. The default initial path is the @c "HOME"
4818 * environment variable's value.
4820 * @see elm_fileselector_entry_path_get()
4822 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4825 * Get the parent directory's path to the latest file selection on
4826 * a given filer selector entry widget
4828 * @param obj The file selector object
4829 * @return The (full) path of the directory of the last selection
4830 * on @p obj widget, a @b stringshared string
4832 * @see elm_fileselector_entry_path_set()
4834 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4841 * @defgroup Scroller Scroller
4843 * A scroller holds a single object and "scrolls it around". This means that
4844 * it allows the user to use a scrollbar (or a finger) to drag the viewable
4845 * region around, allowing to move through a much larger object that is
4846 * contained in the scroller. The scroiller will always have a small minimum
4847 * size by default as it won't be limited by the contents of the scroller.
4849 * Signals that you can add callbacks for are:
4850 * @li "edge,left" - the left edge of the content has been reached
4851 * @li "edge,right" - the right edge of the content has been reached
4852 * @li "edge,top" - the top edge of the content has been reached
4853 * @li "edge,bottom" - the bottom edge of the content has been reached
4854 * @li "scroll" - the content has been scrolled (moved)
4855 * @li "scroll,anim,start" - scrolling animation has started
4856 * @li "scroll,anim,stop" - scrolling animation has stopped
4857 * @li "scroll,drag,start" - dragging the contents around has started
4858 * @li "scroll,drag,stop" - dragging the contents around has stopped
4859 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
4862 * @note When Elemementary is in embedded mode the scrollbars will not be
4863 * dragable, they appear merely as indicators of how much has been scrolled.
4864 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
4865 * fingerscroll) won't work.
4867 * In @ref tutorial_scroller you'll find an example of how to use most of
4872 * @brief Type that controls when scrollbars should appear.
4874 * @see elm_scroller_policy_set()
4876 typedef enum _Elm_Scroller_Policy
4878 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
4879 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
4880 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
4881 ELM_SCROLLER_POLICY_LAST
4882 } Elm_Scroller_Policy;
4884 * @brief Add a new scroller to the parent
4886 * @param parent The parent object
4887 * @return The new object or NULL if it cannot be created
4889 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4891 * @brief Set the content of the scroller widget (the object to be scrolled around).
4893 * @param obj The scroller object
4894 * @param content The new content object
4896 * Once the content object is set, a previously set one will be deleted.
4897 * If you want to keep that old content object, use the
4898 * elm_scroller_content_unset() function.
4900 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
4902 * @brief Get the content of the scroller widget
4904 * @param obj The slider object
4905 * @return The content that is being used
4907 * Return the content object which is set for this widget
4909 * @see elm_scroller_content_set()
4911 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4913 * @brief Unset the content of the scroller widget
4915 * @param obj The slider object
4916 * @return The content that was being used
4918 * Unparent and return the content object which was set for this widget
4920 * @see elm_scroller_content_set()
4922 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4924 * @brief Set custom theme elements for the scroller
4926 * @param obj The scroller object
4927 * @param widget The widget name to use (default is "scroller")
4928 * @param base The base name to use (default is "base")
4930 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
4932 * @brief Make the scroller minimum size limited to the minimum size of the content
4934 * @param obj The scroller object
4935 * @param w Enable limiting minimum size horizontally
4936 * @param h Enable limiting minimum size vertically
4938 * By default the scroller will be as small as its design allows,
4939 * irrespective of its content. This will make the scroller minimum size the
4940 * right size horizontally and/or vertically to perfectly fit its content in
4943 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
4945 * @brief Show a specific virtual region within the scroller content object
4947 * @param obj The scroller object
4948 * @param x X coordinate of the region
4949 * @param y Y coordinate of the region
4950 * @param w Width of the region
4951 * @param h Height of the region
4953 * This will ensure all (or part if it does not fit) of the designated
4954 * region in the virtual content object (0, 0 starting at the top-left of the
4955 * virtual content object) is shown within the scroller.
4957 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);
4959 * @brief Set the scrollbar visibility policy
4961 * @param obj The scroller object
4962 * @param policy_h Horizontal scrollbar policy
4963 * @param policy_v Vertical scrollbar policy
4965 * This sets the scrollbar visibility policy for the given scroller.
4966 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
4967 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
4968 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
4969 * respectively for the horizontal and vertical scrollbars.
4971 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4973 * @brief Gets scrollbar visibility policy
4975 * @param obj The scroller object
4976 * @param policy_h Horizontal scrollbar policy
4977 * @param policy_v Vertical scrollbar policy
4979 * @see elm_scroller_policy_set()
4981 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
4983 * @brief Get the currently visible content region
4985 * @param obj The scroller object
4986 * @param x X coordinate of the region
4987 * @param y Y coordinate of the region
4988 * @param w Width of the region
4989 * @param h Height of the region
4991 * This gets the current region in the content object that is visible through
4992 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
4993 * w, @p h values pointed to.
4995 * @note All coordinates are relative to the content.
4997 * @see elm_scroller_region_show()
4999 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);
5001 * @brief Get the size of the content object
5003 * @param obj The scroller object
5004 * @param w Width return
5005 * @param h Height return
5007 * This gets the size of the content object of the scroller.
5009 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5011 * @brief Set bouncing behavior
5013 * @param obj The scroller object
5014 * @param h_bounce Will the scroller bounce horizontally or not
5015 * @param v_bounce Will the scroller bounce vertically or not
5017 * When scrolling, the scroller may "bounce" when reaching an edge of the
5018 * content object. This is a visual way to indicate the end has been reached.
5019 * This is enabled by default for both axis. This will set if it is enabled
5020 * for that axis with the boolean parameters for each axis.
5022 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5024 * @brief Get the bounce mode
5026 * @param obj The Scroller object
5027 * @param h_bounce Allow bounce horizontally
5028 * @param v_bounce Allow bounce vertically
5030 * @see elm_scroller_bounce_set()
5032 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5034 * @brief Set scroll page size relative to viewport size.
5036 * @param obj The scroller object
5037 * @param h_pagerel The horizontal page relative size
5038 * @param v_pagerel The vertical page relative size
5040 * The scroller is capable of limiting scrolling by the user to "pages". That
5041 * is to jump by and only show a "whole page" at a time as if the continuous
5042 * area of the scroller content is split into page sized pieces. This sets
5043 * the size of a page relative to the viewport of the scroller. 1.0 is "1
5044 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5045 * axis. This is mutually exclusive with page size
5046 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
5047 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5048 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5051 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5053 * @brief Set scroll page size.
5055 * @param obj The scroller object
5056 * @param h_pagesize The horizontal page size
5057 * @param v_pagesize The vertical page size
5059 * This sets the page size to an absolute fixed value, with 0 turning it off
5062 * @see elm_scroller_page_relative_set()
5064 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5066 * @brief Show a specific virtual region within the scroller content object.
5068 * @param obj The scroller object
5069 * @param x X coordinate of the region
5070 * @param y Y coordinate of the region
5071 * @param w Width of the region
5072 * @param h Height of the region
5074 * This will ensure all (or part if it does not fit) of the designated
5075 * region in the virtual content object (0, 0 starting at the top-left of the
5076 * virtual content object) is shown within the scroller. Unlike
5077 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5078 * to this location (if configuration in general calls for transitions). It
5079 * may not jump immediately to the new location and make take a while and
5080 * show other content along the way.
5082 * @see elm_scroller_region_show()
5084 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);
5086 * @brief Set event propagation on a scroller
5088 * @param obj The scroller object
5089 * @param propagation If propagation is enabled or not
5091 * This enables or disabled event propagation from the scroller content to
5092 * the scroller and its parent. By default event propagation is disabled.
5094 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5096 * @brief Get event propagation for a scroller
5098 * @param obj The scroller object
5099 * @return The propagation state
5101 * This gets the event propagation for a scroller.
5103 * @see elm_scroller_propagate_events_set()
5105 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
5111 * @defgroup Label Label
5113 * @image html img/widget/label/preview-00.png
5114 * @image latex img/widget/label/preview-00.eps
5116 * @brief Widget to display text, with simple html-like markup.
5118 * The Label widget @b doesn't allow text to overflow its boundaries, if the
5119 * text doesn't fit the geometry of the label it will be ellipsized or be
5120 * cut. Elementary provides several themes for this widget:
5121 * @li default - No animation
5122 * @li marker - Centers the text in the label and make it bold by default
5123 * @li slide_long - The entire text appears from the right of the screen and
5124 * slides until it disappears in the left of the screen(reappering on the
5126 * @li slide_short - The text appears in the left of the label and slides to
5127 * the right to show the overflow. When all of the text has been shown the
5128 * position is reset.
5129 * @li slide_bounce - The text appears in the left of the label and slides to
5130 * the right to show the overflow. When all of the text has been shown the
5131 * animation reverses, moving the text to the left.
5133 * Custom themes can of course invent new markup tags and style them any way
5136 * See @ref tutorial_label for a demonstration of how to use a label widget.
5140 * @brief Add a new label to the parent
5142 * @param parent The parent object
5143 * @return The new object or NULL if it cannot be created
5145 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5147 * @brief Set the label on the label object
5149 * @param obj The label object
5150 * @param label The label will be used on the label object
5151 * @deprecated See elm_object_text_set()
5153 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 */
5155 * @brief Get the label used on the label object
5157 * @param obj The label object
5158 * @return The string inside the label
5159 * @deprecated See elm_object_text_get()
5161 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5163 * @brief Set the wrapping behavior of the label
5165 * @param obj The label object
5166 * @param wrap To wrap text or not
5168 * By default no wrapping is done. Possible values for @p wrap are:
5169 * @li ELM_WRAP_NONE - No wrapping
5170 * @li ELM_WRAP_CHAR - wrap between characters
5171 * @li ELM_WRAP_WORD - wrap between words
5172 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5174 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5176 * @brief Get the wrapping behavior of the label
5178 * @param obj The label object
5181 * @see elm_label_line_wrap_set()
5183 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5185 * @brief Set wrap width of the label
5187 * @param obj The label object
5188 * @param w The wrap width in pixels at a minimum where words need to wrap
5190 * This function sets the maximum width size hint of the label.
5192 * @warning This is only relevant if the label is inside a container.
5194 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5196 * @brief Get wrap width of the label
5198 * @param obj The label object
5199 * @return The wrap width in pixels at a minimum where words need to wrap
5201 * @see elm_label_wrap_width_set()
5203 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5205 * @brief Set wrap height of the label
5207 * @param obj The label object
5208 * @param h The wrap height in pixels at a minimum where words need to wrap
5210 * This function sets the maximum height size hint of the label.
5212 * @warning This is only relevant if the label is inside a container.
5214 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5216 * @brief get wrap width of the label
5218 * @param obj The label object
5219 * @return The wrap height in pixels at a minimum where words need to wrap
5221 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5223 * @brief Set the font size on the label object.
5225 * @param obj The label object
5226 * @param size font size
5228 * @warning NEVER use this. It is for hyper-special cases only. use styles
5229 * instead. e.g. "big", "medium", "small" - or better name them by use:
5230 * "title", "footnote", "quote" etc.
5232 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5234 * @brief Set the text color on the label object
5236 * @param obj The label object
5237 * @param r Red property background color of The label object
5238 * @param g Green property background color of The label object
5239 * @param b Blue property background color of The label object
5240 * @param a Alpha property background color of The label object
5242 * @warning NEVER use this. It is for hyper-special cases only. use styles
5243 * instead. e.g. "big", "medium", "small" - or better name them by use:
5244 * "title", "footnote", "quote" etc.
5246 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);
5248 * @brief Set the text align on the label object
5250 * @param obj The label object
5251 * @param align align mode ("left", "center", "right")
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_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5259 * @brief Set background color of the label
5261 * @param obj The label object
5262 * @param r Red property background color of The label object
5263 * @param g Green property background color of The label object
5264 * @param b Blue property background color of The label object
5265 * @param a Alpha property background alpha of The label object
5267 * @warning NEVER use this. It is for hyper-special cases only. use styles
5268 * instead. e.g. "big", "medium", "small" - or better name them by use:
5269 * "title", "footnote", "quote" etc.
5271 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);
5273 * @brief Set the ellipsis behavior of the label
5275 * @param obj The label object
5276 * @param ellipsis To ellipsis text or not
5278 * If set to true and the text doesn't fit in the label an ellipsis("...")
5279 * will be shown at the end of the widget.
5281 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5282 * choosen wrap method was ELM_WRAP_WORD.
5284 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5286 * @brief Set the text slide of the label
5288 * @param obj The label object
5289 * @param slide To start slide or stop
5291 * If set to true the text of the label will slide throught the length of
5294 * @warning This only work with the themes "slide_short", "slide_long" and
5297 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5299 * @brief Get the text slide mode of the label
5301 * @param obj The label object
5302 * @return slide slide mode value
5304 * @see elm_label_slide_set()
5306 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5308 * @brief Set the slide duration(speed) of the label
5310 * @param obj The label object
5311 * @return The duration in seconds in moving text from slide begin position
5312 * to slide end position
5314 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5316 * @brief Get the slide duration(speed) of the label
5318 * @param obj The label object
5319 * @return The duration time in moving text from slide begin position to slide end position
5321 * @see elm_label_slide_duration_set()
5323 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5329 * @defgroup Toggle Toggle
5331 * @image html img/widget/toggle/preview-00.png
5332 * @image latex img/widget/toggle/preview-00.eps
5334 * @brief A toggle is a slider which can be used to toggle between
5335 * two values. It has two states: on and off.
5337 * Signals that you can add callbacks for are:
5338 * @li "changed" - Whenever the toggle value has been changed. Is not called
5339 * until the toggle is released by the cursor (assuming it
5340 * has been triggered by the cursor in the first place).
5342 * @ref tutorial_toggle show how to use a toggle.
5346 * @brief Add a toggle to @p parent.
5348 * @param parent The parent object
5350 * @return The toggle object
5352 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5354 * @brief Sets the label to be displayed with the toggle.
5356 * @param obj The toggle object
5357 * @param label The label to be displayed
5359 * @deprecated use elm_object_text_set() instead.
5361 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5363 * @brief Gets the label of the toggle
5365 * @param obj toggle object
5366 * @return The label of the toggle
5368 * @deprecated use elm_object_text_get() instead.
5370 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5372 * @brief Set the icon used for the toggle
5374 * @param obj The toggle object
5375 * @param icon The icon object for the button
5377 * Once the icon object is set, a previously set one will be deleted
5378 * If you want to keep that old content object, use the
5379 * elm_toggle_icon_unset() function.
5381 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5383 * @brief Get the icon used for the toggle
5385 * @param obj The toggle object
5386 * @return The icon object that is being used
5388 * Return the icon object which is set for this widget.
5390 * @see elm_toggle_icon_set()
5392 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5394 * @brief Unset the icon used for the toggle
5396 * @param obj The toggle object
5397 * @return The icon object that was being used
5399 * Unparent and return the icon object which was set for this widget.
5401 * @see elm_toggle_icon_set()
5403 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5405 * @brief Sets the labels to be associated with the on and off states of the toggle.
5407 * @param obj The toggle object
5408 * @param onlabel The label displayed when the toggle is in the "on" state
5409 * @param offlabel The label displayed when the toggle is in the "off" state
5411 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5413 * @brief Gets the labels associated with the on and off states of the toggle.
5415 * @param obj The toggle object
5416 * @param onlabel A char** to place the onlabel of @p obj into
5417 * @param offlabel A char** to place the offlabel of @p obj into
5419 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5421 * @brief Sets the state of the toggle to @p state.
5423 * @param obj The toggle object
5424 * @param state The state of @p obj
5426 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5428 * @brief Gets the state of the toggle to @p state.
5430 * @param obj The toggle object
5431 * @return The state of @p obj
5433 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5435 * @brief Sets the state pointer of the toggle to @p statep.
5437 * @param obj The toggle object
5438 * @param statep The state pointer of @p obj
5440 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5446 * @defgroup Frame Frame
5448 * @image html img/widget/frame/preview-00.png
5449 * @image latex img/widget/frame/preview-00.eps
5451 * @brief Frame is a widget that holds some content and has a title.
5453 * The default look is a frame with a title, but Frame supports multple
5461 * @li outdent_bottom
5463 * Of all this styles only default shows the title. Frame emits no signals.
5465 * For a detailed example see the @ref tutorial_frame.
5470 * @brief Add a new frame to the parent
5472 * @param parent The parent object
5473 * @return The new object or NULL if it cannot be created
5475 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5477 * @brief Set the frame label
5479 * @param obj The frame object
5480 * @param label The label of this frame object
5482 * @deprecated use elm_object_text_set() instead.
5484 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5486 * @brief Get the frame label
5488 * @param obj The frame object
5490 * @return The label of this frame objet or NULL if unable to get frame
5492 * @deprecated use elm_object_text_get() instead.
5494 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5496 * @brief Set the content of the frame widget
5498 * Once the content object is set, a previously set one will be deleted.
5499 * If you want to keep that old content object, use the
5500 * elm_frame_content_unset() function.
5502 * @param obj The frame object
5503 * @param content The content will be filled in this frame object
5505 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5507 * @brief Get the content of the frame widget
5509 * Return the content object which is set for this widget
5511 * @param obj The frame object
5512 * @return The content that is being used
5514 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5516 * @brief Unset the content of the frame widget
5518 * Unparent and return the content object which was set for this widget
5520 * @param obj The frame object
5521 * @return The content that was being used
5523 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5529 * @defgroup Table Table
5531 * A container widget to arrange other widgets in a table where items can
5532 * also span multiple columns or rows - even overlap (and then be raised or
5533 * lowered accordingly to adjust stacking if they do overlap).
5535 * The followin are examples of how to use a table:
5536 * @li @ref tutorial_table_01
5537 * @li @ref tutorial_table_02
5542 * @brief Add a new table to the parent
5544 * @param parent The parent object
5545 * @return The new object or NULL if it cannot be created
5547 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5549 * @brief Set the homogeneous layout in the table
5551 * @param obj The layout object
5552 * @param homogeneous A boolean to set if the layout is homogeneous in the
5553 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5555 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5557 * @brief Get the current table homogeneous mode.
5559 * @param obj The table object
5560 * @return A boolean to indicating if the layout is homogeneous in the table
5561 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5563 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5565 * @warning <b>Use elm_table_homogeneous_set() instead</b>
5567 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5569 * @warning <b>Use elm_table_homogeneous_get() instead</b>
5571 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5573 * @brief Set padding between cells.
5575 * @param obj The layout object.
5576 * @param horizontal set the horizontal padding.
5577 * @param vertical set the vertical padding.
5579 * Default value is 0.
5581 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5583 * @brief Get padding between cells.
5585 * @param obj The layout object.
5586 * @param horizontal set the horizontal padding.
5587 * @param vertical set the vertical padding.
5589 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5591 * @brief Add a subobject on the table with the coordinates passed
5593 * @param obj The table object
5594 * @param subobj The subobject to be added to the table
5595 * @param x Row number
5596 * @param y Column number
5600 * @note All positioning inside the table is relative to rows and columns, so
5601 * a value of 0 for x and y, means the top left cell of the table, and a
5602 * value of 1 for w and h means @p subobj only takes that 1 cell.
5604 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5606 * @brief Remove child from table.
5608 * @param obj The table object
5609 * @param subobj The subobject
5611 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5613 * @brief Faster way to remove all child objects from a table object.
5615 * @param obj The table object
5616 * @param clear If true, will delete children, else just remove from table.
5618 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5620 * @brief Set the packing location of an existing child of the table
5622 * @param subobj The subobject to be modified in the table
5623 * @param x Row number
5624 * @param y Column number
5628 * Modifies the position of an object already in the table.
5630 * @note All positioning inside the table is relative to rows and columns, so
5631 * a value of 0 for x and y, means the top left cell of the table, and a
5632 * value of 1 for w and h means @p subobj only takes that 1 cell.
5634 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5636 * @brief Get the packing location of an existing child of the table
5638 * @param subobj The subobject to be modified in the table
5639 * @param x Row number
5640 * @param y Column number
5644 * @see elm_table_pack_set()
5646 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5652 * @defgroup Gengrid Gengrid (Generic grid)
5654 * This widget aims to position objects in a grid layout while
5655 * actually creating and rendering only the visible ones, using the
5656 * same idea as the @ref Genlist "genlist": the user defines a @b
5657 * class for each item, specifying functions that will be called at
5658 * object creation, deletion, etc. When those items are selected by
5659 * the user, a callback function is issued. Users may interact with
5660 * a gengrid via the mouse (by clicking on items to select them and
5661 * clicking on the grid's viewport and swiping to pan the whole
5662 * view) or via the keyboard, navigating through item with the
5665 * @section Gengrid_Layouts Gengrid layouts
5667 * Gengrids may layout its items in one of two possible layouts:
5671 * When in "horizontal mode", items will be placed in @b columns,
5672 * from top to bottom and, when the space for a column is filled,
5673 * another one is started on the right, thus expanding the grid
5674 * horizontally, making for horizontal scrolling. When in "vertical
5675 * mode" , though, items will be placed in @b rows, from left to
5676 * right and, when the space for a row is filled, another one is
5677 * started below, thus expanding the grid vertically (and making
5678 * for vertical scrolling).
5680 * @section Gengrid_Items Gengrid items
5682 * An item in a gengrid can have 0 or more text labels (they can be
5683 * regular text or textblock Evas objects - that's up to the style
5684 * to determine), 0 or more icons (which are simply objects
5685 * swallowed into the gengrid item's theming Edje object) and 0 or
5686 * more <b>boolean states</b>, which have the behavior left to the
5687 * user to define. The Edje part names for each of these properties
5688 * will be looked up, in the theme file for the gengrid, under the
5689 * Edje (string) data items named @c "labels", @c "icons" and @c
5690 * "states", respectively. For each of those properties, if more
5691 * than one part is provided, they must have names listed separated
5692 * by spaces in the data fields. For the default gengrid item
5693 * theme, we have @b one label part (@c "elm.text"), @b two icon
5694 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5697 * A gengrid item may be at one of several styles. Elementary
5698 * provides one by default - "default", but this can be extended by
5699 * system or application custom themes/overlays/extensions (see
5700 * @ref Theme "themes" for more details).
5702 * @section Gengrid_Item_Class Gengrid item classes
5704 * In order to have the ability to add and delete items on the fly,
5705 * gengrid implements a class (callback) system where the
5706 * application provides a structure with information about that
5707 * type of item (gengrid may contain multiple different items with
5708 * different classes, states and styles). Gengrid will call the
5709 * functions in this struct (methods) when an item is "realized"
5710 * (i.e., created dynamically, while the user is scrolling the
5711 * grid). All objects will simply be deleted when no longer needed
5712 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5713 * contains the following members:
5714 * - @c item_style - This is a constant string and simply defines
5715 * the name of the item style. It @b must be specified and the
5716 * default should be @c "default".
5717 * - @c func.label_get - This function is called when an item
5718 * object is actually created. The @c data parameter will point to
5719 * the same data passed to elm_gengrid_item_append() and related
5720 * item creation functions. The @c obj parameter is the gengrid
5721 * object itself, while the @c part one is the name string of one
5722 * of the existing text parts in the Edje group implementing the
5723 * item's theme. This function @b must return a strdup'()ed string,
5724 * as the caller will free() it when done. See
5725 * #GridItemLabelGetFunc.
5726 * - @c func.icon_get - This function is called when an item object
5727 * is actually created. The @c data parameter will point to the
5728 * same data passed to elm_gengrid_item_append() and related item
5729 * creation functions. The @c obj parameter is the gengrid object
5730 * itself, while the @c part one is the name string of one of the
5731 * existing (icon) swallow parts in the Edje group implementing the
5732 * item's theme. It must return @c NULL, when no icon is desired,
5733 * or a valid object handle, otherwise. The object will be deleted
5734 * by the gengrid on its deletion or when the item is "unrealized".
5735 * See #GridItemIconGetFunc.
5736 * - @c func.state_get - This function is called when an item
5737 * object is actually created. The @c data parameter will point to
5738 * the same data passed to elm_gengrid_item_append() and related
5739 * item creation functions. The @c obj parameter is the gengrid
5740 * object itself, while the @c part one is the name string of one
5741 * of the state parts in the Edje group implementing the item's
5742 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5743 * true/on. Gengrids will emit a signal to its theming Edje object
5744 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5745 * "source" arguments, respectively, when the state is true (the
5746 * default is false), where @c XXX is the name of the (state) part.
5747 * See #GridItemStateGetFunc.
5748 * - @c func.del - This is called when elm_gengrid_item_del() is
5749 * called on an item or elm_gengrid_clear() is called on the
5750 * gengrid. This is intended for use when gengrid items are
5751 * deleted, so any data attached to the item (e.g. its data
5752 * parameter on creation) can be deleted. See #GridItemDelFunc.
5754 * @section Gengrid_Usage_Hints Usage hints
5756 * If the user wants to have multiple items selected at the same
5757 * time, elm_gengrid_multi_select_set() will permit it. If the
5758 * gengrid is single-selection only (the default), then
5759 * elm_gengrid_select_item_get() will return the selected item or
5760 * @c NULL, if none is selected. If the gengrid is under
5761 * multi-selection, then elm_gengrid_selected_items_get() will
5762 * return a list (that is only valid as long as no items are
5763 * modified (added, deleted, selected or unselected) of child items
5766 * If an item changes (internal (boolean) state, label or icon
5767 * changes), then use elm_gengrid_item_update() to have gengrid
5768 * update the item with the new state. A gengrid will re-"realize"
5769 * the item, thus calling the functions in the
5770 * #Elm_Gengrid_Item_Class set for that item.
5772 * To programmatically (un)select an item, use
5773 * elm_gengrid_item_selected_set(). To get its selected state use
5774 * elm_gengrid_item_selected_get(). To make an item disabled
5775 * (unable to be selected and appear differently) use
5776 * elm_gengrid_item_disabled_set() to set this and
5777 * elm_gengrid_item_disabled_get() to get the disabled state.
5779 * Grid cells will only have their selection smart callbacks called
5780 * when firstly getting selected. Any further clicks will do
5781 * nothing, unless you enable the "always select mode", with
5782 * elm_gengrid_always_select_mode_set(), thus making every click to
5783 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
5784 * turn off the ability to select items entirely in the widget and
5785 * they will neither appear selected nor call the selection smart
5788 * Remember that you can create new styles and add your own theme
5789 * augmentation per application with elm_theme_extension_add(). If
5790 * you absolutely must have a specific style that overrides any
5791 * theme the user or system sets up you can use
5792 * elm_theme_overlay_add() to add such a file.
5794 * @section Gengrid_Smart_Events Gengrid smart events
5796 * Smart events that you can add callbacks for are:
5797 * - @c "activated" - The user has double-clicked or pressed
5798 * (enter|return|spacebar) on an item. The @c event_info parameter
5799 * is the gengrid item that was activated.
5800 * - @c "clicked,double" - The user has double-clicked an item.
5801 * The @c event_info parameter is the gengrid item that was double-clicked.
5802 * - @c "selected" - The user has made an item selected. The
5803 * @c event_info parameter is the gengrid item that was selected.
5804 * - @c "unselected" - The user has made an item unselected. The
5805 * @c event_info parameter is the gengrid item that was unselected.
5806 * - @c "realized" - This is called when the item in the gengrid
5807 * has its implementing Evas object instantiated, de facto. @c
5808 * event_info is the gengrid item that was created. The object
5809 * may be deleted at any time, so it is highly advised to the
5810 * caller @b not to use the object pointer returned from
5811 * elm_gengrid_item_object_get(), because it may point to freed
5813 * - @c "unrealized" - This is called when the implementing Evas
5814 * object for this item is deleted. @c event_info is the gengrid
5815 * item that was deleted.
5816 * - @c "changed" - Called when an item is added, removed, resized
5817 * or moved and when the gengrid is resized or gets "horizontal"
5819 * - @c "drag,start,up" - Called when the item in the gengrid has
5820 * been dragged (not scrolled) up.
5821 * - @c "drag,start,down" - Called when the item in the gengrid has
5822 * been dragged (not scrolled) down.
5823 * - @c "drag,start,left" - Called when the item in the gengrid has
5824 * been dragged (not scrolled) left.
5825 * - @c "drag,start,right" - Called when the item in the gengrid has
5826 * been dragged (not scrolled) right.
5827 * - @c "drag,stop" - Called when the item in the gengrid has
5828 * stopped being dragged.
5829 * - @c "drag" - Called when the item in the gengrid is being
5831 * - @c "scroll" - called when the content has been scrolled
5833 * - @c "scroll,drag,start" - called when dragging the content has
5835 * - @c "scroll,drag,stop" - called when dragging the content has
5838 * List of gendrid examples:
5839 * @li @ref gengrid_example
5843 * @addtogroup Gengrid
5847 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
5848 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
5849 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
5850 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
5851 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
5852 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
5853 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
5856 * @struct _Elm_Gengrid_Item_Class
5858 * Gengrid item class definition. See @ref Gengrid_Item_Class for
5861 struct _Elm_Gengrid_Item_Class
5863 const char *item_style;
5864 struct _Elm_Gengrid_Item_Class_Func
5866 GridItemLabelGetFunc label_get;
5867 GridItemIconGetFunc icon_get;
5868 GridItemStateGetFunc state_get;
5869 GridItemDelFunc del;
5871 }; /**< #Elm_Gengrid_Item_Class member definitions */
5874 * Add a new gengrid widget to the given parent Elementary
5875 * (container) object
5877 * @param parent The parent object
5878 * @return a new gengrid widget handle or @c NULL, on errors
5880 * This function inserts a new gengrid widget on the canvas.
5882 * @see elm_gengrid_item_size_set()
5883 * @see elm_gengrid_horizontal_set()
5884 * @see elm_gengrid_item_append()
5885 * @see elm_gengrid_item_del()
5886 * @see elm_gengrid_clear()
5890 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5893 * Set the size for the items of a given gengrid widget
5895 * @param obj The gengrid object.
5896 * @param w The items' width.
5897 * @param h The items' height;
5899 * A gengrid, after creation, has still no information on the size
5900 * to give to each of its cells. So, you most probably will end up
5901 * with squares one @ref Fingers "finger" wide, the default
5902 * size. Use this function to force a custom size for you items,
5903 * making them as big as you wish.
5905 * @see elm_gengrid_item_size_get()
5909 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5912 * Get the size set for the items of a given gengrid widget
5914 * @param obj The gengrid object.
5915 * @param w Pointer to a variable where to store the items' width.
5916 * @param h Pointer to a variable where to store the items' height.
5918 * @note Use @c NULL pointers on the size values you're not
5919 * interested in: they'll be ignored by the function.
5921 * @see elm_gengrid_item_size_get() for more details
5925 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5928 * Set the items grid's alignment within a given gengrid widget
5930 * @param obj The gengrid object.
5931 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
5932 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
5934 * This sets the alignment of the whole grid of items of a gengrid
5935 * within its given viewport. By default, those values are both
5936 * 0.5, meaning that the gengrid will have its items grid placed
5937 * exactly in the middle of its viewport.
5939 * @note If given alignment values are out of the cited ranges,
5940 * they'll be changed to the nearest boundary values on the valid
5943 * @see elm_gengrid_align_get()
5947 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
5950 * Get the items grid's alignment values within a given gengrid
5953 * @param obj The gengrid object.
5954 * @param align_x Pointer to a variable where to store the
5955 * horizontal alignment.
5956 * @param align_y Pointer to a variable where to store the vertical
5959 * @note Use @c NULL pointers on the alignment values you're not
5960 * interested in: they'll be ignored by the function.
5962 * @see elm_gengrid_align_set() for more details
5966 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
5969 * Set whether a given gengrid widget is or not able have items
5972 * @param obj The gengrid object
5973 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
5974 * @c EINA_FALSE to turn it off
5976 * If a gengrid is set to allow reordering, a click held for more
5977 * than 0.5 over a given item will highlight it specially,
5978 * signalling the gengrid has entered the reordering state. From
5979 * that time on, the user will be able to, while still holding the
5980 * mouse button down, move the item freely in the gengrid's
5981 * viewport, replacing to said item to the locations it goes to.
5982 * The replacements will be animated and, whenever the user
5983 * releases the mouse button, the item being replaced gets a new
5984 * definitive place in the grid.
5986 * @see elm_gengrid_reorder_mode_get()
5990 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5993 * Get whether a given gengrid widget is or not able have items
5996 * @param obj The gengrid object
5997 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
6000 * @see elm_gengrid_reorder_mode_set() for more details
6004 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6007 * Append a new item in a given gengrid widget.
6009 * @param obj The gengrid object.
6010 * @param gic The item class for the item.
6011 * @param data The item data.
6012 * @param func Convenience function called when the item is
6014 * @param func_data Data to be passed to @p func.
6015 * @return A handle to the item added or @c NULL, on errors.
6017 * This adds an item to the beginning of the gengrid.
6019 * @see elm_gengrid_item_prepend()
6020 * @see elm_gengrid_item_insert_before()
6021 * @see elm_gengrid_item_insert_after()
6022 * @see elm_gengrid_item_del()
6026 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);
6029 * Prepend a new item in a given gengrid widget.
6031 * @param obj The gengrid object.
6032 * @param gic The item class for the item.
6033 * @param data The item data.
6034 * @param func Convenience function called when the item is
6036 * @param func_data Data to be passed to @p func.
6037 * @return A handle to the item added or @c NULL, on errors.
6039 * This adds an item to the end of the gengrid.
6041 * @see elm_gengrid_item_append()
6042 * @see elm_gengrid_item_insert_before()
6043 * @see elm_gengrid_item_insert_after()
6044 * @see elm_gengrid_item_del()
6048 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);
6051 * Insert an item before another in a gengrid widget
6053 * @param obj The gengrid object.
6054 * @param gic The item class for the item.
6055 * @param data The item data.
6056 * @param relative The item to place this new one before.
6057 * @param func Convenience function called when the item is
6059 * @param func_data Data to be passed to @p func.
6060 * @return A handle to the item added or @c NULL, on errors.
6062 * This inserts an item before another in the gengrid.
6064 * @see elm_gengrid_item_append()
6065 * @see elm_gengrid_item_prepend()
6066 * @see elm_gengrid_item_insert_after()
6067 * @see elm_gengrid_item_del()
6071 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);
6074 * Insert an item after another in a gengrid widget
6076 * @param obj The gengrid object.
6077 * @param gic The item class for the item.
6078 * @param data The item data.
6079 * @param relative The item to place this new one after.
6080 * @param func Convenience function called when the item is
6082 * @param func_data Data to be passed to @p func.
6083 * @return A handle to the item added or @c NULL, on errors.
6085 * This inserts an item after another in the gengrid.
6087 * @see elm_gengrid_item_append()
6088 * @see elm_gengrid_item_prepend()
6089 * @see elm_gengrid_item_insert_after()
6090 * @see elm_gengrid_item_del()
6094 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);
6096 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);
6098 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);
6101 * Set whether items on a given gengrid widget are to get their
6102 * selection callbacks issued for @b every subsequent selection
6103 * click on them or just for the first click.
6105 * @param obj The gengrid object
6106 * @param always_select @c EINA_TRUE to make items "always
6107 * selected", @c EINA_FALSE, otherwise
6109 * By default, grid items will only call their selection callback
6110 * function when firstly getting selected, any subsequent further
6111 * clicks will do nothing. With this call, you make those
6112 * subsequent clicks also to issue the selection callbacks.
6114 * @note <b>Double clicks</b> will @b always be reported on items.
6116 * @see elm_gengrid_always_select_mode_get()
6120 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6123 * Get whether items on a given gengrid widget have their selection
6124 * callbacks issued for @b every subsequent selection click on them
6125 * or just for the first click.
6127 * @param obj The gengrid object.
6128 * @return @c EINA_TRUE if the gengrid items are "always selected",
6129 * @c EINA_FALSE, otherwise
6131 * @see elm_gengrid_always_select_mode_set() for more details
6135 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6138 * Set whether items on a given gengrid widget can be selected or not.
6140 * @param obj The gengrid object
6141 * @param no_select @c EINA_TRUE to make items selectable,
6142 * @c EINA_FALSE otherwise
6144 * This will make items in @p obj selectable or not. In the latter
6145 * case, any user interacion on the gendrid items will neither make
6146 * them appear selected nor them call their selection callback
6149 * @see elm_gengrid_no_select_mode_get()
6153 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6156 * Get whether items on a given gengrid widget can be selected or
6159 * @param obj The gengrid object
6160 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6163 * @see elm_gengrid_no_select_mode_set() for more details
6167 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6170 * Enable or disable multi-selection in a given gengrid widget
6172 * @param obj The gengrid object.
6173 * @param multi @c EINA_TRUE, to enable multi-selection,
6174 * @c EINA_FALSE to disable it.
6176 * Multi-selection is the ability for one to have @b more than one
6177 * item selected, on a given gengrid, simultaneously. When it is
6178 * enabled, a sequence of clicks on different items will make them
6179 * all selected, progressively. A click on an already selected item
6180 * will unselect it. If interecting via the keyboard,
6181 * multi-selection is enabled while holding the "Shift" key.
6183 * @note By default, multi-selection is @b disabled on gengrids
6185 * @see elm_gengrid_multi_select_get()
6189 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6192 * Get whether multi-selection is enabled or disabled for a given
6195 * @param obj The gengrid object.
6196 * @return @c EINA_TRUE, if multi-selection is enabled, @c
6197 * EINA_FALSE otherwise
6199 * @see elm_gengrid_multi_select_set() for more details
6203 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6206 * Enable or disable bouncing effect for a given gengrid widget
6208 * @param obj The gengrid object
6209 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6210 * @c EINA_FALSE to disable it
6211 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6212 * @c EINA_FALSE to disable it
6214 * The bouncing effect occurs whenever one reaches the gengrid's
6215 * edge's while panning it -- it will scroll past its limits a
6216 * little bit and return to the edge again, in a animated for,
6219 * @note By default, gengrids have bouncing enabled on both axis
6221 * @see elm_gengrid_bounce_get()
6225 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6228 * Get whether bouncing effects are enabled or disabled, for a
6229 * given gengrid widget, on each axis
6231 * @param obj The gengrid object
6232 * @param h_bounce Pointer to a variable where to store the
6233 * horizontal bouncing flag.
6234 * @param v_bounce Pointer to a variable where to store the
6235 * vertical bouncing flag.
6237 * @see elm_gengrid_bounce_set() for more details
6241 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6244 * Set a given gengrid widget's scrolling page size, relative to
6245 * its viewport size.
6247 * @param obj The gengrid object
6248 * @param h_pagerel The horizontal page (relative) size
6249 * @param v_pagerel The vertical page (relative) size
6251 * The gengrid's scroller is capable of binding scrolling by the
6252 * user to "pages". It means that, while scrolling and, specially
6253 * after releasing the mouse button, the grid will @b snap to the
6254 * nearest displaying page's area. When page sizes are set, the
6255 * grid's continuous content area is split into (equal) page sized
6258 * This function sets the size of a page <b>relatively to the
6259 * viewport dimensions</b> of the gengrid, for each axis. A value
6260 * @c 1.0 means "the exact viewport's size", in that axis, while @c
6261 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6262 * a viewport". Sane usable values are, than, between @c 0.0 and @c
6263 * 1.0. Values beyond those will make it behave behave
6264 * inconsistently. If you only want one axis to snap to pages, use
6265 * the value @c 0.0 for the other one.
6267 * There is a function setting page size values in @b absolute
6268 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6269 * is mutually exclusive to this one.
6271 * @see elm_gengrid_page_relative_get()
6275 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6278 * Get a given gengrid widget's scrolling page size, relative to
6279 * its viewport size.
6281 * @param obj The gengrid object
6282 * @param h_pagerel Pointer to a variable where to store the
6283 * horizontal page (relative) size
6284 * @param v_pagerel Pointer to a variable where to store the
6285 * vertical page (relative) size
6287 * @see elm_gengrid_page_relative_set() for more details
6291 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6294 * Set a given gengrid widget's scrolling page size
6296 * @param obj The gengrid object
6297 * @param h_pagerel The horizontal page size, in pixels
6298 * @param v_pagerel The vertical page size, in pixels
6300 * The gengrid's scroller is capable of binding scrolling by the
6301 * user to "pages". It means that, while scrolling and, specially
6302 * after releasing the mouse button, the grid will @b snap to the
6303 * nearest displaying page's area. When page sizes are set, the
6304 * grid's continuous content area is split into (equal) page sized
6307 * This function sets the size of a page of the gengrid, in pixels,
6308 * for each axis. Sane usable values are, between @c 0 and the
6309 * dimensions of @p obj, for each axis. Values beyond those will
6310 * make it behave behave inconsistently. If you only want one axis
6311 * to snap to pages, use the value @c 0 for the other one.
6313 * There is a function setting page size values in @b relative
6314 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6315 * use is mutually exclusive to this one.
6319 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6322 * Set for what direction a given gengrid widget will expand while
6323 * placing its items.
6325 * @param obj The gengrid object.
6326 * @param setting @c EINA_TRUE to make the gengrid expand
6327 * horizontally, @c EINA_FALSE to expand vertically.
6329 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6330 * in @b columns, from top to bottom and, when the space for a
6331 * column is filled, another one is started on the right, thus
6332 * expanding the grid horizontally. When in "vertical mode"
6333 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6334 * to right and, when the space for a row is filled, another one is
6335 * started below, thus expanding the grid vertically.
6337 * @see elm_gengrid_horizontal_get()
6341 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6344 * Get for what direction a given gengrid widget will expand while
6345 * placing its items.
6347 * @param obj The gengrid object.
6348 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6349 * @c EINA_FALSE if it's set to expand vertically.
6351 * @see elm_gengrid_horizontal_set() for more detais
6355 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6358 * Get the first item in a given gengrid widget
6360 * @param obj The gengrid object
6361 * @return The first item's handle or @c NULL, if there are no
6362 * items in @p obj (and on errors)
6364 * This returns the first item in the @p obj's internal list of
6367 * @see elm_gengrid_last_item_get()
6371 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6374 * Get the last item in a given gengrid widget
6376 * @param obj The gengrid object
6377 * @return The last item's handle or @c NULL, if there are no
6378 * items in @p obj (and on errors)
6380 * This returns the last item in the @p obj's internal list of
6383 * @see elm_gengrid_first_item_get()
6387 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6390 * Get the @b next item in a gengrid widget's internal list of items,
6391 * given a handle to one of those items.
6393 * @param item The gengrid item to fetch next from
6394 * @return The item after @p item, or @c NULL if there's none (and
6397 * This returns the item placed after the @p item, on the container
6400 * @see elm_gengrid_item_prev_get()
6404 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6407 * Get the @b previous item in a gengrid widget's internal list of items,
6408 * given a handle to one of those items.
6410 * @param item The gengrid item to fetch previous from
6411 * @return The item before @p item, or @c NULL if there's none (and
6414 * This returns the item placed before the @p item, on the container
6417 * @see elm_gengrid_item_next_get()
6421 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6424 * Get the gengrid object's handle which contains a given gengrid
6427 * @param item The item to fetch the container from
6428 * @return The gengrid (parent) object
6430 * This returns the gengrid object itself that an item belongs to.
6434 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6437 * Remove a gengrid item from the its parent, deleting it.
6439 * @param item The item to be removed.
6440 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6442 * @see elm_gengrid_clear(), to remove all items in a gengrid at
6447 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6450 * Update the contents of a given gengrid item
6452 * @param item The gengrid item
6454 * This updates an item by calling all the item class functions
6455 * again to get the icons, labels and states. Use this when the
6456 * original item data has changed and you want thta changes to be
6461 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6462 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6463 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6466 * Return the data associated to a given gengrid item
6468 * @param item The gengrid item.
6469 * @return the data associated to this item.
6471 * This returns the @c data value passed on the
6472 * elm_gengrid_item_append() and related item addition calls.
6474 * @see elm_gengrid_item_append()
6475 * @see elm_gengrid_item_data_set()
6479 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6482 * Set the data associated to a given gengrid item
6484 * @param item The gengrid item
6485 * @param data The new data pointer to set on it
6487 * This @b overrides the @c data value passed on the
6488 * elm_gengrid_item_append() and related item addition calls. This
6489 * function @b won't call elm_gengrid_item_update() automatically,
6490 * so you'd issue it afterwards if you want to hove the item
6491 * updated to reflect the that new data.
6493 * @see elm_gengrid_item_data_get()
6497 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6500 * Get a given gengrid item's position, relative to the whole
6501 * gengrid's grid area.
6503 * @param item The Gengrid item.
6504 * @param x Pointer to variable where to store the item's <b>row
6506 * @param y Pointer to variable where to store the item's <b>column
6509 * This returns the "logical" position of the item whithin the
6510 * gengrid. For example, @c (0, 1) would stand for first row,
6515 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6518 * Set whether a given gengrid item is selected or not
6520 * @param item The gengrid item
6521 * @param selected Use @c EINA_TRUE, to make it selected, @c
6522 * EINA_FALSE to make it unselected
6524 * This sets the selected state of an item. If multi selection is
6525 * not enabled on the containing gengrid and @p selected is @c
6526 * EINA_TRUE, any other previously selected items will get
6527 * unselected in favor of this new one.
6529 * @see elm_gengrid_item_selected_get()
6533 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6536 * Get whether a given gengrid item is selected or not
6538 * @param item The gengrid item
6539 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6541 * @see elm_gengrid_item_selected_set() for more details
6545 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6548 * Get the real Evas object created to implement the view of a
6549 * given gengrid item
6551 * @param item The gengrid item.
6552 * @return the Evas object implementing this item's view.
6554 * This returns the actual Evas object used to implement the
6555 * specified gengrid item's view. This may be @c NULL, as it may
6556 * not have been created or may have been deleted, at any time, by
6557 * the gengrid. <b>Do not modify this object</b> (move, resize,
6558 * show, hide, etc.), as the gengrid is controlling it. This
6559 * function is for querying, emitting custom signals or hooking
6560 * lower level callbacks for events on that object. Do not delete
6561 * this object under any circumstances.
6563 * @see elm_gengrid_item_data_get()
6567 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6570 * Show the portion of a gengrid's internal grid containing a given
6571 * item, @b immediately.
6573 * @param item The item to display
6575 * This causes gengrid to @b redraw its viewport's contents to the
6576 * region contining the given @p item item, if it is not fully
6579 * @see elm_gengrid_item_bring_in()
6583 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6586 * Animatedly bring in, to the visible are of a gengrid, a given
6589 * @param item The gengrid item to display
6591 * This causes gengrig to jump to the given @p item item and show
6592 * it (by scrolling), if it is not fully visible. This will use
6593 * animation to do so and take a period of time to complete.
6595 * @see elm_gengrid_item_show()
6599 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6602 * Set whether a given gengrid item is disabled or not.
6604 * @param item The gengrid item
6605 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6606 * to enable it back.
6608 * A disabled item cannot be selected or unselected. It will also
6609 * change its appearance, to signal the user it's disabled.
6611 * @see elm_gengrid_item_disabled_get()
6615 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6618 * Get whether a given gengrid item is disabled or not.
6620 * @param item The gengrid item
6621 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6624 * @see elm_gengrid_item_disabled_set() for more details
6628 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6631 * Set the text to be shown in a given gengrid item's tooltips.
6633 * @param item The gengrid item
6634 * @param text The text to set in the content
6636 * This call will setup the text to be used as tooltip to that item
6637 * (analogous to elm_object_tooltip_text_set(), but being item
6638 * tooltips with higher precedence than object tooltips). It can
6639 * have only one tooltip at a time, so any previous tooltip data
6644 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6647 * Set the content to be shown in a given gengrid item's tooltips
6649 * @param item The gengrid item.
6650 * @param func The function returning the tooltip contents.
6651 * @param data What to provide to @a func as callback data/context.
6652 * @param del_cb Called when data is not needed anymore, either when
6653 * another callback replaces @p func, the tooltip is unset with
6654 * elm_gengrid_item_tooltip_unset() or the owner @p item
6655 * dies. This callback receives as its first parameter the
6656 * given @p data, being @c event_info the item handle.
6658 * This call will setup the tooltip's contents to @p item
6659 * (analogous to elm_object_tooltip_content_cb_set(), but being
6660 * item tooltips with higher precedence than object tooltips). It
6661 * can have only one tooltip at a time, so any previous tooltip
6662 * content will get removed. @p func (with @p data) will be called
6663 * every time Elementary needs to show the tooltip and it should
6664 * return a valid Evas object, which will be fully managed by the
6665 * tooltip system, getting deleted when the tooltip is gone.
6669 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);
6672 * Unset a tooltip from a given gengrid item
6674 * @param item gengrid item to remove a previously set tooltip from.
6676 * This call removes any tooltip set on @p item. The callback
6677 * provided as @c del_cb to
6678 * elm_gengrid_item_tooltip_content_cb_set() will be called to
6679 * notify it is not used anymore (and have resources cleaned, if
6682 * @see elm_gengrid_item_tooltip_content_cb_set()
6686 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6689 * Set a different @b style for a given gengrid item's tooltip.
6691 * @param item gengrid item with tooltip set
6692 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6693 * "default", @c "transparent", etc)
6695 * Tooltips can have <b>alternate styles</b> to be displayed on,
6696 * which are defined by the theme set on Elementary. This function
6697 * works analogously as elm_object_tooltip_style_set(), but here
6698 * applied only to gengrid item objects. The default style for
6699 * tooltips is @c "default".
6701 * @note before you set a style you should define a tooltip with
6702 * elm_gengrid_item_tooltip_content_cb_set() or
6703 * elm_gengrid_item_tooltip_text_set()
6705 * @see elm_gengrid_item_tooltip_style_get()
6709 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6712 * Get the style set a given gengrid item's tooltip.
6714 * @param item gengrid item with tooltip already set on.
6715 * @return style the theme style in use, which defaults to
6716 * "default". If the object does not have a tooltip set,
6717 * then @c NULL is returned.
6719 * @see elm_gengrid_item_tooltip_style_set() for more details
6723 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6725 * @brief Disable size restrictions on an object's tooltip
6726 * @param item The tooltip's anchor object
6727 * @param disable If EINA_TRUE, size restrictions are disabled
6728 * @return EINA_FALSE on failure, EINA_TRUE on success
6730 * This function allows a tooltip to expand beyond its parant window's canvas.
6731 * It will instead be limited only by the size of the display.
6733 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6735 * @brief Retrieve size restriction state of an object's tooltip
6736 * @param item The tooltip's anchor object
6737 * @return If EINA_TRUE, size restrictions are disabled
6739 * This function returns whether a tooltip is allowed to expand beyond
6740 * its parant window's canvas.
6741 * It will instead be limited only by the size of the display.
6743 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6745 * Set the type of mouse pointer/cursor decoration to be shown,
6746 * when the mouse pointer is over the given gengrid widget item
6748 * @param item gengrid item to customize cursor on
6749 * @param cursor the cursor type's name
6751 * This function works analogously as elm_object_cursor_set(), but
6752 * here the cursor's changing area is restricted to the item's
6753 * area, and not the whole widget's. Note that that item cursors
6754 * have precedence over widget cursors, so that a mouse over @p
6755 * item will always show cursor @p type.
6757 * If this function is called twice for an object, a previously set
6758 * cursor will be unset on the second call.
6760 * @see elm_object_cursor_set()
6761 * @see elm_gengrid_item_cursor_get()
6762 * @see elm_gengrid_item_cursor_unset()
6766 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6769 * Get the type of mouse pointer/cursor decoration set to be shown,
6770 * when the mouse pointer is over the given gengrid widget item
6772 * @param item gengrid item with custom cursor set
6773 * @return the cursor type's name or @c NULL, if no custom cursors
6774 * were set to @p item (and on errors)
6776 * @see elm_object_cursor_get()
6777 * @see elm_gengrid_item_cursor_set() for more details
6778 * @see elm_gengrid_item_cursor_unset()
6782 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6785 * Unset any custom mouse pointer/cursor decoration set to be
6786 * shown, when the mouse pointer is over the given gengrid widget
6787 * item, thus making it show the @b default cursor again.
6789 * @param item a gengrid item
6791 * Use this call to undo any custom settings on this item's cursor
6792 * decoration, bringing it back to defaults (no custom style set).
6794 * @see elm_object_cursor_unset()
6795 * @see elm_gengrid_item_cursor_set() for more details
6799 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6802 * Set a different @b style for a given custom cursor set for a
6805 * @param item gengrid item with custom cursor set
6806 * @param style the <b>theme style</b> to use (e.g. @c "default",
6807 * @c "transparent", etc)
6809 * This function only makes sense when one is using custom mouse
6810 * cursor decorations <b>defined in a theme file</b> , which can
6811 * have, given a cursor name/type, <b>alternate styles</b> on
6812 * it. It works analogously as elm_object_cursor_style_set(), but
6813 * here applied only to gengrid item objects.
6815 * @warning Before you set a cursor style you should have defined a
6816 * custom cursor previously on the item, with
6817 * elm_gengrid_item_cursor_set()
6819 * @see elm_gengrid_item_cursor_engine_only_set()
6820 * @see elm_gengrid_item_cursor_style_get()
6824 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6827 * Get the current @b style set for a given gengrid item's custom
6830 * @param item gengrid item with custom cursor set.
6831 * @return style the cursor style in use. If the object does not
6832 * have a cursor set, then @c NULL is returned.
6834 * @see elm_gengrid_item_cursor_style_set() for more details
6838 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6841 * Set if the (custom) cursor for a given gengrid item should be
6842 * searched in its theme, also, or should only rely on the
6845 * @param item item with custom (custom) cursor already set on
6846 * @param engine_only Use @c EINA_TRUE to have cursors looked for
6847 * only on those provided by the rendering engine, @c EINA_FALSE to
6848 * have them searched on the widget's theme, as well.
6850 * @note This call is of use only if you've set a custom cursor
6851 * for gengrid items, with elm_gengrid_item_cursor_set().
6853 * @note By default, cursors will only be looked for between those
6854 * provided by the rendering engine.
6858 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6861 * Get if the (custom) cursor for a given gengrid item is being
6862 * searched in its theme, also, or is only relying on the rendering
6865 * @param item a gengrid item
6866 * @return @c EINA_TRUE, if cursors are being looked for only on
6867 * those provided by the rendering engine, @c EINA_FALSE if they
6868 * are being searched on the widget's theme, as well.
6870 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
6874 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6877 * Remove all items from a given gengrid widget
6879 * @param obj The gengrid object.
6881 * This removes (and deletes) all items in @p obj, leaving it
6884 * @see elm_gengrid_item_del(), to remove just one item.
6888 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6891 * Get the selected item in a given gengrid widget
6893 * @param obj The gengrid object.
6894 * @return The selected item's handleor @c NULL, if none is
6895 * selected at the moment (and on errors)
6897 * This returns the selected item in @p obj. If multi selection is
6898 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
6899 * the first item in the list is selected, which might not be very
6900 * useful. For that case, see elm_gengrid_selected_items_get().
6904 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6907 * Get <b>a list</b> of selected items in a given gengrid
6909 * @param obj The gengrid object.
6910 * @return The list of selected items or @c NULL, if none is
6911 * selected at the moment (and on errors)
6913 * This returns a list of the selected items, in the order that
6914 * they appear in the grid. This list is only valid as long as no
6915 * more items are selected or unselected (or unselected implictly
6916 * by deletion). The list contains #Elm_Gengrid_Item pointers as
6919 * @see elm_gengrid_selected_item_get()
6923 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6930 * @defgroup Clock Clock
6932 * @image html img/widget/clock/preview-00.png
6933 * @image latex img/widget/clock/preview-00.eps
6935 * This is a @b digital clock widget. In its default theme, it has a
6936 * vintage "flipping numbers clock" appearance, which will animate
6937 * sheets of individual algarisms individually as time goes by.
6939 * A newly created clock will fetch system's time (already
6940 * considering local time adjustments) to start with, and will tick
6941 * accondingly. It may or may not show seconds.
6943 * Clocks have an @b edition mode. When in it, the sheets will
6944 * display extra arrow indications on the top and bottom and the
6945 * user may click on them to raise or lower the time values. After
6946 * it's told to exit edition mode, it will keep ticking with that
6947 * new time set (it keeps the difference from local time).
6949 * Also, when under edition mode, user clicks on the cited arrows
6950 * which are @b held for some time will make the clock to flip the
6951 * sheet, thus editing the time, continuosly and automatically for
6952 * the user. The interval between sheet flips will keep growing in
6953 * time, so that it helps the user to reach a time which is distant
6956 * The time display is, by default, in military mode (24h), but an
6957 * am/pm indicator may be optionally shown, too, when it will
6960 * Smart callbacks one can register to:
6961 * - "changed" - the clock's user changed the time
6963 * Here is an example on its usage:
6964 * @li @ref clock_example
6973 * Identifiers for which clock digits should be editable, when a
6974 * clock widget is in edition mode. Values may be ORed together to
6975 * make a mask, naturally.
6977 * @see elm_clock_edit_set()
6978 * @see elm_clock_digit_edit_set()
6980 typedef enum _Elm_Clock_Digedit
6982 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
6983 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
6984 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
6985 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
6986 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
6987 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
6988 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
6989 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
6990 } Elm_Clock_Digedit;
6993 * Add a new clock widget to the given parent Elementary
6994 * (container) object
6996 * @param parent The parent object
6997 * @return a new clock widget handle or @c NULL, on errors
6999 * This function inserts a new clock widget on the canvas.
7003 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7006 * Set a clock widget's time, programmatically
7008 * @param obj The clock widget object
7009 * @param hrs The hours to set
7010 * @param min The minutes to set
7011 * @param sec The secondes to set
7013 * This function updates the time that is showed by the clock
7016 * Values @b must be set within the following ranges:
7017 * - 0 - 23, for hours
7018 * - 0 - 59, for minutes
7019 * - 0 - 59, for seconds,
7021 * even if the clock is not in "military" mode.
7023 * @warning The behavior for values set out of those ranges is @b
7028 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7031 * Get a clock widget's time values
7033 * @param obj The clock object
7034 * @param[out] hrs Pointer to the variable to get the hours value
7035 * @param[out] min Pointer to the variable to get the minutes value
7036 * @param[out] sec Pointer to the variable to get the seconds value
7038 * This function gets the time set for @p obj, returning
7039 * it on the variables passed as the arguments to function
7041 * @note Use @c NULL pointers on the time values you're not
7042 * interested in: they'll be ignored by the function.
7046 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7049 * Set whether a given clock widget is under <b>edition mode</b> or
7050 * under (default) displaying-only mode.
7052 * @param obj The clock object
7053 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7054 * put it back to "displaying only" mode
7056 * This function makes a clock's time to be editable or not <b>by
7057 * user interaction</b>. When in edition mode, clocks @b stop
7058 * ticking, until one brings them back to canonical mode. The
7059 * elm_clock_digit_edit_set() function will influence which digits
7060 * of the clock will be editable. By default, all of them will be
7061 * (#ELM_CLOCK_NONE).
7063 * @note am/pm sheets, if being shown, will @b always be editable
7064 * under edition mode.
7066 * @see elm_clock_edit_get()
7070 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7073 * Retrieve whether a given clock widget is under <b>edition
7074 * mode</b> or under (default) displaying-only mode.
7076 * @param obj The clock object
7077 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7080 * This function retrieves whether the clock's time can be edited
7081 * or not by user interaction.
7083 * @see elm_clock_edit_set() for more details
7087 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7090 * Set what digits of the given clock widget should be editable
7091 * when in edition mode.
7093 * @param obj The clock object
7094 * @param digedit Bit mask indicating the digits to be editable
7095 * (values in #Elm_Clock_Digedit).
7097 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7098 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7101 * @see elm_clock_digit_edit_get()
7105 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7108 * Retrieve what digits of the given clock widget should be
7109 * editable when in edition mode.
7111 * @param obj The clock object
7112 * @return Bit mask indicating the digits to be editable
7113 * (values in #Elm_Clock_Digedit).
7115 * @see elm_clock_digit_edit_set() for more details
7119 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7122 * Set if the given clock widget must show hours in military or
7125 * @param obj The clock object
7126 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7129 * This function sets if the clock must show hours in military or
7130 * am/pm mode. In some countries like Brazil the military mode
7131 * (00-24h-format) is used, in opposition to the USA, where the
7132 * am/pm mode is more commonly used.
7134 * @see elm_clock_show_am_pm_get()
7138 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7141 * Get if the given clock widget shows hours in military or am/pm
7144 * @param obj The clock object
7145 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7148 * This function gets if the clock shows hours in military or am/pm
7151 * @see elm_clock_show_am_pm_set() for more details
7155 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7158 * Set if the given clock widget must show time with seconds or not
7160 * @param obj The clock object
7161 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7163 * This function sets if the given clock must show or not elapsed
7164 * seconds. By default, they are @b not shown.
7166 * @see elm_clock_show_seconds_get()
7170 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7173 * Get whether the given clock widget is showing time with seconds
7176 * @param obj The clock object
7177 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7179 * This function gets whether @p obj is showing or not the elapsed
7182 * @see elm_clock_show_seconds_set()
7186 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7189 * Set the interval on time updates for an user mouse button hold
7190 * on clock widgets' time edition.
7192 * @param obj The clock object
7193 * @param interval The (first) interval value in seconds
7195 * This interval value is @b decreased while the user holds the
7196 * mouse pointer either incrementing or decrementing a given the
7197 * clock digit's value.
7199 * This helps the user to get to a given time distant from the
7200 * current one easier/faster, as it will start to flip quicker and
7201 * quicker on mouse button holds.
7203 * The calculation for the next flip interval value, starting from
7204 * the one set with this call, is the previous interval divided by
7205 * 1.05, so it decreases a little bit.
7207 * The default starting interval value for automatic flips is
7210 * @see elm_clock_interval_get()
7214 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7217 * Get the interval on time updates for an user mouse button hold
7218 * on clock widgets' time edition.
7220 * @param obj The clock object
7221 * @return The (first) interval value, in seconds, set on it
7223 * @see elm_clock_interval_set() for more details
7227 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7234 * @defgroup Layout Layout
7236 * @image html img/widget/layout/preview-00.png
7237 * @image latex img/widget/layout/preview-00.eps width=\textwidth
7239 * @image html img/layout-predefined.png
7240 * @image latex img/layout-predefined.eps width=\textwidth
7242 * This is a container widget that takes a standard Edje design file and
7243 * wraps it very thinly in a widget.
7245 * An Edje design (theme) file has a very wide range of possibilities to
7246 * describe the behavior of elements added to the Layout. Check out the Edje
7247 * documentation and the EDC reference to get more information about what can
7248 * be done with Edje.
7250 * Just like @ref List, @ref Box, and other container widgets, any
7251 * object added to the Layout will become its child, meaning that it will be
7252 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7254 * The Layout widget can contain as many Contents, Boxes or Tables as
7255 * described in its theme file. For instance, objects can be added to
7256 * different Tables by specifying the respective Table part names. The same
7257 * is valid for Content and Box.
7259 * The objects added as child of the Layout will behave as described in the
7260 * part description where they were added. There are 3 possible types of
7261 * parts where a child can be added:
7263 * @section secContent Content (SWALLOW part)
7265 * Only one object can be added to the @c SWALLOW part (but you still can
7266 * have many @c SWALLOW parts and one object on each of them). Use the @c
7267 * elm_layout_content_* set of functions to set, retrieve and unset objects
7268 * as content of the @c SWALLOW. After being set to this part, the object
7269 * size, position, visibility, clipping and other description properties
7270 * will be totally controled by the description of the given part (inside
7271 * the Edje theme file).
7273 * One can use @c evas_object_size_hint_* functions on the child to have some
7274 * kind of control over its behavior, but the resulting behavior will still
7275 * depend heavily on the @c SWALLOW part description.
7277 * The Edje theme also can change the part description, based on signals or
7278 * scripts running inside the theme. This change can also be animated. All of
7279 * this will affect the child object set as content accordingly. The object
7280 * size will be changed if the part size is changed, it will animate move if
7281 * the part is moving, and so on.
7283 * The following picture demonstrates a Layout widget with a child object
7284 * added to its @c SWALLOW:
7286 * @image html layout_swallow.png
7287 * @image latex layout_swallow.eps width=\textwidth
7289 * @section secBox Box (BOX part)
7291 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7292 * allows one to add objects to the box and have them distributed along its
7293 * area, accordingly to the specified @a layout property (now by @a layout we
7294 * mean the chosen layouting design of the Box, not the Layout widget
7297 * A similar effect for having a box with its position, size and other things
7298 * controled by the Layout theme would be to create an Elementary @ref Box
7299 * widget and add it as a Content in the @c SWALLOW part.
7301 * The main difference of using the Layout Box is that its behavior, the box
7302 * properties like layouting format, padding, align, etc. will be all
7303 * controled by the theme. This means, for example, that a signal could be
7304 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7305 * handled the signal by changing the box padding, or align, or both. Using
7306 * the Elementary @ref Box widget is not necessarily harder or easier, it
7307 * just depends on the circunstances and requirements.
7309 * The Layout Box can be used through the @c elm_layout_box_* set of
7312 * The following picture demonstrates a Layout widget with many child objects
7313 * added to its @c BOX part:
7315 * @image html layout_box.png
7316 * @image latex layout_box.eps width=\textwidth
7318 * @section secTable Table (TABLE part)
7320 * Just like the @ref secBox, the Layout Table is very similar to the
7321 * Elementary @ref Table widget. It allows one to add objects to the Table
7322 * specifying the row and column where the object should be added, and any
7323 * column or row span if necessary.
7325 * Again, we could have this design by adding a @ref Table widget to the @c
7326 * SWALLOW part using elm_layout_content_set(). The same difference happens
7327 * here when choosing to use the Layout Table (a @c TABLE part) instead of
7328 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7330 * The Layout Table can be used through the @c elm_layout_table_* set of
7333 * The following picture demonstrates a Layout widget with many child objects
7334 * added to its @c TABLE part:
7336 * @image html layout_table.png
7337 * @image latex layout_table.eps width=\textwidth
7339 * @section secPredef Predefined Layouts
7341 * Another interesting thing about the Layout widget is that it offers some
7342 * predefined themes that come with the default Elementary theme. These
7343 * themes can be set by the call elm_layout_theme_set(), and provide some
7344 * basic functionality depending on the theme used.
7346 * Most of them already send some signals, some already provide a toolbar or
7347 * back and next buttons.
7349 * These are available predefined theme layouts. All of them have class = @c
7350 * layout, group = @c application, and style = one of the following options:
7352 * @li @c toolbar-content - application with toolbar and main content area
7353 * @li @c toolbar-content-back - application with toolbar and main content
7354 * area with a back button and title area
7355 * @li @c toolbar-content-back-next - application with toolbar and main
7356 * content area with a back and next buttons and title area
7357 * @li @c content-back - application with a main content area with a back
7358 * button and title area
7359 * @li @c content-back-next - application with a main content area with a
7360 * back and next buttons and title area
7361 * @li @c toolbar-vbox - application with toolbar and main content area as a
7363 * @li @c toolbar-table - application with toolbar and main content area as a
7366 * @section secExamples Examples
7368 * Some examples of the Layout widget can be found here:
7369 * @li @ref layout_example_01
7370 * @li @ref layout_example_02
7371 * @li @ref layout_example_03
7372 * @li @ref layout_example_edc
7377 * Add a new layout to the parent
7379 * @param parent The parent object
7380 * @return The new object or NULL if it cannot be created
7382 * @see elm_layout_file_set()
7383 * @see elm_layout_theme_set()
7387 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7389 * Set the file that will be used as layout
7391 * @param obj The layout object
7392 * @param file The path to file (edj) that will be used as layout
7393 * @param group The group that the layout belongs in edje file
7395 * @return (1 = success, 0 = error)
7399 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7401 * Set the edje group from the elementary theme that will be used as layout
7403 * @param obj The layout object
7404 * @param clas the clas of the group
7405 * @param group the group
7406 * @param style the style to used
7408 * @return (1 = success, 0 = error)
7412 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7414 * Set the layout content.
7416 * @param obj The layout object
7417 * @param swallow The swallow part name in the edje file
7418 * @param content The child that will be added in this layout object
7420 * Once the content object is set, a previously set one will be deleted.
7421 * If you want to keep that old content object, use the
7422 * elm_layout_content_unset() function.
7424 * @note In an Edje theme, the part used as a content container is called @c
7425 * SWALLOW. This is why the parameter name is called @p swallow, but it is
7426 * expected to be a part name just like the second parameter of
7427 * elm_layout_box_append().
7429 * @see elm_layout_box_append()
7430 * @see elm_layout_content_get()
7431 * @see elm_layout_content_unset()
7436 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7438 * Get the child object in the given content part.
7440 * @param obj The layout object
7441 * @param swallow The SWALLOW part to get its content
7443 * @return The swallowed object or NULL if none or an error occurred
7445 * @see elm_layout_content_set()
7449 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7451 * Unset the layout content.
7453 * @param obj The layout object
7454 * @param swallow The swallow part name in the edje file
7455 * @return The content that was being used
7457 * Unparent and return the content object which was set for this part.
7459 * @see elm_layout_content_set()
7463 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7465 * Set the text of the given part
7467 * @param obj The layout object
7468 * @param part The TEXT part where to set the text
7469 * @param text The text to set
7472 * @deprecated use elm_object_text_* instead.
7474 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7476 * Get the text set in the given part
7478 * @param obj The layout object
7479 * @param part The TEXT part to retrieve the text off
7481 * @return The text set in @p part
7484 * @deprecated use elm_object_text_* instead.
7486 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7488 * Append child to layout box part.
7490 * @param obj the layout object
7491 * @param part the box part to which the object will be appended.
7492 * @param child the child object to append to box.
7494 * Once the object is appended, it will become child of the layout. Its
7495 * lifetime will be bound to the layout, whenever the layout dies the child
7496 * will be deleted automatically. One should use elm_layout_box_remove() to
7497 * make this layout forget about the object.
7499 * @see elm_layout_box_prepend()
7500 * @see elm_layout_box_insert_before()
7501 * @see elm_layout_box_insert_at()
7502 * @see elm_layout_box_remove()
7506 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7508 * Prepend child to layout box part.
7510 * @param obj the layout object
7511 * @param part the box part to prepend.
7512 * @param child the child object to prepend to box.
7514 * Once the object is prepended, it will become child of the layout. Its
7515 * lifetime will be bound to the layout, whenever the layout dies the child
7516 * will be deleted automatically. One should use elm_layout_box_remove() to
7517 * make this layout forget about the object.
7519 * @see elm_layout_box_append()
7520 * @see elm_layout_box_insert_before()
7521 * @see elm_layout_box_insert_at()
7522 * @see elm_layout_box_remove()
7526 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7528 * Insert child to layout box part before a reference object.
7530 * @param obj the layout object
7531 * @param part the box part to insert.
7532 * @param child the child object to insert into box.
7533 * @param reference another reference object to insert before in box.
7535 * Once the object is inserted, it will become child of the layout. Its
7536 * lifetime will be bound to the layout, whenever the layout dies the child
7537 * will be deleted automatically. One should use elm_layout_box_remove() to
7538 * make this layout forget about the object.
7540 * @see elm_layout_box_append()
7541 * @see elm_layout_box_prepend()
7542 * @see elm_layout_box_insert_before()
7543 * @see elm_layout_box_remove()
7547 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7549 * Insert child to layout box part at a given position.
7551 * @param obj the layout object
7552 * @param part the box part to insert.
7553 * @param child the child object to insert into box.
7554 * @param pos the numeric position >=0 to insert the child.
7556 * Once the object is inserted, it will become child of the layout. Its
7557 * lifetime will be bound to the layout, whenever the layout dies the child
7558 * will be deleted automatically. One should use elm_layout_box_remove() to
7559 * make this layout forget about the object.
7561 * @see elm_layout_box_append()
7562 * @see elm_layout_box_prepend()
7563 * @see elm_layout_box_insert_before()
7564 * @see elm_layout_box_remove()
7568 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7570 * Remove a child of the given part box.
7572 * @param obj The layout object
7573 * @param part The box part name to remove child.
7574 * @param child The object to remove from box.
7575 * @return The object that was being used, or NULL if not found.
7577 * The object will be removed from the box part and its lifetime will
7578 * not be handled by the layout anymore. This is equivalent to
7579 * elm_layout_content_unset() for box.
7581 * @see elm_layout_box_append()
7582 * @see elm_layout_box_remove_all()
7586 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7588 * Remove all child of the given part box.
7590 * @param obj The layout object
7591 * @param part The box part name to remove child.
7592 * @param clear If EINA_TRUE, then all objects will be deleted as
7593 * well, otherwise they will just be removed and will be
7594 * dangling on the canvas.
7596 * The objects will be removed from the box part and their lifetime will
7597 * not be handled by the layout anymore. This is equivalent to
7598 * elm_layout_box_remove() for all box children.
7600 * @see elm_layout_box_append()
7601 * @see elm_layout_box_remove()
7605 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7607 * Insert child to layout table part.
7609 * @param obj the layout object
7610 * @param part the box part to pack child.
7611 * @param child_obj the child object to pack into table.
7612 * @param col the column to which the child should be added. (>= 0)
7613 * @param row the row to which the child should be added. (>= 0)
7614 * @param colspan how many columns should be used to store this object. (>=
7616 * @param rowspan how many rows should be used to store this object. (>= 1)
7618 * Once the object is inserted, it will become child of the table. Its
7619 * lifetime will be bound to the layout, and whenever the layout dies the
7620 * child will be deleted automatically. One should use
7621 * elm_layout_table_remove() to make this layout forget about the object.
7623 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7624 * more space than a single cell. For instance, the following code:
7626 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7629 * Would result in an object being added like the following picture:
7631 * @image html layout_colspan.png
7632 * @image latex layout_colspan.eps width=\textwidth
7634 * @see elm_layout_table_unpack()
7635 * @see elm_layout_table_clear()
7639 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);
7641 * Unpack (remove) a child of the given part table.
7643 * @param obj The layout object
7644 * @param part The table part name to remove child.
7645 * @param child_obj The object to remove from table.
7646 * @return The object that was being used, or NULL if not found.
7648 * The object will be unpacked from the table part and its lifetime
7649 * will not be handled by the layout anymore. This is equivalent to
7650 * elm_layout_content_unset() for table.
7652 * @see elm_layout_table_pack()
7653 * @see elm_layout_table_clear()
7657 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7659 * Remove all child of the given part table.
7661 * @param obj The layout object
7662 * @param part The table part name to remove child.
7663 * @param clear If EINA_TRUE, then all objects will be deleted as
7664 * well, otherwise they will just be removed and will be
7665 * dangling on the canvas.
7667 * The objects will be removed from the table part and their lifetime will
7668 * not be handled by the layout anymore. This is equivalent to
7669 * elm_layout_table_unpack() for all table children.
7671 * @see elm_layout_table_pack()
7672 * @see elm_layout_table_unpack()
7676 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7678 * Get the edje layout
7680 * @param obj The layout object
7682 * @return A Evas_Object with the edje layout settings loaded
7683 * with function elm_layout_file_set
7685 * This returns the edje object. It is not expected to be used to then
7686 * swallow objects via edje_object_part_swallow() for example. Use
7687 * elm_layout_content_set() instead so child object handling and sizing is
7690 * @note This function should only be used if you really need to call some
7691 * low level Edje function on this edje object. All the common stuff (setting
7692 * text, emitting signals, hooking callbacks to signals, etc.) can be done
7693 * with proper elementary functions.
7695 * @see elm_object_signal_callback_add()
7696 * @see elm_object_signal_emit()
7697 * @see elm_object_text_part_set()
7698 * @see elm_layout_content_set()
7699 * @see elm_layout_box_append()
7700 * @see elm_layout_table_pack()
7701 * @see elm_layout_data_get()
7705 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7707 * Get the edje data from the given layout
7709 * @param obj The layout object
7710 * @param key The data key
7712 * @return The edje data string
7714 * This function fetches data specified inside the edje theme of this layout.
7715 * This function return NULL if data is not found.
7717 * In EDC this comes from a data block within the group block that @p
7718 * obj was loaded from. E.g.
7725 * item: "key1" "value1";
7726 * item: "key2" "value2";
7734 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7738 * @param obj The layout object
7740 * Manually forces a sizing re-evaluation. This is useful when the minimum
7741 * size required by the edje theme of this layout has changed. The change on
7742 * the minimum size required by the edje theme is not immediately reported to
7743 * the elementary layout, so one needs to call this function in order to tell
7744 * the widget (layout) that it needs to reevaluate its own size.
7746 * The minimum size of the theme is calculated based on minimum size of
7747 * parts, the size of elements inside containers like box and table, etc. All
7748 * of this can change due to state changes, and that's when this function
7751 * Also note that a standard signal of "size,eval" "elm" emitted from the
7752 * edje object will cause this to happen too.
7756 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
7757 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
7758 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7759 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7760 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
7761 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7762 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);
7763 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7765 * @def elm_layout_icon_set
7766 * Convienience macro to set the icon object in a layout that follows the
7767 * Elementary naming convention for its parts.
7771 #define elm_layout_icon_set(_ly, _obj) \
7774 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
7775 if ((_obj)) sig = "elm,state,icon,visible"; \
7776 else sig = "elm,state,icon,hidden"; \
7777 elm_object_signal_emit((_ly), sig, "elm"); \
7781 * @def elm_layout_icon_get
7782 * Convienience macro to get the icon object from a layout that follows the
7783 * Elementary naming convention for its parts.
7787 #define elm_layout_icon_get(_ly) \
7788 elm_layout_content_get((_ly), "elm.swallow.icon")
7791 * @def elm_layout_end_set
7792 * Convienience macro to set the end object in a layout that follows the
7793 * Elementary naming convention for its parts.
7797 #define elm_layout_end_set(_ly, _obj) \
7800 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
7801 if ((_obj)) sig = "elm,state,end,visible"; \
7802 else sig = "elm,state,end,hidden"; \
7803 elm_object_signal_emit((_ly), sig, "elm"); \
7807 * @def elm_layout_end_get
7808 * Convienience macro to get the end object in a layout that follows the
7809 * Elementary naming convention for its parts.
7813 #define elm_layout_end_get(_ly) \
7814 elm_layout_content_get((_ly), "elm.swallow.end")
7817 * @def elm_layout_label_set
7818 * Convienience macro to set the label in a layout that follows the
7819 * Elementary naming convention for its parts.
7822 * @deprecated use elm_object_text_* instead.
7824 #define elm_layout_label_set(_ly, _txt) \
7825 elm_layout_text_set((_ly), "elm.text", (_txt))
7828 * @def elm_layout_label_get
7829 * Convienience macro to get 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_get(_ly) \
7836 elm_layout_text_get((_ly), "elm.text")
7838 /* smart callbacks called:
7839 * "theme,changed" - when elm theme is changed.
7843 * @defgroup Notify Notify
7845 * @image html img/widget/notify/preview-00.png
7846 * @image latex img/widget/notify/preview-00.eps
7848 * Display a container in a particular region of the parent(top, bottom,
7849 * etc. A timeout can be set to automatically hide the notify. This is so
7850 * that, after an evas_object_show() on a notify object, if a timeout was set
7851 * on it, it will @b automatically get hidden after that time.
7853 * Signals that you can add callbacks for are:
7854 * @li "timeout" - when timeout happens on notify and it's hidden
7855 * @li "block,clicked" - when a click outside of the notify happens
7857 * @ref tutorial_notify show usage of the API.
7862 * @brief Possible orient values for notify.
7864 * This values should be used in conjunction to elm_notify_orient_set() to
7865 * set the position in which the notify should appear(relative to its parent)
7866 * and in conjunction with elm_notify_orient_get() to know where the notify
7869 typedef enum _Elm_Notify_Orient
7871 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
7872 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
7873 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
7874 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
7875 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
7876 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
7877 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
7878 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
7879 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
7880 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
7881 } Elm_Notify_Orient;
7883 * @brief Add a new notify to the parent
7885 * @param parent The parent object
7886 * @return The new object or NULL if it cannot be created
7888 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7890 * @brief Set the content of the notify widget
7892 * @param obj The notify object
7893 * @param content The content will be filled in this notify object
7895 * Once the content object is set, a previously set one will be deleted. If
7896 * you want to keep that old content object, use the
7897 * elm_notify_content_unset() function.
7899 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7901 * @brief Unset the content of the notify widget
7903 * @param obj The notify object
7904 * @return The content that was being used
7906 * Unparent and return the content object which was set for this widget
7908 * @see elm_notify_content_set()
7910 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7912 * @brief Return the content of the notify widget
7914 * @param obj The notify object
7915 * @return The content that is being used
7917 * @see elm_notify_content_set()
7919 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7921 * @brief Set the notify parent
7923 * @param obj The notify object
7924 * @param content The new parent
7926 * Once the parent object is set, a previously set one will be disconnected
7929 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7931 * @brief Get the notify parent
7933 * @param obj The notify object
7934 * @return The parent
7936 * @see elm_notify_parent_set()
7938 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7940 * @brief Set the orientation
7942 * @param obj The notify object
7943 * @param orient The new orientation
7945 * Sets the position in which the notify will appear in its parent.
7947 * @see @ref Elm_Notify_Orient for possible values.
7949 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
7951 * @brief Return the orientation
7952 * @param obj The notify object
7953 * @return The orientation of the notification
7955 * @see elm_notify_orient_set()
7956 * @see Elm_Notify_Orient
7958 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7960 * @brief Set the time interval after which the notify window is going to be
7963 * @param obj The notify object
7964 * @param time The timeout in seconds
7966 * This function sets a timeout and starts the timer controlling when the
7967 * notify is hidden. Since calling evas_object_show() on a notify restarts
7968 * the timer controlling when the notify is hidden, setting this before the
7969 * notify is shown will in effect mean starting the timer when the notify is
7972 * @note Set a value <= 0.0 to disable a running timer.
7974 * @note If the value > 0.0 and the notify is previously visible, the
7975 * timer will be started with this value, canceling any running timer.
7977 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7979 * @brief Return the timeout value (in seconds)
7980 * @param obj the notify object
7982 * @see elm_notify_timeout_set()
7984 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7986 * @brief Sets whether events should be passed to by a click outside
7989 * @param obj The notify object
7990 * @param repeats EINA_TRUE Events are repeats, else no
7992 * When true if the user clicks outside the window the events will be caught
7993 * by the others widgets, else the events are blocked.
7995 * @note The default value is EINA_TRUE.
7997 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
7999 * @brief Return true if events are repeat below the notify object
8000 * @param obj the notify object
8002 * @see elm_notify_repeat_events_set()
8004 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8010 * @defgroup Hover Hover
8012 * @image html img/widget/hover/preview-00.png
8013 * @image latex img/widget/hover/preview-00.eps
8015 * A Hover object will hover over its @p parent object at the @p target
8016 * location. Anything in the background will be given a darker coloring to
8017 * indicate that the hover object is on top (at the default theme). When the
8018 * hover is clicked it is dismissed(hidden), if the contents of the hover are
8019 * clicked that @b doesn't cause the hover to be dismissed.
8021 * @note The hover object will take up the entire space of @p target
8024 * Elementary has the following styles for the hover widget:
8028 * @li hoversel_vertical
8030 * The following are the available position for content:
8042 * Signals that you can add callbacks for are:
8043 * @li "clicked" - the user clicked the empty space in the hover to dismiss
8044 * @li "smart,changed" - a content object placed under the "smart"
8045 * policy was replaced to a new slot direction.
8047 * See @ref tutorial_hover for more information.
8051 typedef enum _Elm_Hover_Axis
8053 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8054 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8055 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8056 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8059 * @brief Adds a hover object to @p parent
8061 * @param parent The parent object
8062 * @return The hover object or NULL if one could not be created
8064 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8066 * @brief Sets the target object for the hover.
8068 * @param obj The hover object
8069 * @param target The object to center the hover onto. The hover
8071 * This function will cause the hover to be centered on the target object.
8073 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8075 * @brief Gets the target object for the hover.
8077 * @param obj The hover object
8078 * @param parent The object to locate the hover over.
8080 * @see elm_hover_target_set()
8082 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8084 * @brief Sets the parent object for the hover.
8086 * @param obj The hover object
8087 * @param parent The object to locate the hover over.
8089 * This function will cause the hover to take up the entire space that the
8090 * parent object fills.
8092 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8094 * @brief Gets the parent object for the hover.
8096 * @param obj The hover object
8097 * @return The parent object to locate the hover over.
8099 * @see elm_hover_parent_set()
8101 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8103 * @brief Sets the content of the hover object and the direction in which it
8106 * @param obj The hover object
8107 * @param swallow The direction that the object will be displayed
8108 * at. Accepted values are "left", "top-left", "top", "top-right",
8109 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8111 * @param content The content to place at @p swallow
8113 * Once the content object is set for a given direction, a previously
8114 * set one (on the same direction) will be deleted. If you want to
8115 * keep that old content object, use the elm_hover_content_unset()
8118 * All directions may have contents at the same time, except for
8119 * "smart". This is a special placement hint and its use case
8120 * independs of the calculations coming from
8121 * elm_hover_best_content_location_get(). Its use is for cases when
8122 * one desires only one hover content, but with a dinamic special
8123 * placement within the hover area. The content's geometry, whenever
8124 * it changes, will be used to decide on a best location not
8125 * extrapolating the hover's parent object view to show it in (still
8126 * being the hover's target determinant of its medium part -- move and
8127 * resize it to simulate finger sizes, for example). If one of the
8128 * directions other than "smart" are used, a previously content set
8129 * using it will be deleted, and vice-versa.
8131 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8133 * @brief Get the content of the hover object, in a given direction.
8135 * Return the content object which was set for this widget in the
8136 * @p swallow direction.
8138 * @param obj The hover object
8139 * @param swallow The direction that the object was display at.
8140 * @return The content that was being used
8142 * @see elm_hover_content_set()
8144 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8146 * @brief Unset the content of the hover object, in a given direction.
8148 * Unparent and return the content object set at @p swallow direction.
8150 * @param obj The hover object
8151 * @param swallow The direction that the object was display at.
8152 * @return The content that was being used.
8154 * @see elm_hover_content_set()
8156 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8158 * @brief Returns the best swallow location for content in the hover.
8160 * @param obj The hover object
8161 * @param pref_axis The preferred orientation axis for the hover object to use
8162 * @return The edje location to place content into the hover or @c
8165 * Best is defined here as the location at which there is the most available
8168 * @p pref_axis may be one of
8169 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8170 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8171 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8172 * - @c ELM_HOVER_AXIS_BOTH -- both
8174 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8175 * nescessarily be along the horizontal axis("left" or "right"). If
8176 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8177 * be along the vertical axis("top" or "bottom"). Chossing
8178 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8179 * returned position may be in either axis.
8181 * @see elm_hover_content_set()
8183 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8190 * @defgroup Entry Entry
8192 * @image html img/widget/entry/preview-00.png
8193 * @image latex img/widget/entry/preview-00.eps width=\textwidth
8194 * @image html img/widget/entry/preview-01.png
8195 * @image latex img/widget/entry/preview-01.eps width=\textwidth
8196 * @image html img/widget/entry/preview-02.png
8197 * @image latex img/widget/entry/preview-02.eps width=\textwidth
8198 * @image html img/widget/entry/preview-03.png
8199 * @image latex img/widget/entry/preview-03.eps width=\textwidth
8201 * An entry is a convenience widget which shows a box that the user can
8202 * enter text into. Entries by default don't scroll, so they grow to
8203 * accomodate the entire text, resizing the parent window as needed. This
8204 * can be changed with the elm_entry_scrollable_set() function.
8206 * They can also be single line or multi line (the default) and when set
8207 * to multi line mode they support text wrapping in any of the modes
8208 * indicated by #Elm_Wrap_Type.
8210 * Other features include password mode, filtering of inserted text with
8211 * elm_entry_text_filter_append() and related functions, inline "items" and
8212 * formatted markup text.
8214 * @section entry-markup Formatted text
8216 * The markup tags supported by the Entry are defined by the theme, but
8217 * even when writing new themes or extensions it's a good idea to stick to
8218 * a sane default, to maintain coherency and avoid application breakages.
8219 * Currently defined by the default theme are the following tags:
8220 * @li \<br\>: Inserts a line break.
8221 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8223 * @li \<tab\>: Inserts a tab.
8224 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8226 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8227 * @li \<link\>...\</link\>: Underlines the enclosed text.
8228 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8230 * @section entry-special Special markups
8232 * Besides those used to format text, entries support two special markup
8233 * tags used to insert clickable portions of text or items inlined within
8236 * @subsection entry-anchors Anchors
8238 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8239 * \</a\> tags and an event will be generated when this text is clicked,
8243 * This text is outside <a href=anc-01>but this one is an anchor</a>
8246 * The @c href attribute in the opening tag gives the name that will be
8247 * used to identify the anchor and it can be any valid utf8 string.
8249 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8250 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8251 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8252 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8255 * @subsection entry-items Items
8257 * Inlined in the text, any other @c Evas_Object can be inserted by using
8258 * \<item\> tags this way:
8261 * <item size=16x16 vsize=full href=emoticon/haha></item>
8264 * Just like with anchors, the @c href identifies each item, but these need,
8265 * in addition, to indicate their size, which is done using any one of
8266 * @c size, @c absize or @c relsize attributes. These attributes take their
8267 * value in the WxH format, where W is the width and H the height of the
8270 * @li absize: Absolute pixel size for the item. Whatever value is set will
8271 * be the item's size regardless of any scale value the object may have
8272 * been set to. The final line height will be adjusted to fit larger items.
8273 * @li size: Similar to @c absize, but it's adjusted to the scale value set
8275 * @li relsize: Size is adjusted for the item to fit within the current
8278 * Besides their size, items are specificed a @c vsize value that affects
8279 * how their final size and position are calculated. The possible values
8281 * @li ascent: Item will be placed within the line's baseline and its
8282 * ascent. That is, the height between the line where all characters are
8283 * positioned and the highest point in the line. For @c size and @c absize
8284 * items, the descent value will be added to the total line height to make
8285 * them fit. @c relsize items will be adjusted to fit within this space.
8286 * @li full: Items will be placed between the descent and ascent, or the
8287 * lowest point in the line and its highest.
8289 * The next image shows different configurations of items and how they
8290 * are the previously mentioned options affect their sizes. In all cases,
8291 * the green line indicates the ascent, blue for the baseline and red for
8294 * @image html entry_item.png
8295 * @image latex entry_item.eps width=\textwidth
8297 * And another one to show how size differs from absize. In the first one,
8298 * the scale value is set to 1.0, while the second one is using one of 2.0.
8300 * @image html entry_item_scale.png
8301 * @image latex entry_item_scale.eps width=\textwidth
8303 * After the size for an item is calculated, the entry will request an
8304 * object to place in its space. For this, the functions set with
8305 * elm_entry_item_provider_append() and related functions will be called
8306 * in order until one of them returns a @c non-NULL value. If no providers
8307 * are available, or all of them return @c NULL, then the entry falls back
8308 * to one of the internal defaults, provided the name matches with one of
8311 * All of the following are currently supported:
8314 * - emoticon/angry-shout
8315 * - emoticon/crazy-laugh
8316 * - emoticon/evil-laugh
8318 * - emoticon/goggle-smile
8320 * - emoticon/grumpy-smile
8322 * - emoticon/guilty-smile
8324 * - emoticon/half-smile
8325 * - emoticon/happy-panting
8327 * - emoticon/indifferent
8329 * - emoticon/knowing-grin
8331 * - emoticon/little-bit-sorry
8332 * - emoticon/love-lots
8334 * - emoticon/minimal-smile
8335 * - emoticon/not-happy
8336 * - emoticon/not-impressed
8338 * - emoticon/opensmile
8341 * - emoticon/squint-laugh
8342 * - emoticon/surprised
8343 * - emoticon/suspicious
8344 * - emoticon/tongue-dangling
8345 * - emoticon/tongue-poke
8347 * - emoticon/unhappy
8348 * - emoticon/very-sorry
8351 * - emoticon/worried
8354 * Alternatively, an item may reference an image by its path, using
8355 * the URI form @c file:///path/to/an/image.png and the entry will then
8356 * use that image for the item.
8358 * @section entry-files Loading and saving files
8360 * Entries have convinience functions to load text from a file and save
8361 * changes back to it after a short delay. The automatic saving is enabled
8362 * by default, but can be disabled with elm_entry_autosave_set() and files
8363 * can be loaded directly as plain text or have any markup in them
8364 * recognized. See elm_entry_file_set() for more details.
8366 * @section entry-signals Emitted signals
8368 * This widget emits the following signals:
8370 * @li "changed": The text within the entry was changed.
8371 * @li "changed,user": The text within the entry was changed because of user interaction.
8372 * @li "activated": The enter key was pressed on a single line entry.
8373 * @li "press": A mouse button has been pressed on the entry.
8374 * @li "longpressed": A mouse button has been pressed and held for a couple
8376 * @li "clicked": The entry has been clicked (mouse press and release).
8377 * @li "clicked,double": The entry has been double clicked.
8378 * @li "clicked,triple": The entry has been triple clicked.
8379 * @li "focused": The entry has received focus.
8380 * @li "unfocused": The entry has lost focus.
8381 * @li "selection,paste": A paste of the clipboard contents was requested.
8382 * @li "selection,copy": A copy of the selected text into the clipboard was
8384 * @li "selection,cut": A cut of the selected text into the clipboard was
8386 * @li "selection,start": A selection has begun and no previous selection
8388 * @li "selection,changed": The current selection has changed.
8389 * @li "selection,cleared": The current selection has been cleared.
8390 * @li "cursor,changed": The cursor has changed position.
8391 * @li "anchor,clicked": An anchor has been clicked. The event_info
8392 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8393 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8394 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8395 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8396 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8397 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8398 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8399 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8400 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8401 * @li "preedit,changed": The preedit string has changed.
8403 * @section entry-examples
8405 * An overview of the Entry API can be seen in @ref entry_example_01
8410 * @typedef Elm_Entry_Anchor_Info
8412 * The info sent in the callback for the "anchor,clicked" signals emitted
8415 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8417 * @struct _Elm_Entry_Anchor_Info
8419 * The info sent in the callback for the "anchor,clicked" signals emitted
8422 struct _Elm_Entry_Anchor_Info
8424 const char *name; /**< The name of the anchor, as stated in its href */
8425 int button; /**< The mouse button used to click on it */
8426 Evas_Coord x, /**< Anchor geometry, relative to canvas */
8427 y, /**< Anchor geometry, relative to canvas */
8428 w, /**< Anchor geometry, relative to canvas */
8429 h; /**< Anchor geometry, relative to canvas */
8432 * @typedef Elm_Entry_Filter_Cb
8433 * This callback type is used by entry filters to modify text.
8434 * @param data The data specified as the last param when adding the filter
8435 * @param entry The entry object
8436 * @param text A pointer to the location of the text being filtered. This data can be modified,
8437 * but any additional allocations must be managed by the user.
8438 * @see elm_entry_text_filter_append
8439 * @see elm_entry_text_filter_prepend
8441 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8444 * This adds an entry to @p parent object.
8446 * By default, entries are:
8450 * @li autosave is enabled
8452 * @param parent The parent object
8453 * @return The new object or NULL if it cannot be created
8455 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8457 * Sets the entry to single line mode.
8459 * In single line mode, entries don't ever wrap when the text reaches the
8460 * edge, and instead they keep growing horizontally. Pressing the @c Enter
8461 * key will generate an @c "activate" event instead of adding a new line.
8463 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8464 * and pressing enter will break the text into a different line
8465 * without generating any events.
8467 * @param obj The entry object
8468 * @param single_line If true, the text in the entry
8469 * will be on a single line.
8471 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8473 * Gets whether the entry is set to be single line.
8475 * @param obj The entry object
8476 * @return single_line If true, the text in the entry is set to display
8479 * @see elm_entry_single_line_set()
8481 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8483 * Sets the entry to password mode.
8485 * In password mode, entries are implicitly single line and the display of
8486 * any text in them is replaced with asterisks (*).
8488 * @param obj The entry object
8489 * @param password If true, password mode is enabled.
8491 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8493 * Gets whether the entry is set to password mode.
8495 * @param obj The entry object
8496 * @return If true, the entry is set to display all characters
8499 * @see elm_entry_password_set()
8501 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8503 * This sets the text displayed within the entry to @p entry.
8505 * @param obj The entry object
8506 * @param entry The text to be displayed
8508 * @deprecated Use elm_object_text_set() instead.
8510 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8512 * This returns the text currently shown in object @p entry.
8513 * See also elm_entry_entry_set().
8515 * @param obj The entry object
8516 * @return The currently displayed text or NULL on failure
8518 * @deprecated Use elm_object_text_get() instead.
8520 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8522 * Appends @p entry to the text of the entry.
8524 * Adds the text in @p entry to the end of any text already present in the
8527 * The appended text is subject to any filters set for the widget.
8529 * @param obj The entry object
8530 * @param entry The text to be displayed
8532 * @see elm_entry_text_filter_append()
8534 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8536 * Gets whether the entry is empty.
8538 * Empty means no text at all. If there are any markup tags, like an item
8539 * tag for which no provider finds anything, and no text is displayed, this
8540 * function still returns EINA_FALSE.
8542 * @param obj The entry object
8543 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8545 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8547 * Gets any selected text within the entry.
8549 * If there's any selected text in the entry, this function returns it as
8550 * a string in markup format. NULL is returned if no selection exists or
8551 * if an error occurred.
8553 * The returned value points to an internal string and should not be freed
8554 * or modified in any way. If the @p entry object is deleted or its
8555 * contents are changed, the returned pointer should be considered invalid.
8557 * @param obj The entry object
8558 * @return The selected text within the entry or NULL on failure
8560 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8562 * Inserts the given text into the entry at the current cursor position.
8564 * This inserts text at the cursor position as if it was typed
8565 * by the user (note that this also allows markup which a user
8566 * can't just "type" as it would be converted to escaped text, so this
8567 * call can be used to insert things like emoticon items or bold push/pop
8568 * tags, other font and color change tags etc.)
8570 * If any selection exists, it will be replaced by the inserted text.
8572 * The inserted text is subject to any filters set for the widget.
8574 * @param obj The entry object
8575 * @param entry The text to insert
8577 * @see elm_entry_text_filter_append()
8579 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8581 * Set the line wrap type to use on multi-line entries.
8583 * Sets the wrap type used by the entry to any of the specified in
8584 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8585 * line (without inserting a line break or paragraph separator) when it
8586 * reaches the far edge of the widget.
8588 * Note that this only makes sense for multi-line entries. A widget set
8589 * to be single line will never wrap.
8591 * @param obj The entry object
8592 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8594 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8596 * Gets the wrap mode the entry was set to use.
8598 * @param obj The entry object
8601 * @see also elm_entry_line_wrap_set()
8603 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8605 * Sets if the entry is to be editable or not.
8607 * By default, entries are editable and when focused, any text input by the
8608 * user will be inserted at the current cursor position. But calling this
8609 * function with @p editable as EINA_FALSE will prevent the user from
8610 * inputting text into the entry.
8612 * The only way to change the text of a non-editable entry is to use
8613 * elm_object_text_set(), elm_entry_entry_insert() and other related
8616 * @param obj The entry object
8617 * @param editable If EINA_TRUE, user input will be inserted in the entry,
8618 * if not, the entry is read-only and no user input is allowed.
8620 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8622 * Gets whether the entry is editable or not.
8624 * @param obj The entry object
8625 * @return If true, the entry is editable by the user.
8626 * If false, it is not editable by the user
8628 * @see elm_entry_editable_set()
8630 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8632 * This drops any existing text selection within the entry.
8634 * @param obj The entry object
8636 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8638 * This selects all text within the entry.
8640 * @param obj The entry object
8642 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8644 * This moves the cursor one place to the right within the entry.
8646 * @param obj The entry object
8647 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8649 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8651 * This moves the cursor one place to the left within the entry.
8653 * @param obj The entry object
8654 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8656 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8658 * This moves the cursor one line up within the entry.
8660 * @param obj The entry object
8661 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8663 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8665 * This moves the cursor one line down within the entry.
8667 * @param obj The entry object
8668 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8670 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8672 * This moves the cursor to the beginning of the entry.
8674 * @param obj The entry object
8676 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8678 * This moves the cursor to the end of the entry.
8680 * @param obj The entry object
8682 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8684 * This moves the cursor to the beginning of the current line.
8686 * @param obj The entry object
8688 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8690 * This moves the cursor to the end of the current line.
8692 * @param obj The entry object
8694 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8696 * This begins a selection within the entry as though
8697 * the user were holding down the mouse button to make a selection.
8699 * @param obj The entry object
8701 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8703 * This ends a selection within the entry as though
8704 * the user had just released the mouse button while making a selection.
8706 * @param obj The entry object
8708 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8710 * Gets whether a format node exists at the current cursor position.
8712 * A format node is anything that defines how the text is rendered. It can
8713 * be a visible format node, such as a line break or a paragraph separator,
8714 * or an invisible one, such as bold begin or end tag.
8715 * This function returns whether any format node exists at the current
8718 * @param obj The entry object
8719 * @return EINA_TRUE if the current cursor position contains a format node,
8720 * EINA_FALSE otherwise.
8722 * @see elm_entry_cursor_is_visible_format_get()
8724 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8726 * Gets if the current cursor position holds a visible format node.
8728 * @param obj The entry object
8729 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8730 * if it's an invisible one or no format exists.
8732 * @see elm_entry_cursor_is_format_get()
8734 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8736 * Gets the character pointed by the cursor at its current position.
8738 * This function returns a string with the utf8 character stored at the
8739 * current cursor position.
8740 * Only the text is returned, any format that may exist will not be part
8741 * of the return value.
8743 * @param obj The entry object
8744 * @return The text pointed by the cursors.
8746 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8748 * This function returns the geometry of the cursor.
8750 * It's useful if you want to draw something on the cursor (or where it is),
8751 * or for example in the case of scrolled entry where you want to show the
8754 * @param obj The entry object
8755 * @param x returned geometry
8756 * @param y returned geometry
8757 * @param w returned geometry
8758 * @param h returned geometry
8759 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8761 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);
8763 * Sets the cursor position in the entry to the given value
8765 * The value in @p pos is the index of the character position within the
8766 * contents of the string as returned by elm_entry_cursor_pos_get().
8768 * @param obj The entry object
8769 * @param pos The position of the cursor
8771 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8773 * Retrieves the current position of the cursor in the entry
8775 * @param obj The entry object
8776 * @return The cursor position
8778 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8780 * This executes a "cut" action on the selected text in the entry.
8782 * @param obj The entry object
8784 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
8786 * This executes a "copy" action on the selected text in the entry.
8788 * @param obj The entry object
8790 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
8792 * This executes a "paste" action in the entry.
8794 * @param obj The entry object
8796 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
8798 * This clears and frees the items in a entry's contextual (longpress)
8801 * @param obj The entry object
8803 * @see elm_entry_context_menu_item_add()
8805 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8807 * This adds an item to the entry's contextual menu.
8809 * A longpress on an entry will make the contextual menu show up, if this
8810 * hasn't been disabled with elm_entry_context_menu_disabled_set().
8811 * By default, this menu provides a few options like enabling selection mode,
8812 * which is useful on embedded devices that need to be explicit about it,
8813 * and when a selection exists it also shows the copy and cut actions.
8815 * With this function, developers can add other options to this menu to
8816 * perform any action they deem necessary.
8818 * @param obj The entry object
8819 * @param label The item's text label
8820 * @param icon_file The item's icon file
8821 * @param icon_type The item's icon type
8822 * @param func The callback to execute when the item is clicked
8823 * @param data The data to associate with the item for related functions
8825 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);
8827 * This disables the entry's contextual (longpress) menu.
8829 * @param obj The entry object
8830 * @param disabled If true, the menu is disabled
8832 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8834 * This returns whether the entry's contextual (longpress) menu is
8837 * @param obj The entry object
8838 * @return If true, the menu is disabled
8840 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8842 * This appends a custom item provider to the list for that entry
8844 * This appends the given callback. The list is walked from beginning to end
8845 * with each function called given the item href string in the text. If the
8846 * function returns an object handle other than NULL (it should create an
8847 * object to do this), then this object is used to replace that item. If
8848 * not the next provider is called until one provides an item object, or the
8849 * default provider in entry does.
8851 * @param obj The entry object
8852 * @param func The function called to provide the item object
8853 * @param data The data passed to @p func
8855 * @see @ref entry-items
8857 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);
8859 * This prepends a custom item provider to the list for that entry
8861 * This prepends the given callback. See elm_entry_item_provider_append() for
8864 * @param obj The entry object
8865 * @param func The function called to provide the item object
8866 * @param data The data passed to @p func
8868 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);
8870 * This removes a custom item provider to the list for that entry
8872 * This removes 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_remove(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
8881 * Append a filter function for text inserted in the entry
8883 * Append the given callback to the list. This functions will be called
8884 * whenever any text is inserted into the entry, with the text to be inserted
8885 * as a parameter. The callback function is free to alter the text in any way
8886 * it wants, but it must remember to free the given pointer and update it.
8887 * If the new text is to be discarded, the function can free it and set its
8888 * text parameter to NULL. This will also prevent any following filters from
8891 * @param obj The entry object
8892 * @param func The function to use as text filter
8893 * @param data User data to pass to @p func
8895 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8897 * Prepend a filter function for text insdrted in the entry
8899 * Prepend the given callback to the list. See elm_entry_text_filter_append()
8900 * for more information
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_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8908 * Remove a filter from the list
8910 * Removes the given callback from the filter list. See
8911 * elm_entry_text_filter_append() for more information.
8913 * @param obj The entry object
8914 * @param func The filter function to remove
8915 * @param data The user data passed when adding the function
8917 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8919 * This converts a markup (HTML-like) string into UTF-8.
8921 * The returned string is a malloc'ed buffer and it should be freed when
8922 * not needed anymore.
8924 * @param s The string (in markup) to be converted
8925 * @return The converted string (in UTF-8). It should be freed.
8927 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8929 * This converts a UTF-8 string into markup (HTML-like).
8931 * The returned string is a malloc'ed buffer and it should be freed when
8932 * not needed anymore.
8934 * @param s The string (in UTF-8) to be converted
8935 * @return The converted string (in markup). It should be freed.
8937 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8939 * This sets the file (and implicitly loads it) for the text to display and
8940 * then edit. All changes are written back to the file after a short delay if
8941 * the entry object is set to autosave (which is the default).
8943 * If the entry had any other file set previously, any changes made to it
8944 * will be saved if the autosave feature is enabled, otherwise, the file
8945 * will be silently discarded and any non-saved changes will be lost.
8947 * @param obj The entry object
8948 * @param file The path to the file to load and save
8949 * @param format The file format
8951 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
8953 * Gets the file being edited by the entry.
8955 * This function can be used to retrieve any file set on the entry for
8956 * edition, along with the format used to load and save it.
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_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
8964 * This function writes any changes made to the file set with
8965 * elm_entry_file_set()
8967 * @param obj The entry object
8969 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
8971 * This sets the entry object to 'autosave' the loaded text file or not.
8973 * @param obj The entry object
8974 * @param autosave Autosave the loaded file or not
8976 * @see elm_entry_file_set()
8978 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
8980 * This gets the entry object's 'autosave' status.
8982 * @param obj The entry object
8983 * @return Autosave the loaded file or not
8985 * @see elm_entry_file_set()
8987 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8989 * Control pasting of text and images for the widget.
8991 * Normally the entry allows both text and images to be pasted. By setting
8992 * textonly to be true, this prevents images from being pasted.
8994 * Note this only changes the behaviour of text.
8996 * @param obj The entry object
8997 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
9000 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
9002 * Getting elm_entry text paste/drop mode.
9004 * In textonly mode, only text may be pasted or dropped into the widget.
9006 * @param obj The entry object
9007 * @return If the widget only accepts text from pastes.
9009 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9011 * Enable or disable scrolling in entry
9013 * Normally the entry is not scrollable unless you enable it with this call.
9015 * @param obj The entry object
9016 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9018 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9020 * Get the scrollable state of the entry
9022 * Normally the entry is not scrollable. This gets the scrollable state
9023 * of the entry. See elm_entry_scrollable_set() for more information.
9025 * @param obj The entry object
9026 * @return The scrollable state
9028 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
9030 * This sets a widget to be displayed to the left of a scrolled entry.
9032 * @param obj The scrolled entry object
9033 * @param icon The widget to display on the left side of the scrolled
9036 * @note A previously set widget will be destroyed.
9037 * @note If the object being set does not have minimum size hints set,
9038 * it won't get properly displayed.
9040 * @see elm_entry_end_set()
9042 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9044 * Gets the leftmost widget of the scrolled entry. This object is
9045 * owned by the scrolled entry and should not be modified.
9047 * @param obj The scrolled entry object
9048 * @return the left widget inside the scroller
9050 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9052 * Unset the leftmost widget of the scrolled entry, unparenting and
9055 * @param obj The scrolled entry object
9056 * @return the previously set icon sub-object of this entry, on
9059 * @see elm_entry_icon_set()
9061 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9063 * Sets the visibility of the left-side widget of the scrolled entry,
9064 * set by elm_entry_icon_set().
9066 * @param obj The scrolled entry object
9067 * @param setting EINA_TRUE if the object should be displayed,
9068 * EINA_FALSE if not.
9070 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9072 * This sets a widget to be displayed to the end of a scrolled entry.
9074 * @param obj The scrolled entry object
9075 * @param end The widget to display on the right side of the scrolled
9078 * @note A previously set widget will be destroyed.
9079 * @note If the object being set does not have minimum size hints set,
9080 * it won't get properly displayed.
9082 * @see elm_entry_icon_set
9084 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9086 * Gets the endmost widget of the scrolled entry. This object is owned
9087 * by the scrolled entry and should not be modified.
9089 * @param obj The scrolled entry object
9090 * @return the right widget inside the scroller
9092 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9094 * Unset the endmost widget of the scrolled entry, unparenting and
9097 * @param obj The scrolled entry object
9098 * @return the previously set icon sub-object of this entry, on
9101 * @see elm_entry_icon_set()
9103 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9105 * Sets the visibility of the end widget of the scrolled entry, set by
9106 * elm_entry_end_set().
9108 * @param obj The scrolled entry object
9109 * @param setting EINA_TRUE if the object should be displayed,
9110 * EINA_FALSE if not.
9112 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9114 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9117 * Setting an entry to single-line mode with elm_entry_single_line_set()
9118 * will automatically disable the display of scrollbars when the entry
9119 * moves inside its scroller.
9121 * @param obj The scrolled entry object
9122 * @param h The horizontal scrollbar policy to apply
9123 * @param v The vertical scrollbar policy to apply
9125 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9127 * This enables/disables bouncing within the entry.
9129 * This function sets whether the entry will bounce when scrolling reaches
9130 * the end of the contained entry.
9132 * @param obj The scrolled entry object
9133 * @param h The horizontal bounce state
9134 * @param v The vertical bounce state
9136 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9138 * Get the bounce mode
9140 * @param obj The Entry object
9141 * @param h_bounce Allow bounce horizontally
9142 * @param v_bounce Allow bounce vertically
9144 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9146 /* pre-made filters for entries */
9148 * @typedef Elm_Entry_Filter_Limit_Size
9150 * Data for the elm_entry_filter_limit_size() entry filter.
9152 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9154 * @struct _Elm_Entry_Filter_Limit_Size
9156 * Data for the elm_entry_filter_limit_size() entry filter.
9158 struct _Elm_Entry_Filter_Limit_Size
9160 int max_char_count; /**< The maximum number of characters allowed. */
9161 int max_byte_count; /**< The maximum number of bytes allowed*/
9164 * Filter inserted text based on user defined character and byte limits
9166 * Add this filter to an entry to limit the characters that it will accept
9167 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9168 * The funtion works on the UTF-8 representation of the string, converting
9169 * it from the set markup, thus not accounting for any format in it.
9171 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9172 * it as data when setting the filter. In it, it's possible to set limits
9173 * by character count or bytes (any of them is disabled if 0), and both can
9174 * be set at the same time. In that case, it first checks for characters,
9177 * The function will cut the inserted text in order to allow only the first
9178 * number of characters that are still allowed. The cut is made in
9179 * characters, even when limiting by bytes, in order to always contain
9180 * valid ones and avoid half unicode characters making it in.
9182 * This filter, like any others, does not apply when setting the entry text
9183 * directly with elm_object_text_set() (or the deprecated
9184 * elm_entry_entry_set()).
9186 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9188 * @typedef Elm_Entry_Filter_Accept_Set
9190 * Data for the elm_entry_filter_accept_set() entry filter.
9192 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9194 * @struct _Elm_Entry_Filter_Accept_Set
9196 * Data for the elm_entry_filter_accept_set() entry filter.
9198 struct _Elm_Entry_Filter_Accept_Set
9200 const char *accepted; /**< Set of characters accepted in the entry. */
9201 const char *rejected; /**< Set of characters rejected from the entry. */
9204 * Filter inserted text based on accepted or rejected sets of characters
9206 * Add this filter to an entry to restrict the set of accepted characters
9207 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9208 * This structure contains both accepted and rejected sets, but they are
9209 * mutually exclusive.
9211 * The @c accepted set takes preference, so if it is set, the filter will
9212 * only work based on the accepted characters, ignoring anything in the
9213 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9215 * In both cases, the function filters by matching utf8 characters to the
9216 * raw markup text, so it can be used to remove formatting tags.
9218 * This filter, like any others, does not apply when setting the entry text
9219 * directly with elm_object_text_set() (or the deprecated
9220 * elm_entry_entry_set()).
9222 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9227 /* composite widgets - these basically put together basic widgets above
9228 * in convenient packages that do more than basic stuff */
9232 * @defgroup Anchorview Anchorview
9234 * @image html img/widget/anchorview/preview-00.png
9235 * @image latex img/widget/anchorview/preview-00.eps
9237 * Anchorview is for displaying text that contains markup with anchors
9238 * like <c>\<a href=1234\>something\</\></c> in it.
9240 * Besides being styled differently, the anchorview widget provides the
9241 * necessary functionality so that clicking on these anchors brings up a
9242 * popup with user defined content such as "call", "add to contacts" or
9243 * "open web page". This popup is provided using the @ref Hover widget.
9245 * This widget is very similar to @ref Anchorblock, so refer to that
9246 * widget for an example. The only difference Anchorview has is that the
9247 * widget is already provided with scrolling functionality, so if the
9248 * text set to it is too large to fit in the given space, it will scroll,
9249 * whereas the @ref Anchorblock widget will keep growing to ensure all the
9250 * text can be displayed.
9252 * This widget emits the following signals:
9253 * @li "anchor,clicked": will be called when an anchor is clicked. The
9254 * @p event_info parameter on the callback will be a pointer of type
9255 * ::Elm_Entry_Anchorview_Info.
9257 * See @ref Anchorblock for an example on how to use both of them.
9266 * @typedef Elm_Entry_Anchorview_Info
9268 * The info sent in the callback for "anchor,clicked" signals emitted by
9269 * the Anchorview widget.
9271 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9273 * @struct _Elm_Entry_Anchorview_Info
9275 * The info sent in the callback for "anchor,clicked" signals emitted by
9276 * the Anchorview widget.
9278 struct _Elm_Entry_Anchorview_Info
9280 const char *name; /**< Name of the anchor, as indicated in its href
9282 int button; /**< The mouse button used to click on it */
9283 Evas_Object *hover; /**< The hover object to use for the popup */
9285 Evas_Coord x, y, w, h;
9286 } anchor, /**< Geometry selection of text used as anchor */
9287 hover_parent; /**< Geometry of the object used as parent by the
9289 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9290 for content on the left side of
9291 the hover. Before calling the
9292 callback, the widget will make the
9293 necessary calculations to check
9294 which sides are fit to be set with
9295 content, based on the position the
9296 hover is activated and its distance
9297 to the edges of its parent object
9299 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9300 the right side of the hover.
9301 See @ref hover_left */
9302 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9303 of the hover. See @ref hover_left */
9304 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9305 below the hover. See @ref
9309 * Add a new Anchorview object
9311 * @param parent The parent object
9312 * @return The new object or NULL if it cannot be created
9314 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9316 * Set the text to show in the anchorview
9318 * Sets the text of the anchorview to @p text. This text can include markup
9319 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9320 * text that will be specially styled and react to click events, ended with
9321 * either of \</a\> or \</\>. When clicked, the anchor will emit an
9322 * "anchor,clicked" signal that you can attach a callback to with
9323 * evas_object_smart_callback_add(). The name of the anchor given in the
9324 * event info struct will be the one set in the href attribute, in this
9327 * Other markup can be used to style the text in different ways, but it's
9328 * up to the style defined in the theme which tags do what.
9329 * @deprecated use elm_object_text_set() instead.
9331 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9333 * Get the markup text set for the anchorview
9335 * Retrieves the text set on the anchorview, with markup tags included.
9337 * @param obj The anchorview object
9338 * @return The markup text set or @c NULL if nothing was set or an error
9340 * @deprecated use elm_object_text_set() instead.
9342 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9344 * Set the parent of the hover popup
9346 * Sets the parent object to use by the hover created by the anchorview
9347 * when an anchor is clicked. See @ref Hover for more details on this.
9348 * If no parent is set, the same anchorview object will be used.
9350 * @param obj The anchorview object
9351 * @param parent The object to use as parent for the hover
9353 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9355 * Get the parent of the hover popup
9357 * Get the object used as parent for the hover created by the anchorview
9358 * widget. See @ref Hover for more details on this.
9360 * @param obj The anchorview object
9361 * @return The object used as parent for the hover, NULL if none is set.
9363 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9365 * Set the style that the hover should use
9367 * When creating the popup hover, anchorview will request that it's
9368 * themed according to @p style.
9370 * @param obj The anchorview object
9371 * @param style The style to use for the underlying hover
9373 * @see elm_object_style_set()
9375 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9377 * Get the style that the hover should use
9379 * Get the style the hover created by anchorview will use.
9381 * @param obj The anchorview object
9382 * @return The style to use by the hover. NULL means the default is used.
9384 * @see elm_object_style_set()
9386 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9388 * Ends the hover popup in the anchorview
9390 * When an anchor is clicked, the anchorview widget will create a hover
9391 * object to use as a popup with user provided content. This function
9392 * terminates this popup, returning the anchorview to its normal state.
9394 * @param obj The anchorview object
9396 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9398 * Set bouncing behaviour when the scrolled content reaches an edge
9400 * Tell the internal scroller object whether it should bounce or not
9401 * when it reaches the respective edges for each axis.
9403 * @param obj The anchorview object
9404 * @param h_bounce Whether to bounce or not in the horizontal axis
9405 * @param v_bounce Whether to bounce or not in the vertical axis
9407 * @see elm_scroller_bounce_set()
9409 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9411 * Get the set bouncing behaviour of the internal scroller
9413 * Get whether the internal scroller should bounce when the edge of each
9414 * axis is reached scrolling.
9416 * @param obj The anchorview object
9417 * @param h_bounce Pointer where to store the bounce state of the horizontal
9419 * @param v_bounce Pointer where to store the bounce state of the vertical
9422 * @see elm_scroller_bounce_get()
9424 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9426 * Appends a custom item provider to the given anchorview
9428 * Appends the given function to the list of items providers. This list is
9429 * called, one function at a time, with the given @p data pointer, the
9430 * anchorview object and, in the @p item parameter, the item name as
9431 * referenced in its href string. Following functions in the list will be
9432 * called in order until one of them returns something different to NULL,
9433 * which should be an Evas_Object which will be used in place of the item
9436 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9437 * href=item/name\>\</item\>
9439 * @param obj The anchorview object
9440 * @param func The function to add to the list of providers
9441 * @param data User data that will be passed to the callback function
9443 * @see elm_entry_item_provider_append()
9445 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);
9447 * Prepend a custom item provider to the given anchorview
9449 * Like elm_anchorview_item_provider_append(), but it adds the function
9450 * @p func to the beginning of the list, instead of the end.
9452 * @param obj The anchorview object
9453 * @param func The function to add to the list of providers
9454 * @param data User data that will be passed to the callback function
9456 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);
9458 * Remove a custom item provider from the list of the given anchorview
9460 * Removes the function and data pairing that matches @p func and @p data.
9461 * That is, unless the same function and same user data are given, the
9462 * function will not be removed from the list. This allows us to add the
9463 * same callback several times, with different @p data pointers and be
9464 * able to remove them later without conflicts.
9466 * @param obj The anchorview object
9467 * @param func The function to remove from the list
9468 * @param data The data matching the function to remove from the list
9470 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);
9477 * @defgroup Anchorblock Anchorblock
9479 * @image html img/widget/anchorblock/preview-00.png
9480 * @image latex img/widget/anchorblock/preview-00.eps
9482 * Anchorblock is for displaying text that contains markup with anchors
9483 * like <c>\<a href=1234\>something\</\></c> in it.
9485 * Besides being styled differently, the anchorblock widget provides the
9486 * necessary functionality so that clicking on these anchors brings up a
9487 * popup with user defined content such as "call", "add to contacts" or
9488 * "open web page". This popup is provided using the @ref Hover widget.
9490 * This widget emits the following signals:
9491 * @li "anchor,clicked": will be called when an anchor is clicked. The
9492 * @p event_info parameter on the callback will be a pointer of type
9493 * ::Elm_Entry_Anchorblock_Info.
9499 * Since examples are usually better than plain words, we might as well
9500 * try @ref tutorial_anchorblock_example "one".
9503 * @addtogroup Anchorblock
9507 * @typedef Elm_Entry_Anchorblock_Info
9509 * The info sent in the callback for "anchor,clicked" signals emitted by
9510 * the Anchorblock widget.
9512 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9514 * @struct _Elm_Entry_Anchorblock_Info
9516 * The info sent in the callback for "anchor,clicked" signals emitted by
9517 * the Anchorblock widget.
9519 struct _Elm_Entry_Anchorblock_Info
9521 const char *name; /**< Name of the anchor, as indicated in its href
9523 int button; /**< The mouse button used to click on it */
9524 Evas_Object *hover; /**< The hover object to use for the popup */
9526 Evas_Coord x, y, w, h;
9527 } anchor, /**< Geometry selection of text used as anchor */
9528 hover_parent; /**< Geometry of the object used as parent by the
9530 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9531 for content on the left side of
9532 the hover. Before calling the
9533 callback, the widget will make the
9534 necessary calculations to check
9535 which sides are fit to be set with
9536 content, based on the position the
9537 hover is activated and its distance
9538 to the edges of its parent object
9540 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9541 the right side of the hover.
9542 See @ref hover_left */
9543 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9544 of the hover. See @ref hover_left */
9545 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9546 below the hover. See @ref
9550 * Add a new Anchorblock object
9552 * @param parent The parent object
9553 * @return The new object or NULL if it cannot be created
9555 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9557 * Set the text to show in the anchorblock
9559 * Sets the text of the anchorblock to @p text. This text can include markup
9560 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9561 * of text that will be specially styled and react to click events, ended
9562 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9563 * "anchor,clicked" signal that you can attach a callback to with
9564 * evas_object_smart_callback_add(). The name of the anchor given in the
9565 * event info struct will be the one set in the href attribute, in this
9568 * Other markup can be used to style the text in different ways, but it's
9569 * up to the style defined in the theme which tags do what.
9570 * @deprecated use elm_object_text_set() instead.
9572 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9574 * Get the markup text set for the anchorblock
9576 * Retrieves the text set on the anchorblock, with markup tags included.
9578 * @param obj The anchorblock object
9579 * @return The markup text set or @c NULL if nothing was set or an error
9581 * @deprecated use elm_object_text_set() instead.
9583 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9585 * Set the parent of the hover popup
9587 * Sets the parent object to use by the hover created by the anchorblock
9588 * when an anchor is clicked. See @ref Hover for more details on this.
9590 * @param obj The anchorblock object
9591 * @param parent The object to use as parent for the hover
9593 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9595 * Get the parent of the hover popup
9597 * Get the object used as parent for the hover created by the anchorblock
9598 * widget. See @ref Hover for more details on this.
9599 * If no parent is set, the same anchorblock object will be used.
9601 * @param obj The anchorblock object
9602 * @return The object used as parent for the hover, NULL if none is set.
9604 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9606 * Set the style that the hover should use
9608 * When creating the popup hover, anchorblock will request that it's
9609 * themed according to @p style.
9611 * @param obj The anchorblock object
9612 * @param style The style to use for the underlying hover
9614 * @see elm_object_style_set()
9616 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9618 * Get the style that the hover should use
9620 * Get the style the hover created by anchorblock will use.
9622 * @param obj The anchorblock object
9623 * @return The style to use by the hover. NULL means the default is used.
9625 * @see elm_object_style_set()
9627 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9629 * Ends the hover popup in the anchorblock
9631 * When an anchor is clicked, the anchorblock widget will create a hover
9632 * object to use as a popup with user provided content. This function
9633 * terminates this popup, returning the anchorblock to its normal state.
9635 * @param obj The anchorblock object
9637 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9639 * Appends a custom item provider to the given anchorblock
9641 * Appends the given function to the list of items providers. This list is
9642 * called, one function at a time, with the given @p data pointer, the
9643 * anchorblock object and, in the @p item parameter, the item name as
9644 * referenced in its href string. Following functions in the list will be
9645 * called in order until one of them returns something different to NULL,
9646 * which should be an Evas_Object which will be used in place of the item
9649 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9650 * href=item/name\>\</item\>
9652 * @param obj The anchorblock object
9653 * @param func The function to add to the list of providers
9654 * @param data User data that will be passed to the callback function
9656 * @see elm_entry_item_provider_append()
9658 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);
9660 * Prepend a custom item provider to the given anchorblock
9662 * Like elm_anchorblock_item_provider_append(), but it adds the function
9663 * @p func to the beginning of the list, instead of the end.
9665 * @param obj The anchorblock object
9666 * @param func The function to add to the list of providers
9667 * @param data User data that will be passed to the callback function
9669 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);
9671 * Remove a custom item provider from the list of the given anchorblock
9673 * Removes the function and data pairing that matches @p func and @p data.
9674 * That is, unless the same function and same user data are given, the
9675 * function will not be removed from the list. This allows us to add the
9676 * same callback several times, with different @p data pointers and be
9677 * able to remove them later without conflicts.
9679 * @param obj The anchorblock object
9680 * @param func The function to remove from the list
9681 * @param data The data matching the function to remove from the list
9683 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);
9689 * @defgroup Bubble Bubble
9691 * @image html img/widget/bubble/preview-00.png
9692 * @image html img/widget/bubble/preview-01.png
9693 * @image html img/widget/bubble/preview-02.png
9695 * @brief The Bubble is a widget to show text similarly to how speech is
9696 * represented in comics.
9698 * The bubble widget contains 5 important visual elements:
9699 * @li The frame is a rectangle with rounded rectangles and an "arrow".
9700 * @li The @p icon is an image to which the frame's arrow points to.
9701 * @li The @p label is a text which appears to the right of the icon if the
9702 * corner is "top_left" or "bottom_left" and is right aligned to the frame
9704 * @li The @p info is a text which appears to the right of the label. Info's
9705 * font is of a ligther color than label.
9706 * @li The @p content is an evas object that is shown inside the frame.
9708 * The position of the arrow, icon, label and info depends on which corner is
9709 * selected. The four available corners are:
9710 * @li "top_left" - Default
9713 * @li "bottom_right"
9715 * Signals that you can add callbacks for are:
9716 * @li "clicked" - This is called when a user has clicked the bubble.
9718 * For an example of using a buble see @ref bubble_01_example_page "this".
9723 * Add a new bubble to the parent
9725 * @param parent The parent object
9726 * @return The new object or NULL if it cannot be created
9728 * This function adds a text bubble to the given parent evas object.
9730 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9732 * Set the label of the bubble
9734 * @param obj The bubble object
9735 * @param label The string to set in the label
9737 * This function sets the title of the bubble. Where this appears depends on
9738 * the selected corner.
9739 * @deprecated use elm_object_text_set() instead.
9741 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9743 * Get the label of the bubble
9745 * @param obj The bubble object
9746 * @return The string of set in the label
9748 * This function gets the title of the bubble.
9749 * @deprecated use elm_object_text_set() instead.
9751 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9753 * Set the info of the bubble
9755 * @param obj The bubble object
9756 * @param info The given info about the bubble
9758 * This function sets the info of the bubble. Where this appears depends on
9759 * the selected corner.
9760 * @deprecated use elm_object_text_set() instead.
9762 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
9764 * Get the info of the bubble
9766 * @param obj The bubble object
9768 * @return The "info" string of the bubble
9770 * This function gets the info text.
9771 * @deprecated use elm_object_text_set() instead.
9773 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9775 * Set the content to be shown in the bubble
9777 * Once the content object is set, a previously set one will be deleted.
9778 * If you want to keep the old content object, use the
9779 * elm_bubble_content_unset() function.
9781 * @param obj The bubble object
9782 * @param content The given content of the bubble
9784 * This function sets the content shown on the middle of the bubble.
9786 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9788 * Get the content shown in the bubble
9790 * Return the content object which is set for this widget.
9792 * @param obj The bubble object
9793 * @return The content that is being used
9795 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9797 * Unset the content shown in the bubble
9799 * Unparent and return the content object which was set for this widget.
9801 * @param obj The bubble object
9802 * @return The content that was being used
9804 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9806 * Set the icon of the bubble
9808 * Once the icon object is set, a previously set one will be deleted.
9809 * If you want to keep the old content object, use the
9810 * elm_icon_content_unset() function.
9812 * @param obj The bubble object
9813 * @param icon The given icon for the bubble
9815 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9817 * Get the icon of the bubble
9819 * @param obj The bubble object
9820 * @return The icon for the bubble
9822 * This function gets the icon shown on the top left of bubble.
9824 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9826 * Unset the icon of the bubble
9828 * Unparent and return the icon object which was set for this widget.
9830 * @param obj The bubble object
9831 * @return The icon that was being used
9833 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9835 * Set the corner of the bubble
9837 * @param obj The bubble object.
9838 * @param corner The given corner for the bubble.
9840 * This function sets the corner of the bubble. The corner will be used to
9841 * determine where the arrow in the frame points to and where label, icon and
9844 * Possible values for corner are:
9845 * @li "top_left" - Default
9848 * @li "bottom_right"
9850 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
9852 * Get the corner of the bubble
9854 * @param obj The bubble object.
9855 * @return The given corner for the bubble.
9857 * This function gets the selected corner of the bubble.
9859 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9865 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9866 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
9867 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
9868 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
9869 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
9870 /* smart callbacks called:
9871 * "clicked" - the user clicked the icon
9872 * "drag,start" - Someone started dragging the image out of the object
9873 * "drag,end" - Dragged item was dropped (somewhere)
9878 * @defgroup Elm_Gesture_Layer Gesture Layer
9879 * Gesture Layer Usage:
9881 * Use Gesture Layer to detect gestures.
9882 * The advantage is that you don't have to implement
9883 * gesture detection, just set callbacks of gesture state.
9884 * By using gesture layer we make standard interface.
9886 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
9887 * with a parent object parameter.
9888 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
9889 * call. Usually with same object as target (2nd parameter).
9891 * Now you need to tell gesture layer what gestures you follow.
9892 * This is done with @ref elm_gesture_layer_cb_set call.
9893 * By setting the callback you actually saying to gesture layer:
9894 * I would like to know when the gesture @ref Elm_Gesture_Types
9895 * switches to state @ref Elm_Gesture_State.
9897 * Next, you need to implement the actual action that follows the input
9900 * Note that if you like to stop being reported about a gesture, just set
9901 * all callbacks referring this gesture to NULL.
9902 * (again with @ref elm_gesture_layer_cb_set)
9904 * The information reported by gesture layer to your callback is depending
9905 * on @ref Elm_Gesture_Types:
9906 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
9907 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
9908 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
9910 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
9911 * @ref ELM_GESTURE_MOMENTUM.
9913 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
9914 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
9915 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
9916 * Note that we consider a flick as a line-gesture that should be completed
9917 * in flick-time-limit as defined in @ref Config.
9919 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
9921 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
9925 * @enum _Elm_Gesture_Types
9926 * Enum of supported gesture types.
9927 * @ingroup Elm_Gesture_Layer
9929 enum _Elm_Gesture_Types
9931 ELM_GESTURE_FIRST = 0,
9933 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
9934 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
9935 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
9936 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
9938 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
9940 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
9941 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
9943 ELM_GESTURE_ZOOM, /**< Zoom */
9944 ELM_GESTURE_ROTATE, /**< Rotate */
9950 * @typedef Elm_Gesture_Types
9951 * gesture types enum
9952 * @ingroup Elm_Gesture_Layer
9954 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
9957 * @enum _Elm_Gesture_State
9958 * Enum of gesture states.
9959 * @ingroup Elm_Gesture_Layer
9961 enum _Elm_Gesture_State
9963 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
9964 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
9965 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
9966 ELM_GESTURE_STATE_END, /**< Gesture completed */
9967 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
9971 * @typedef Elm_Gesture_State
9972 * gesture states enum
9973 * @ingroup Elm_Gesture_Layer
9975 typedef enum _Elm_Gesture_State Elm_Gesture_State;
9978 * @struct _Elm_Gesture_Taps_Info
9979 * Struct holds taps info for user
9980 * @ingroup Elm_Gesture_Layer
9982 struct _Elm_Gesture_Taps_Info
9984 Evas_Coord x, y; /**< Holds center point between fingers */
9985 unsigned int n; /**< Number of fingers tapped */
9986 unsigned int timestamp; /**< event timestamp */
9990 * @typedef Elm_Gesture_Taps_Info
9991 * holds taps info for user
9992 * @ingroup Elm_Gesture_Layer
9994 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
9997 * @struct _Elm_Gesture_Momentum_Info
9998 * Struct holds momentum info for user
9999 * x1 and y1 are not necessarily in sync
10000 * x1 holds x value of x direction starting point
10001 * and same holds for y1.
10002 * This is noticeable when doing V-shape movement
10003 * @ingroup Elm_Gesture_Layer
10005 struct _Elm_Gesture_Momentum_Info
10006 { /* Report line ends, timestamps, and momentum computed */
10007 Evas_Coord x1; /**< Final-swipe direction starting point on X */
10008 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
10009 Evas_Coord x2; /**< Final-swipe direction ending point on X */
10010 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
10012 unsigned int tx; /**< Timestamp of start of final x-swipe */
10013 unsigned int ty; /**< Timestamp of start of final y-swipe */
10015 Evas_Coord mx; /**< Momentum on X */
10016 Evas_Coord my; /**< Momentum on Y */
10020 * @typedef Elm_Gesture_Momentum_Info
10021 * holds momentum info for user
10022 * @ingroup Elm_Gesture_Layer
10024 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10027 * @struct _Elm_Gesture_Line_Info
10028 * Struct holds line info for user
10029 * @ingroup Elm_Gesture_Layer
10031 struct _Elm_Gesture_Line_Info
10032 { /* Report line ends, timestamps, and momentum computed */
10033 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10034 unsigned int n; /**< Number of fingers (lines) */
10035 /* FIXME should be radians, bot degrees */
10036 double angle; /**< Angle (direction) of lines */
10040 * @typedef Elm_Gesture_Line_Info
10041 * Holds line info for user
10042 * @ingroup Elm_Gesture_Layer
10044 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10047 * @struct _Elm_Gesture_Zoom_Info
10048 * Struct holds zoom info for user
10049 * @ingroup Elm_Gesture_Layer
10051 struct _Elm_Gesture_Zoom_Info
10053 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10054 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10055 double zoom; /**< Zoom value: 1.0 means no zoom */
10056 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10060 * @typedef Elm_Gesture_Zoom_Info
10061 * Holds zoom info for user
10062 * @ingroup Elm_Gesture_Layer
10064 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10067 * @struct _Elm_Gesture_Rotate_Info
10068 * Struct holds rotation info for user
10069 * @ingroup Elm_Gesture_Layer
10071 struct _Elm_Gesture_Rotate_Info
10073 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10074 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10075 double base_angle; /**< Holds start-angle */
10076 double angle; /**< Rotation value: 0.0 means no rotation */
10077 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10081 * @typedef Elm_Gesture_Rotate_Info
10082 * Holds rotation info for user
10083 * @ingroup Elm_Gesture_Layer
10085 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10088 * @typedef Elm_Gesture_Event_Cb
10089 * User callback used to stream gesture info from gesture layer
10090 * @param data user data
10091 * @param event_info gesture report info
10092 * Returns a flag field to be applied on the causing event.
10093 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10094 * upon the event, in an irreversible way.
10096 * @ingroup Elm_Gesture_Layer
10098 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10101 * Use function to set callbacks to be notified about
10102 * change of state of gesture.
10103 * When a user registers a callback with this function
10104 * this means this gesture has to be tested.
10106 * When ALL callbacks for a gesture are set to NULL
10107 * it means user isn't interested in gesture-state
10108 * and it will not be tested.
10110 * @param obj Pointer to gesture-layer.
10111 * @param idx The gesture you would like to track its state.
10112 * @param cb callback function pointer.
10113 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10114 * @param data user info to be sent to callback (usually, Smart Data)
10116 * @ingroup Elm_Gesture_Layer
10118 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);
10121 * Call this function to get repeat-events settings.
10123 * @param obj Pointer to gesture-layer.
10125 * @return repeat events settings.
10126 * @see elm_gesture_layer_hold_events_set()
10127 * @ingroup Elm_Gesture_Layer
10129 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10132 * This function called in order to make gesture-layer repeat events.
10133 * Set this of you like to get the raw events only if gestures were not detected.
10134 * Clear this if you like gesture layer to fwd events as testing gestures.
10136 * @param obj Pointer to gesture-layer.
10137 * @param r Repeat: TRUE/FALSE
10139 * @ingroup Elm_Gesture_Layer
10141 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10144 * This function sets step-value for zoom action.
10145 * Set step to any positive value.
10146 * Cancel step setting by setting to 0.0
10148 * @param obj Pointer to gesture-layer.
10149 * @param s new zoom step value.
10151 * @ingroup Elm_Gesture_Layer
10153 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10156 * This function sets step-value for rotate action.
10157 * Set step to any positive value.
10158 * Cancel step setting by setting to 0.0
10160 * @param obj Pointer to gesture-layer.
10161 * @param s new roatate step value.
10163 * @ingroup Elm_Gesture_Layer
10165 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10168 * This function called to attach gesture-layer to an Evas_Object.
10169 * @param obj Pointer to gesture-layer.
10170 * @param t Pointer to underlying object (AKA Target)
10172 * @return TRUE, FALSE on success, failure.
10174 * @ingroup Elm_Gesture_Layer
10176 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10179 * Call this function to construct a new gesture-layer object.
10180 * This does not activate the gesture layer. You have to
10181 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10183 * @param parent the parent object.
10185 * @return Pointer to new gesture-layer object.
10187 * @ingroup Elm_Gesture_Layer
10189 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10192 * @defgroup Thumb Thumb
10194 * @image html img/widget/thumb/preview-00.png
10195 * @image latex img/widget/thumb/preview-00.eps
10197 * A thumb object is used for displaying the thumbnail of an image or video.
10198 * You must have compiled Elementary with Ethumb_Client support and the DBus
10199 * service must be present and auto-activated in order to have thumbnails to
10202 * Once the thumbnail object becomes visible, it will check if there is a
10203 * previously generated thumbnail image for the file set on it. If not, it
10204 * will start generating this thumbnail.
10206 * Different config settings will cause different thumbnails to be generated
10207 * even on the same file.
10209 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10210 * Ethumb documentation to change this path, and to see other configuration
10213 * Signals that you can add callbacks for are:
10215 * - "clicked" - This is called when a user has clicked the thumb without dragging
10217 * - "clicked,double" - This is called when a user has double-clicked the thumb.
10218 * - "press" - This is called when a user has pressed down the thumb.
10219 * - "generate,start" - The thumbnail generation started.
10220 * - "generate,stop" - The generation process stopped.
10221 * - "generate,error" - The generation failed.
10222 * - "load,error" - The thumbnail image loading failed.
10224 * available styles:
10228 * An example of use of thumbnail:
10230 * - @ref thumb_example_01
10234 * @addtogroup Thumb
10239 * @enum _Elm_Thumb_Animation_Setting
10240 * @typedef Elm_Thumb_Animation_Setting
10242 * Used to set if a video thumbnail is animating or not.
10246 typedef enum _Elm_Thumb_Animation_Setting
10248 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10249 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
10250 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
10251 ELM_THUMB_ANIMATION_LAST
10252 } Elm_Thumb_Animation_Setting;
10255 * Add a new thumb object to the parent.
10257 * @param parent The parent object.
10258 * @return The new object or NULL if it cannot be created.
10260 * @see elm_thumb_file_set()
10261 * @see elm_thumb_ethumb_client_get()
10265 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10267 * Reload thumbnail if it was generated before.
10269 * @param obj The thumb object to reload
10271 * This is useful if the ethumb client configuration changed, like its
10272 * size, aspect or any other property one set in the handle returned
10273 * by elm_thumb_ethumb_client_get().
10275 * If the options didn't change, the thumbnail won't be generated again, but
10276 * the old one will still be used.
10278 * @see elm_thumb_file_set()
10282 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10284 * Set the file that will be used as thumbnail.
10286 * @param obj The thumb object.
10287 * @param file The path to file that will be used as thumb.
10288 * @param key The key used in case of an EET file.
10290 * The file can be an image or a video (in that case, acceptable extensions are:
10291 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10292 * function elm_thumb_animate().
10294 * @see elm_thumb_file_get()
10295 * @see elm_thumb_reload()
10296 * @see elm_thumb_animate()
10300 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10302 * Get the image or video path and key used to generate the thumbnail.
10304 * @param obj The thumb object.
10305 * @param file Pointer to filename.
10306 * @param key Pointer to key.
10308 * @see elm_thumb_file_set()
10309 * @see elm_thumb_path_get()
10313 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10315 * Get the path and key to the image or video generated by ethumb.
10317 * One just need to make sure that the thumbnail was generated before getting
10318 * its path; otherwise, the path will be NULL. One way to do that is by asking
10319 * for the path when/after the "generate,stop" smart callback is called.
10321 * @param obj The thumb object.
10322 * @param file Pointer to thumb path.
10323 * @param key Pointer to thumb key.
10325 * @see elm_thumb_file_get()
10329 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10331 * Set the animation state for the thumb object. If its content is an animated
10332 * video, you may start/stop the animation or tell it to play continuously and
10335 * @param obj The thumb object.
10336 * @param setting The animation setting.
10338 * @see elm_thumb_file_set()
10342 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10344 * Get the animation state for the thumb object.
10346 * @param obj The thumb object.
10347 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10350 * @see elm_thumb_animate_set()
10354 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10356 * Get the ethumb_client handle so custom configuration can be made.
10358 * @return Ethumb_Client instance or NULL.
10360 * This must be called before the objects are created to be sure no object is
10361 * visible and no generation started.
10363 * Example of usage:
10366 * #include <Elementary.h>
10367 * #ifndef ELM_LIB_QUICKLAUNCH
10369 * elm_main(int argc, char **argv)
10371 * Ethumb_Client *client;
10373 * elm_need_ethumb();
10377 * client = elm_thumb_ethumb_client_get();
10380 * ERR("could not get ethumb_client");
10383 * ethumb_client_size_set(client, 100, 100);
10384 * ethumb_client_crop_align_set(client, 0.5, 0.5);
10387 * // Create elm_thumb objects here
10397 * @note There's only one client handle for Ethumb, so once a configuration
10398 * change is done to it, any other request for thumbnails (for any thumbnail
10399 * object) will use that configuration. Thus, this configuration is global.
10403 EAPI void *elm_thumb_ethumb_client_get(void);
10405 * Get the ethumb_client connection state.
10407 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10410 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
10412 * Make the thumbnail 'editable'.
10414 * @param obj Thumb object.
10415 * @param set Turn on or off editability. Default is @c EINA_FALSE.
10417 * This means the thumbnail is a valid drag target for drag and drop, and can be
10418 * cut or pasted too.
10420 * @see elm_thumb_editable_get()
10424 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10426 * Make the thumbnail 'editable'.
10428 * @param obj Thumb object.
10429 * @return Editability.
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_set()
10438 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10445 * @defgroup Hoversel Hoversel
10447 * @image html img/widget/hoversel/preview-00.png
10448 * @image latex img/widget/hoversel/preview-00.eps
10450 * A hoversel is a button that pops up a list of items (automatically
10451 * choosing the direction to display) that have a label and, optionally, an
10452 * icon to select from. It is a convenience widget to avoid the need to do
10453 * all the piecing together yourself. It is intended for a small number of
10454 * items in the hoversel menu (no more than 8), though is capable of many
10457 * Signals that you can add callbacks for are:
10458 * "clicked" - the user clicked the hoversel button and popped up the sel
10459 * "selected" - an item in the hoversel list is selected. event_info is the item
10460 * "dismissed" - the hover is dismissed
10462 * See @ref tutorial_hoversel for an example.
10465 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10467 * @brief Add a new Hoversel object
10469 * @param parent The parent object
10470 * @return The new object or NULL if it cannot be created
10472 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10474 * @brief This sets the hoversel to expand horizontally.
10476 * @param obj The hoversel object
10477 * @param horizontal If true, the hover will expand horizontally to the
10480 * @note The initial button will display horizontally regardless of this
10483 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10485 * @brief This returns whether the hoversel is set to expand horizontally.
10487 * @param obj The hoversel object
10488 * @return If true, the hover will expand horizontally to the right.
10490 * @see elm_hoversel_horizontal_set()
10492 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10494 * @brief Set the Hover parent
10496 * @param obj The hoversel object
10497 * @param parent The parent to use
10499 * Sets the hover parent object, the area that will be darkened when the
10500 * hoversel is clicked. Should probably be the window that the hoversel is
10501 * in. See @ref Hover objects for more information.
10503 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10505 * @brief Get the Hover parent
10507 * @param obj The hoversel object
10508 * @return The used parent
10510 * Gets the hover parent object.
10512 * @see elm_hoversel_hover_parent_set()
10514 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10516 * @brief Set the hoversel button label
10518 * @param obj The hoversel object
10519 * @param label The label text.
10521 * This sets the label of the button that is always visible (before it is
10522 * clicked and expanded).
10524 * @deprecated elm_object_text_set()
10526 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10528 * @brief Get the hoversel button label
10530 * @param obj The hoversel object
10531 * @return The label text.
10533 * @deprecated elm_object_text_get()
10535 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10537 * @brief Set the icon of the hoversel button
10539 * @param obj The hoversel object
10540 * @param icon The icon object
10542 * Sets the icon of the button that is always visible (before it is clicked
10543 * and expanded). Once the icon object is set, a previously set one will be
10544 * deleted, if you want to keep that old content object, use the
10545 * elm_hoversel_icon_unset() function.
10547 * @see elm_button_icon_set()
10549 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10551 * @brief Get the icon of the hoversel button
10553 * @param obj The hoversel object
10554 * @return The icon object
10556 * Get the icon of the button that is always visible (before it is clicked
10557 * and expanded). Also see elm_button_icon_get().
10559 * @see elm_hoversel_icon_set()
10561 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10563 * @brief Get and unparent the icon of the hoversel button
10565 * @param obj The hoversel object
10566 * @return The icon object that was being used
10568 * Unparent and return the icon of the button that is always visible
10569 * (before it is clicked and expanded).
10571 * @see elm_hoversel_icon_set()
10572 * @see elm_button_icon_unset()
10574 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10576 * @brief This triggers the hoversel popup from code, the same as if the user
10577 * had clicked the button.
10579 * @param obj The hoversel object
10581 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10583 * @brief This dismisses the hoversel popup as if the user had clicked
10584 * outside the hover.
10586 * @param obj The hoversel object
10588 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10590 * @brief Returns whether the hoversel is expanded.
10592 * @param obj The hoversel object
10593 * @return This will return EINA_TRUE if the hoversel is expanded or
10594 * EINA_FALSE if it is not expanded.
10596 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10598 * @brief This will remove all the children items from the hoversel.
10600 * @param obj The hoversel object
10602 * @warning Should @b not be called while the hoversel is active; use
10603 * elm_hoversel_expanded_get() to check first.
10605 * @see elm_hoversel_item_del_cb_set()
10606 * @see elm_hoversel_item_del()
10608 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10610 * @brief Get the list of items within the given hoversel.
10612 * @param obj The hoversel object
10613 * @return Returns a list of Elm_Hoversel_Item*
10615 * @see elm_hoversel_item_add()
10617 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10619 * @brief Add an item to the hoversel button
10621 * @param obj The hoversel object
10622 * @param label The text label to use for the item (NULL if not desired)
10623 * @param icon_file An image file path on disk to use for the icon or standard
10624 * icon name (NULL if not desired)
10625 * @param icon_type The icon type if relevant
10626 * @param func Convenience function to call when this item is selected
10627 * @param data Data to pass to item-related functions
10628 * @return A handle to the item added.
10630 * This adds an item to the hoversel to show when it is clicked. Note: if you
10631 * need to use an icon from an edje file then use
10632 * elm_hoversel_item_icon_set() right after the this function, and set
10633 * icon_file to NULL here.
10635 * For more information on what @p icon_file and @p icon_type are see the
10636 * @ref Icon "icon documentation".
10638 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);
10640 * @brief Delete an item from the hoversel
10642 * @param item The item to delete
10644 * This deletes the item from the hoversel (should not be called while the
10645 * hoversel is active; use elm_hoversel_expanded_get() to check first).
10647 * @see elm_hoversel_item_add()
10648 * @see elm_hoversel_item_del_cb_set()
10650 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10652 * @brief Set the function to be called when an item from the hoversel is
10655 * @param item The item to set the callback on
10656 * @param func The function called
10658 * That function will receive these parameters:
10659 * @li void *item_data
10660 * @li Evas_Object *the_item_object
10661 * @li Elm_Hoversel_Item *the_object_struct
10663 * @see elm_hoversel_item_add()
10665 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10667 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10668 * that will be passed to associated function callbacks.
10670 * @param item The item to get the data from
10671 * @return The data pointer set with elm_hoversel_item_add()
10673 * @see elm_hoversel_item_add()
10675 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10677 * @brief This returns the label text of the given hoversel item.
10679 * @param item The item to get the label
10680 * @return The label text of the hoversel item
10682 * @see elm_hoversel_item_add()
10684 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10686 * @brief This sets the icon for the given hoversel item.
10688 * @param item The item to set the icon
10689 * @param icon_file An image file path on disk to use for the icon or standard
10691 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10692 * to NULL if the icon is not an edje file
10693 * @param icon_type The icon type
10695 * The icon can be loaded from the standard set, from an image file, or from
10698 * @see elm_hoversel_item_add()
10700 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);
10702 * @brief Get the icon object of the hoversel item
10704 * @param item The item to get the icon from
10705 * @param icon_file The image file path on disk used for the icon or standard
10707 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10708 * if the icon is not an edje file
10709 * @param icon_type The icon type
10711 * @see elm_hoversel_item_icon_set()
10712 * @see elm_hoversel_item_add()
10714 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);
10720 * @defgroup Toolbar Toolbar
10721 * @ingroup Elementary
10723 * @image html img/widget/toolbar/preview-00.png
10724 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10726 * @image html img/toolbar.png
10727 * @image latex img/toolbar.eps width=\textwidth
10729 * A toolbar is a widget that displays a list of items inside
10730 * a box. It can be scrollable, show a menu with items that don't fit
10731 * to toolbar size or even crop them.
10733 * Only one item can be selected at a time.
10735 * Items can have multiple states, or show menus when selected by the user.
10737 * Smart callbacks one can listen to:
10738 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10740 * Available styles for it:
10742 * - @c "transparent" - no background or shadow, just show the content
10744 * List of examples:
10745 * @li @ref toolbar_example_01
10746 * @li @ref toolbar_example_02
10747 * @li @ref toolbar_example_03
10751 * @addtogroup Toolbar
10756 * @enum _Elm_Toolbar_Shrink_Mode
10757 * @typedef Elm_Toolbar_Shrink_Mode
10759 * Set toolbar's items display behavior, it can be scrollabel,
10760 * show a menu with exceeding items, or simply hide them.
10762 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
10765 * Values <b> don't </b> work as bitmask, only one can be choosen.
10767 * @see elm_toolbar_mode_shrink_set()
10768 * @see elm_toolbar_mode_shrink_get()
10772 typedef enum _Elm_Toolbar_Shrink_Mode
10774 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
10775 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
10776 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
10777 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
10778 } Elm_Toolbar_Shrink_Mode;
10780 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(). */
10782 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(). */
10785 * Add a new toolbar widget to the given parent Elementary
10786 * (container) object.
10788 * @param parent The parent object.
10789 * @return a new toolbar widget handle or @c NULL, on errors.
10791 * This function inserts a new toolbar widget on the canvas.
10795 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10798 * Set the icon size, in pixels, to be used by toolbar items.
10800 * @param obj The toolbar object
10801 * @param icon_size The icon size in pixels
10803 * @note Default value is @c 32. It reads value from elm config.
10805 * @see elm_toolbar_icon_size_get()
10809 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
10812 * Get the icon size, in pixels, to be used by toolbar items.
10814 * @param obj The toolbar object.
10815 * @return The icon size in pixels.
10817 * @see elm_toolbar_icon_size_set() for details.
10821 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10824 * Sets icon lookup order, for toolbar items' icons.
10826 * @param obj The toolbar object.
10827 * @param order The icon lookup order.
10829 * Icons added before calling this function will not be affected.
10830 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
10832 * @see elm_toolbar_icon_order_lookup_get()
10836 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
10839 * Gets the icon lookup order.
10841 * @param obj The toolbar object.
10842 * @return The icon lookup order.
10844 * @see elm_toolbar_icon_order_lookup_set() for details.
10848 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10851 * Set whether the toolbar items' should be selected by the user or not.
10853 * @param obj The toolbar object.
10854 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
10857 * This will turn off the ability to select items entirely and they will
10858 * neither appear selected nor emit selected signals. The clicked
10859 * callback function will still be called.
10861 * Selection is enabled by default.
10863 * @see elm_toolbar_no_select_mode_get().
10867 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
10870 * Set whether the toolbar items' should be selected by the user or not.
10872 * @param obj The toolbar object.
10873 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
10874 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
10876 * @see elm_toolbar_no_select_mode_set() for details.
10880 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10883 * Append item to the toolbar.
10885 * @param obj The toolbar object.
10886 * @param icon A string with icon name or the absolute path of an image file.
10887 * @param label The label of the item.
10888 * @param func The function to call when the item is clicked.
10889 * @param data The data to associate with the item for related callbacks.
10890 * @return The created item or @c NULL upon failure.
10892 * A new item will be created and appended to the toolbar, i.e., will
10893 * be set as @b last item.
10895 * Items created with this method can be deleted with
10896 * elm_toolbar_item_del().
10898 * Associated @p data can be properly freed when item is deleted if a
10899 * callback function is set with elm_toolbar_item_del_cb_set().
10901 * If a function is passed as argument, it will be called everytime this item
10902 * is selected, i.e., the user clicks over an unselected item.
10903 * If such function isn't needed, just passing
10904 * @c NULL as @p func is enough. The same should be done for @p data.
10906 * Toolbar will load icon image from fdo or current theme.
10907 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10908 * If an absolute path is provided it will load it direct from a file.
10910 * @see elm_toolbar_item_icon_set()
10911 * @see elm_toolbar_item_del()
10912 * @see elm_toolbar_item_del_cb_set()
10916 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);
10919 * Prepend item to the toolbar.
10921 * @param obj The toolbar object.
10922 * @param icon A string with icon name or the absolute path of an image file.
10923 * @param label The label of the item.
10924 * @param func The function to call when the item is clicked.
10925 * @param data The data to associate with the item for related callbacks.
10926 * @return The created item or @c NULL upon failure.
10928 * A new item will be created and prepended to the toolbar, i.e., will
10929 * be set as @b first item.
10931 * Items created with this method can be deleted with
10932 * elm_toolbar_item_del().
10934 * Associated @p data can be properly freed when item is deleted if a
10935 * callback function is set with elm_toolbar_item_del_cb_set().
10937 * If a function is passed as argument, it will be called everytime this item
10938 * is selected, i.e., the user clicks over an unselected item.
10939 * If such function isn't needed, just passing
10940 * @c NULL as @p func is enough. The same should be done for @p data.
10942 * Toolbar will load icon image from fdo or current theme.
10943 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10944 * If an absolute path is provided it will load it direct from a file.
10946 * @see elm_toolbar_item_icon_set()
10947 * @see elm_toolbar_item_del()
10948 * @see elm_toolbar_item_del_cb_set()
10952 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);
10955 * Insert a new item into the toolbar object before item @p before.
10957 * @param obj The toolbar object.
10958 * @param before The toolbar item to insert before.
10959 * @param icon A string with icon name or the absolute path of an image file.
10960 * @param label The label of the item.
10961 * @param func The function to call when the item is clicked.
10962 * @param data The data to associate with the item for related callbacks.
10963 * @return The created item or @c NULL upon failure.
10965 * A new item will be created and added to the toolbar. Its position in
10966 * this toolbar will be just before item @p before.
10968 * Items created with this method can be deleted with
10969 * elm_toolbar_item_del().
10971 * Associated @p data can be properly freed when item is deleted if a
10972 * callback function is set with elm_toolbar_item_del_cb_set().
10974 * If a function is passed as argument, it will be called everytime this item
10975 * is selected, i.e., the user clicks over an unselected item.
10976 * If such function isn't needed, just passing
10977 * @c NULL as @p func is enough. The same should be done for @p data.
10979 * Toolbar will load icon image from fdo or current theme.
10980 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10981 * If an absolute path is provided it will load it direct from a file.
10983 * @see elm_toolbar_item_icon_set()
10984 * @see elm_toolbar_item_del()
10985 * @see elm_toolbar_item_del_cb_set()
10989 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);
10992 * Insert a new item into the toolbar object after item @p after.
10994 * @param obj The toolbar object.
10995 * @param before The toolbar item to insert before.
10996 * @param icon A string with icon name or the absolute path of an image file.
10997 * @param label The label of the item.
10998 * @param func The function to call when the item is clicked.
10999 * @param data The data to associate with the item for related callbacks.
11000 * @return The created item or @c NULL upon failure.
11002 * A new item will be created and added to the toolbar. Its position in
11003 * this toolbar will be just after item @p after.
11005 * Items created with this method can be deleted with
11006 * elm_toolbar_item_del().
11008 * Associated @p data can be properly freed when item is deleted if a
11009 * callback function is set with elm_toolbar_item_del_cb_set().
11011 * If a function is passed as argument, it will be called everytime this item
11012 * is selected, i.e., the user clicks over an unselected item.
11013 * If such function isn't needed, just passing
11014 * @c NULL as @p func is enough. The same should be done for @p data.
11016 * Toolbar will load icon image from fdo or current theme.
11017 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11018 * If an absolute path is provided it will load it direct from a file.
11020 * @see elm_toolbar_item_icon_set()
11021 * @see elm_toolbar_item_del()
11022 * @see elm_toolbar_item_del_cb_set()
11026 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);
11029 * Get the first item in the given toolbar widget's list of
11032 * @param obj The toolbar object
11033 * @return The first item or @c NULL, if it has no items (and on
11036 * @see elm_toolbar_item_append()
11037 * @see elm_toolbar_last_item_get()
11041 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11044 * Get the last item in the given toolbar widget's list of
11047 * @param obj The toolbar object
11048 * @return The last item or @c NULL, if it has no items (and on
11051 * @see elm_toolbar_item_prepend()
11052 * @see elm_toolbar_first_item_get()
11056 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11059 * Get the item after @p item in toolbar.
11061 * @param item The toolbar item.
11062 * @return The item after @p item, or @c NULL if none or on failure.
11064 * @note If it is the last item, @c NULL will be returned.
11066 * @see elm_toolbar_item_append()
11070 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11073 * Get the item before @p item in toolbar.
11075 * @param item The toolbar item.
11076 * @return The item before @p item, or @c NULL if none or on failure.
11078 * @note If it is the first item, @c NULL will be returned.
11080 * @see elm_toolbar_item_prepend()
11084 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11087 * Get the toolbar object from an item.
11089 * @param item The item.
11090 * @return The toolbar object.
11092 * This returns the toolbar object itself that an item belongs to.
11096 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11099 * Set the priority of a toolbar item.
11101 * @param item The toolbar item.
11102 * @param priority The item priority. The default is zero.
11104 * This is used only when the toolbar shrink mode is set to
11105 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11106 * When space is less than required, items with low priority
11107 * will be removed from the toolbar and added to a dynamically-created menu,
11108 * while items with higher priority will remain on the toolbar,
11109 * with the same order they were added.
11111 * @see elm_toolbar_item_priority_get()
11115 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11118 * Get the priority of a toolbar item.
11120 * @param item The toolbar item.
11121 * @return The @p item priority, or @c 0 on failure.
11123 * @see elm_toolbar_item_priority_set() for details.
11127 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11130 * Get the label of item.
11132 * @param item The item of toolbar.
11133 * @return The label of item.
11135 * The return value is a pointer to the label associated to @p item when
11136 * it was created, with function elm_toolbar_item_append() or similar,
11138 * with function elm_toolbar_item_label_set. If no label
11139 * was passed as argument, it will return @c NULL.
11141 * @see elm_toolbar_item_label_set() for more details.
11142 * @see elm_toolbar_item_append()
11146 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11149 * Set the label of item.
11151 * @param item The item of toolbar.
11152 * @param text The label of item.
11154 * The label to be displayed by the item.
11155 * Label will be placed at icons bottom (if set).
11157 * If a label was passed as argument on item creation, with function
11158 * elm_toolbar_item_append() or similar, it will be already
11159 * displayed by the item.
11161 * @see elm_toolbar_item_label_get()
11162 * @see elm_toolbar_item_append()
11166 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11169 * Return the data associated with a given toolbar widget item.
11171 * @param item The toolbar widget item handle.
11172 * @return The data associated with @p item.
11174 * @see elm_toolbar_item_data_set()
11178 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11181 * Set the data associated with a given toolbar widget item.
11183 * @param item The toolbar widget item handle.
11184 * @param data The new data pointer to set to @p item.
11186 * This sets new item data on @p item.
11188 * @warning The old data pointer won't be touched by this function, so
11189 * the user had better to free that old data himself/herself.
11193 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11196 * Returns a pointer to a toolbar item by its label.
11198 * @param obj The toolbar object.
11199 * @param label The label of the item to find.
11201 * @return The pointer to the toolbar item matching @p label or @c NULL
11206 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11209 * Get whether the @p item is selected or not.
11211 * @param item The toolbar item.
11212 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11213 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11215 * @see elm_toolbar_selected_item_set() for details.
11216 * @see elm_toolbar_item_selected_get()
11220 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11223 * Set the selected state of an item.
11225 * @param item The toolbar item
11226 * @param selected The selected state
11228 * This sets the selected state of the given item @p it.
11229 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11231 * If a new item is selected the previosly selected will be unselected.
11232 * Previoulsy selected item can be get with function
11233 * elm_toolbar_selected_item_get().
11235 * Selected items will be highlighted.
11237 * @see elm_toolbar_item_selected_get()
11238 * @see elm_toolbar_selected_item_get()
11242 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11245 * Get the selected item.
11247 * @param obj The toolbar object.
11248 * @return The selected toolbar item.
11250 * The selected item can be unselected with function
11251 * elm_toolbar_item_selected_set().
11253 * The selected item always will be highlighted on toolbar.
11255 * @see elm_toolbar_selected_items_get()
11259 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11262 * Set the icon associated with @p item.
11264 * @param obj The parent of this item.
11265 * @param item The toolbar item.
11266 * @param icon A string with icon name or the absolute path of an image file.
11268 * Toolbar will load icon image from fdo or current theme.
11269 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11270 * If an absolute path is provided it will load it direct from a file.
11272 * @see elm_toolbar_icon_order_lookup_set()
11273 * @see elm_toolbar_icon_order_lookup_get()
11277 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11280 * Get the string used to set the icon of @p item.
11282 * @param item The toolbar item.
11283 * @return The string associated with the icon object.
11285 * @see elm_toolbar_item_icon_set() for details.
11289 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11292 * Delete them item from the toolbar.
11294 * @param item The item of toolbar to be deleted.
11296 * @see elm_toolbar_item_append()
11297 * @see elm_toolbar_item_del_cb_set()
11301 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11304 * Set the function called when a toolbar item is freed.
11306 * @param item The item to set the callback on.
11307 * @param func The function called.
11309 * If there is a @p func, then it will be called prior item's memory release.
11310 * That will be called with the following arguments:
11312 * @li item's Evas object;
11315 * This way, a data associated to a toolbar item could be properly freed.
11319 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11322 * Get a value whether toolbar item is disabled or not.
11324 * @param item The item.
11325 * @return The disabled state.
11327 * @see elm_toolbar_item_disabled_set() for more details.
11331 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11334 * Sets the disabled/enabled state of a toolbar item.
11336 * @param item The item.
11337 * @param disabled The disabled state.
11339 * A disabled item cannot be selected or unselected. It will also
11340 * change its appearance (generally greyed out). This sets the
11341 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11346 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11349 * Set or unset item as a separator.
11351 * @param item The toolbar item.
11352 * @param setting @c EINA_TRUE to set item @p item as separator or
11353 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11355 * Items aren't set as separator by default.
11357 * If set as separator it will display separator theme, so won't display
11360 * @see elm_toolbar_item_separator_get()
11364 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11367 * Get a value whether item is a separator or not.
11369 * @param item The toolbar item.
11370 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11371 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11373 * @see elm_toolbar_item_separator_set() for details.
11377 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11380 * Set the shrink state of toolbar @p obj.
11382 * @param obj The toolbar object.
11383 * @param shrink_mode Toolbar's items display behavior.
11385 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11386 * but will enforce a minimun size so all the items will fit, won't scroll
11387 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11388 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11389 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11393 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11396 * Get the shrink mode of toolbar @p obj.
11398 * @param obj The toolbar object.
11399 * @return Toolbar's items display behavior.
11401 * @see elm_toolbar_mode_shrink_set() for details.
11405 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11408 * Enable/disable homogenous mode.
11410 * @param obj The toolbar object
11411 * @param homogeneous Assume the items within the toolbar are of the
11412 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11414 * This will enable the homogeneous mode where items are of the same size.
11415 * @see elm_toolbar_homogeneous_get()
11419 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11422 * Get whether the homogenous mode is enabled.
11424 * @param obj The toolbar object.
11425 * @return Assume the items within the toolbar are of the same height
11426 * and width (EINA_TRUE = on, EINA_FALSE = off).
11428 * @see elm_toolbar_homogeneous_set()
11432 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11435 * Enable/disable homogenous mode.
11437 * @param obj The toolbar object
11438 * @param homogeneous Assume the items within the toolbar are of the
11439 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11441 * This will enable the homogeneous mode where items are of the same size.
11442 * @see elm_toolbar_homogeneous_get()
11444 * @deprecated use elm_toolbar_homogeneous_set() instead.
11448 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11451 * Get whether the homogenous mode is enabled.
11453 * @param obj The toolbar object.
11454 * @return Assume the items within the toolbar are of the same height
11455 * and width (EINA_TRUE = on, EINA_FALSE = off).
11457 * @see elm_toolbar_homogeneous_set()
11458 * @deprecated use elm_toolbar_homogeneous_get() instead.
11462 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11465 * Set the parent object of the toolbar items' menus.
11467 * @param obj The toolbar object.
11468 * @param parent The parent of the menu objects.
11470 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11472 * For more details about setting the parent for toolbar menus, see
11473 * elm_menu_parent_set().
11475 * @see elm_menu_parent_set() for details.
11476 * @see elm_toolbar_item_menu_set() for details.
11480 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11483 * Get the parent object of the toolbar items' menus.
11485 * @param obj The toolbar object.
11486 * @return The parent of the menu objects.
11488 * @see elm_toolbar_menu_parent_set() for details.
11492 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11495 * Set the alignment of the items.
11497 * @param obj The toolbar object.
11498 * @param align The new alignment, a float between <tt> 0.0 </tt>
11499 * and <tt> 1.0 </tt>.
11501 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11502 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11505 * Centered items by default.
11507 * @see elm_toolbar_align_get()
11511 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11514 * Get the alignment of the items.
11516 * @param obj The toolbar object.
11517 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11520 * @see elm_toolbar_align_set() for details.
11524 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11527 * Set whether the toolbar item opens a menu.
11529 * @param item The toolbar item.
11530 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11532 * A toolbar item can be set to be a menu, using this function.
11534 * Once it is set to be a menu, it can be manipulated through the
11535 * menu-like function elm_toolbar_menu_parent_set() and the other
11536 * elm_menu functions, using the Evas_Object @c menu returned by
11537 * elm_toolbar_item_menu_get().
11539 * So, items to be displayed in this item's menu should be added with
11540 * elm_menu_item_add().
11542 * The following code exemplifies the most basic usage:
11544 * tb = elm_toolbar_add(win)
11545 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11546 * elm_toolbar_item_menu_set(item, EINA_TRUE);
11547 * elm_toolbar_menu_parent_set(tb, win);
11548 * menu = elm_toolbar_item_menu_get(item);
11549 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11550 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11554 * @see elm_toolbar_item_menu_get()
11558 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11561 * Get toolbar item's menu.
11563 * @param item The toolbar item.
11564 * @return Item's menu object or @c NULL on failure.
11566 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11567 * this function will set it.
11569 * @see elm_toolbar_item_menu_set() for details.
11573 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11576 * Add a new state to @p item.
11578 * @param item The item.
11579 * @param icon A string with icon name or the absolute path of an image file.
11580 * @param label The label of the new state.
11581 * @param func The function to call when the item is clicked when this
11582 * state is selected.
11583 * @param data The data to associate with the state.
11584 * @return The toolbar item state, or @c NULL upon failure.
11586 * Toolbar will load icon image from fdo or current theme.
11587 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11588 * If an absolute path is provided it will load it direct from a file.
11590 * States created with this function can be removed with
11591 * elm_toolbar_item_state_del().
11593 * @see elm_toolbar_item_state_del()
11594 * @see elm_toolbar_item_state_sel()
11595 * @see elm_toolbar_item_state_get()
11599 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);
11602 * Delete a previoulsy added state to @p item.
11604 * @param item The toolbar item.
11605 * @param state The state to be deleted.
11606 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11608 * @see elm_toolbar_item_state_add()
11610 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11613 * Set @p state as the current state of @p it.
11615 * @param it The item.
11616 * @param state The state to use.
11617 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11619 * If @p state is @c NULL, it won't select any state and the default item's
11620 * icon and label will be used. It's the same behaviour than
11621 * elm_toolbar_item_state_unser().
11623 * @see elm_toolbar_item_state_unset()
11627 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11630 * Unset the state of @p it.
11632 * @param it The item.
11634 * The default icon and label from this item will be displayed.
11636 * @see elm_toolbar_item_state_set() for more details.
11640 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11643 * Get the current state of @p it.
11645 * @param item The item.
11646 * @return The selected state or @c NULL if none is selected or on failure.
11648 * @see elm_toolbar_item_state_set() for details.
11649 * @see elm_toolbar_item_state_unset()
11650 * @see elm_toolbar_item_state_add()
11654 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11657 * Get the state after selected state in toolbar's @p item.
11659 * @param it The toolbar item to change state.
11660 * @return The state after current state, or @c NULL on failure.
11662 * If last state is selected, this function will return first state.
11664 * @see elm_toolbar_item_state_set()
11665 * @see elm_toolbar_item_state_add()
11669 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11672 * Get the state before selected state in toolbar's @p item.
11674 * @param it The toolbar item to change state.
11675 * @return The state before current state, or @c NULL on failure.
11677 * If first state is selected, this function will return last state.
11679 * @see elm_toolbar_item_state_set()
11680 * @see elm_toolbar_item_state_add()
11684 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11687 * Set the text to be shown in a given toolbar item's tooltips.
11689 * @param item Target item.
11690 * @param text The text to set in the content.
11692 * Setup the text as tooltip to object. The item can have only one tooltip,
11693 * so any previous tooltip data - set with this function or
11694 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11696 * @see elm_object_tooltip_text_set() for more details.
11700 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11703 * Set the content to be shown in the tooltip item.
11705 * Setup the tooltip to item. The item can have only one tooltip,
11706 * so any previous tooltip data is removed. @p func(with @p data) will
11707 * be called every time that need show the tooltip and it should
11708 * return a valid Evas_Object. This object is then managed fully by
11709 * tooltip system and is deleted when the tooltip is gone.
11711 * @param item the toolbar item being attached a tooltip.
11712 * @param func the function used to create the tooltip contents.
11713 * @param data what to provide to @a func as callback data/context.
11714 * @param del_cb called when data is not needed anymore, either when
11715 * another callback replaces @a func, the tooltip is unset with
11716 * elm_toolbar_item_tooltip_unset() or the owner @a item
11717 * dies. This callback receives as the first parameter the
11718 * given @a data, and @c event_info is the item.
11720 * @see elm_object_tooltip_content_cb_set() for more details.
11724 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);
11727 * Unset tooltip from item.
11729 * @param item toolbar item to remove previously set tooltip.
11731 * Remove tooltip from item. The callback provided as del_cb to
11732 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11733 * it is not used anymore.
11735 * @see elm_object_tooltip_unset() for more details.
11736 * @see elm_toolbar_item_tooltip_content_cb_set()
11740 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11743 * Sets a different style for this item tooltip.
11745 * @note before you set a style you should define a tooltip with
11746 * elm_toolbar_item_tooltip_content_cb_set() or
11747 * elm_toolbar_item_tooltip_text_set()
11749 * @param item toolbar item with tooltip already set.
11750 * @param style the theme style to use (default, transparent, ...)
11752 * @see elm_object_tooltip_style_set() for more details.
11756 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11759 * Get the style for this item tooltip.
11761 * @param item toolbar item with tooltip already set.
11762 * @return style the theme style in use, defaults to "default". If the
11763 * object does not have a tooltip set, then NULL is returned.
11765 * @see elm_object_tooltip_style_get() for more details.
11766 * @see elm_toolbar_item_tooltip_style_set()
11770 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11773 * Set the type of mouse pointer/cursor decoration to be shown,
11774 * when the mouse pointer is over the given toolbar widget item
11776 * @param item toolbar item to customize cursor on
11777 * @param cursor the cursor type's name
11779 * This function works analogously as elm_object_cursor_set(), but
11780 * here the cursor's changing area is restricted to the item's
11781 * area, and not the whole widget's. Note that that item cursors
11782 * have precedence over widget cursors, so that a mouse over an
11783 * item with custom cursor set will always show @b that cursor.
11785 * If this function is called twice for an object, a previously set
11786 * cursor will be unset on the second call.
11788 * @see elm_object_cursor_set()
11789 * @see elm_toolbar_item_cursor_get()
11790 * @see elm_toolbar_item_cursor_unset()
11794 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
11797 * Get the type of mouse pointer/cursor decoration set to be shown,
11798 * when the mouse pointer is over the given toolbar widget item
11800 * @param item toolbar item with custom cursor set
11801 * @return the cursor type's name or @c NULL, if no custom cursors
11802 * were set to @p item (and on errors)
11804 * @see elm_object_cursor_get()
11805 * @see elm_toolbar_item_cursor_set()
11806 * @see elm_toolbar_item_cursor_unset()
11810 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11813 * Unset any custom mouse pointer/cursor decoration set to be
11814 * shown, when the mouse pointer is over the given toolbar widget
11815 * item, thus making it show the @b default cursor again.
11817 * @param item a toolbar item
11819 * Use this call to undo any custom settings on this item's cursor
11820 * decoration, bringing it back to defaults (no custom style set).
11822 * @see elm_object_cursor_unset()
11823 * @see elm_toolbar_item_cursor_set()
11827 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11830 * Set a different @b style for a given custom cursor set for a
11833 * @param item toolbar item with custom cursor set
11834 * @param style the <b>theme style</b> to use (e.g. @c "default",
11835 * @c "transparent", etc)
11837 * This function only makes sense when one is using custom mouse
11838 * cursor decorations <b>defined in a theme file</b>, which can have,
11839 * given a cursor name/type, <b>alternate styles</b> on it. It
11840 * works analogously as elm_object_cursor_style_set(), but here
11841 * applyed only to toolbar item objects.
11843 * @warning Before you set a cursor style you should have definen a
11844 * custom cursor previously on the item, with
11845 * elm_toolbar_item_cursor_set()
11847 * @see elm_toolbar_item_cursor_engine_only_set()
11848 * @see elm_toolbar_item_cursor_style_get()
11852 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11855 * Get the current @b style set for a given toolbar item's custom
11858 * @param item toolbar item with custom cursor set.
11859 * @return style the cursor style in use. If the object does not
11860 * have a cursor set, then @c NULL is returned.
11862 * @see elm_toolbar_item_cursor_style_set() for more details
11866 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11869 * Set if the (custom)cursor for a given toolbar item should be
11870 * searched in its theme, also, or should only rely on the
11871 * rendering engine.
11873 * @param item item with custom (custom) cursor already set on
11874 * @param engine_only Use @c EINA_TRUE to have cursors looked for
11875 * only on those provided by the rendering engine, @c EINA_FALSE to
11876 * have them searched on the widget's theme, as well.
11878 * @note This call is of use only if you've set a custom cursor
11879 * for toolbar items, with elm_toolbar_item_cursor_set().
11881 * @note By default, cursors will only be looked for between those
11882 * provided by the rendering engine.
11886 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11889 * Get if the (custom) cursor for a given toolbar item is being
11890 * searched in its theme, also, or is only relying on the rendering
11893 * @param item a toolbar item
11894 * @return @c EINA_TRUE, if cursors are being looked for only on
11895 * those provided by the rendering engine, @c EINA_FALSE if they
11896 * are being searched on the widget's theme, as well.
11898 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
11902 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11909 EAPI double elm_tooltip_delay_get(void);
11910 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
11911 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
11912 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
11913 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
11914 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);
11915 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11916 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11917 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11918 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
11919 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11920 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11921 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11922 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11923 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11924 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11925 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
11926 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
11929 EAPI int elm_cursor_engine_only_get(void);
11930 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
11933 * @defgroup Menu Menu
11935 * @image html img/widget/menu/preview-00.png
11936 * @image latex img/widget/menu/preview-00.eps
11938 * A menu is a list of items displayed above its parent. When the menu is
11939 * showing its parent is darkened. Each item can have a sub-menu. The menu
11940 * object can be used to display a menu on a right click event, in a toolbar,
11943 * Signals that you can add callbacks for are:
11944 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
11945 * event_info is NULL.
11947 * @see @ref tutorial_menu
11950 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
11952 * @brief Add a new menu to the parent
11954 * @param parent The parent object.
11955 * @return The new object or NULL if it cannot be created.
11957 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11959 * @brief Set the parent for the given menu widget
11961 * @param obj The menu object.
11962 * @param parent The new parent.
11964 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11966 * @brief Get the parent for the given menu widget
11968 * @param obj The menu object.
11969 * @return The parent.
11971 * @see elm_menu_parent_set()
11973 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11975 * @brief Move the menu to a new position
11977 * @param obj The menu object.
11978 * @param x The new position.
11979 * @param y The new position.
11981 * Sets the top-left position of the menu to (@p x,@p y).
11983 * @note @p x and @p y coordinates are relative to parent.
11985 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
11987 * @brief Close a opened menu
11989 * @param obj the menu object
11992 * Hides the menu and all it's sub-menus.
11994 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
11996 * @brief Returns a list of @p item's items.
11998 * @param obj The menu object
11999 * @return An Eina_List* of @p item's items
12001 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12003 * @brief Get the Evas_Object of an Elm_Menu_Item
12005 * @param item The menu item object.
12006 * @return The edje object containing the swallowed content
12008 * @warning Don't manipulate this object!
12010 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12012 * @brief Add an item at the end of the given menu widget
12014 * @param obj The menu object.
12015 * @param parent The parent menu item (optional)
12016 * @param icon A icon display on the item. The icon will be destryed by the menu.
12017 * @param label The label of the item.
12018 * @param func Function called when the user select the item.
12019 * @param data Data sent by the callback.
12020 * @return Returns the new item.
12022 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);
12024 * @brief Add an object swallowed in an item at the end of the given menu
12027 * @param obj The menu object.
12028 * @param parent The parent menu item (optional)
12029 * @param subobj The object to swallow
12030 * @param func Function called when the user select the item.
12031 * @param data Data sent by the callback.
12032 * @return Returns the new item.
12034 * Add an evas object as an item to the menu.
12036 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);
12038 * @brief Set the label of a menu item
12040 * @param item The menu item object.
12041 * @param label The label to set for @p item
12043 * @warning Don't use this funcion on items created with
12044 * elm_menu_item_add_object() or elm_menu_item_separator_add().
12046 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12048 * @brief Get the label of a menu item
12050 * @param item The menu item object.
12051 * @return The label of @p item
12053 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12055 * @brief Set the icon of a menu item to the standard icon with name @p icon
12057 * @param item The menu item object.
12058 * @param icon The icon object to set for the content of @p item
12060 * Once this icon is set, any previously set icon will be deleted.
12062 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12064 * @brief Get the string representation from the icon of a menu item
12066 * @param item The menu item object.
12067 * @return The string representation of @p item's icon or NULL
12069 * @see elm_menu_item_object_icon_name_set()
12071 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12073 * @deprecated Use elm_menu_item_object_icon_name_set()
12075 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2) EINA_DEPRECATED;
12077 * @deprecated Use elm_menu_item_object_icon_name_get()
12079 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12081 * @brief Set the content object of a menu item
12083 * @param item The menu item object
12084 * @param The content object or NULL
12085 * @return EINA_TRUE on success, else EINA_FALSE
12087 * Use this function to change the object swallowed by a menu item, deleting
12088 * any previously swallowed object.
12090 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12092 * @brief Get the content object of a menu item
12094 * @param item The menu item object
12095 * @return The content object or NULL
12096 * @note If @p item was added with elm_menu_item_add_object, this
12097 * function will return the object passed, else it will return the
12100 * @see elm_menu_item_object_content_set()
12102 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12104 * @deprecated Use elm_menu_item_object_content_get() instead.
12106 EAPI Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12108 * @brief Set the selected state of @p item.
12110 * @param item The menu item object.
12111 * @param selected The selected/unselected state of the item
12113 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12115 * @brief Get the selected state of @p item.
12117 * @param item The menu item object.
12118 * @return The selected/unselected state of the item
12120 * @see elm_menu_item_selected_set()
12122 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12124 * @brief Set the disabled state of @p item.
12126 * @param item The menu item object.
12127 * @param disabled The enabled/disabled state of the item
12129 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12131 * @brief Get the disabled state of @p item.
12133 * @param item The menu item object.
12134 * @return The enabled/disabled state of the item
12136 * @see elm_menu_item_disabled_set()
12138 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12140 * @brief Add a separator item to menu @p obj under @p parent.
12142 * @param obj The menu object
12143 * @param parent The item to add the separator under
12144 * @return The created item or NULL on failure
12146 * This is item is a @ref Separator.
12148 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12150 * @brief Returns whether @p item is a separator.
12152 * @param item The item to check
12153 * @return If true, @p item is a separator
12155 * @see elm_menu_item_separator_add()
12157 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12159 * @brief Deletes an item from the menu.
12161 * @param item The item to delete.
12163 * @see elm_menu_item_add()
12165 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12167 * @brief Set the function called when a menu item is deleted.
12169 * @param item The item to set the callback on
12170 * @param func The function called
12172 * @see elm_menu_item_add()
12173 * @see elm_menu_item_del()
12175 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12177 * @brief Returns the data associated with menu item @p item.
12179 * @param item The item
12180 * @return The data associated with @p item or NULL if none was set.
12182 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12184 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12186 * @brief Sets the data to be associated with menu item @p item.
12188 * @param item The item
12189 * @param data The data to be associated with @p item
12191 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12193 * @brief Returns a list of @p item's subitems.
12195 * @param item The item
12196 * @return An Eina_List* of @p item's subitems
12198 * @see elm_menu_add()
12200 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12202 * @brief Get the position of a menu item
12204 * @param item The menu item
12205 * @return The item's index
12207 * This function returns the index position of a menu item in a menu.
12208 * For a sub-menu, this number is relative to the first item in the sub-menu.
12210 * @note Index values begin with 0
12212 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12214 * @brief @brief Return a menu item's owner menu
12216 * @param item The menu item
12217 * @return The menu object owning @p item, or NULL on failure
12219 * Use this function to get the menu object owning an item.
12221 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12223 * @brief Get the selected item in the menu
12225 * @param obj The menu object
12226 * @return The selected item, or NULL if none
12228 * @see elm_menu_item_selected_get()
12229 * @see elm_menu_item_selected_set()
12231 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12233 * @brief Get the last item in the menu
12235 * @param obj The menu object
12236 * @return The last item, or NULL if none
12238 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12240 * @brief Get the first item in the menu
12242 * @param obj The menu object
12243 * @return The first item, or NULL if none
12245 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12247 * @brief Get the next item in the menu.
12249 * @param item The menu item object.
12250 * @return The item after it, or NULL if none
12252 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12254 * @brief Get the previous item in the menu.
12256 * @param item The menu item object.
12257 * @return The item before it, or NULL if none
12259 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12265 * @defgroup List List
12266 * @ingroup Elementary
12268 * @image html img/widget/list/preview-00.png
12269 * @image latex img/widget/list/preview-00.eps width=\textwidth
12271 * @image html img/list.png
12272 * @image latex img/list.eps width=\textwidth
12274 * A list widget is a container whose children are displayed vertically or
12275 * horizontally, in order, and can be selected.
12276 * The list can accept only one or multiple items selection. Also has many
12277 * modes of items displaying.
12279 * A list is a very simple type of list widget. For more robust
12280 * lists, @ref Genlist should probably be used.
12282 * Smart callbacks one can listen to:
12283 * - @c "activated" - The user has double-clicked or pressed
12284 * (enter|return|spacebar) on an item. The @c event_info parameter
12285 * is the item that was activated.
12286 * - @c "clicked,double" - The user has double-clicked an item.
12287 * The @c event_info parameter is the item that was double-clicked.
12288 * - "selected" - when the user selected an item
12289 * - "unselected" - when the user unselected an item
12290 * - "longpressed" - an item in the list is long-pressed
12291 * - "scroll,edge,top" - the list is scrolled until the top edge
12292 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12293 * - "scroll,edge,left" - the list is scrolled until the left edge
12294 * - "scroll,edge,right" - the list is scrolled until the right edge
12296 * Available styles for it:
12299 * List of examples:
12300 * @li @ref list_example_01
12301 * @li @ref list_example_02
12302 * @li @ref list_example_03
12311 * @enum _Elm_List_Mode
12312 * @typedef Elm_List_Mode
12314 * Set list's resize behavior, transverse axis scroll and
12315 * items cropping. See each mode's description for more details.
12317 * @note Default value is #ELM_LIST_SCROLL.
12319 * Values <b> don't </b> work as bitmask, only one can be choosen.
12321 * @see elm_list_mode_set()
12322 * @see elm_list_mode_get()
12326 typedef enum _Elm_List_Mode
12328 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. */
12329 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). */
12330 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. */
12331 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. */
12332 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12335 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(). */
12338 * Add a new list widget to the given parent Elementary
12339 * (container) object.
12341 * @param parent The parent object.
12342 * @return a new list widget handle or @c NULL, on errors.
12344 * This function inserts a new list widget on the canvas.
12348 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12353 * @param obj The list object
12355 * @note Call before running show() on the list object.
12356 * @warning If not called, it won't display the list properly.
12359 * li = elm_list_add(win);
12360 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12361 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12363 * evas_object_show(li);
12368 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12371 * Enable or disable multiple items selection on the list object.
12373 * @param obj The list object
12374 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12377 * Disabled by default. If disabled, the user can select a single item of
12378 * the list each time. Selected items are highlighted on list.
12379 * If enabled, many items can be selected.
12381 * If a selected item is selected again, it will be unselected.
12383 * @see elm_list_multi_select_get()
12387 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12390 * Get a value whether multiple items selection is enabled or not.
12392 * @see elm_list_multi_select_set() for details.
12394 * @param obj The list object.
12395 * @return @c EINA_TRUE means multiple items selection is enabled.
12396 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12397 * @c EINA_FALSE is returned.
12401 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12404 * Set which mode to use for the list object.
12406 * @param obj The list object
12407 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12408 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12410 * Set list's resize behavior, transverse axis scroll and
12411 * items cropping. See each mode's description for more details.
12413 * @note Default value is #ELM_LIST_SCROLL.
12415 * Only one can be set, if a previous one was set, it will be changed
12416 * by the new mode set. Bitmask won't work as well.
12418 * @see elm_list_mode_get()
12422 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12425 * Get the mode the list is at.
12427 * @param obj The list object
12428 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12429 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12431 * @note see elm_list_mode_set() for more information.
12435 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12438 * Enable or disable horizontal mode on the list object.
12440 * @param obj The list object.
12441 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12442 * disable it, i.e., to enable vertical mode.
12444 * @note Vertical mode is set by default.
12446 * On horizontal mode items are displayed on list from left to right,
12447 * instead of from top to bottom. Also, the list will scroll horizontally.
12448 * Each item will presents left icon on top and right icon, or end, at
12451 * @see elm_list_horizontal_get()
12455 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12458 * Get a value whether horizontal mode is enabled or not.
12460 * @param obj The list object.
12461 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12462 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12463 * @c EINA_FALSE is returned.
12465 * @see elm_list_horizontal_set() for details.
12469 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12472 * Enable or disable always select mode on the list object.
12474 * @param obj The list object
12475 * @param always_select @c EINA_TRUE to enable always select mode or
12476 * @c EINA_FALSE to disable it.
12478 * @note Always select mode is disabled by default.
12480 * Default behavior of list items is to only call its callback function
12481 * the first time it's pressed, i.e., when it is selected. If a selected
12482 * item is pressed again, and multi-select is disabled, it won't call
12483 * this function (if multi-select is enabled it will unselect the item).
12485 * If always select is enabled, it will call the callback function
12486 * everytime a item is pressed, so it will call when the item is selected,
12487 * and again when a selected item is pressed.
12489 * @see elm_list_always_select_mode_get()
12490 * @see elm_list_multi_select_set()
12494 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12497 * Get a value whether always select mode is enabled or not, meaning that
12498 * an item will always call its callback function, even if already selected.
12500 * @param obj The list object
12501 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12502 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12503 * @c EINA_FALSE is returned.
12505 * @see elm_list_always_select_mode_set() for details.
12509 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12512 * Set bouncing behaviour when the scrolled content reaches an edge.
12514 * Tell the internal scroller object whether it should bounce or not
12515 * when it reaches the respective edges for each axis.
12517 * @param obj The list object
12518 * @param h_bounce Whether to bounce or not in the horizontal axis.
12519 * @param v_bounce Whether to bounce or not in the vertical axis.
12521 * @see elm_scroller_bounce_set()
12525 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12528 * Get the bouncing behaviour of the internal scroller.
12530 * Get whether the internal scroller should bounce when the edge of each
12531 * axis is reached scrolling.
12533 * @param obj The list object.
12534 * @param h_bounce Pointer where to store the bounce state of the horizontal
12536 * @param v_bounce Pointer where to store the bounce state of the vertical
12539 * @see elm_scroller_bounce_get()
12540 * @see elm_list_bounce_set()
12544 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12547 * Set the scrollbar policy.
12549 * @param obj The list object
12550 * @param policy_h Horizontal scrollbar policy.
12551 * @param policy_v Vertical scrollbar policy.
12553 * This sets the scrollbar visibility policy for the given scroller.
12554 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12555 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12556 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12557 * This applies respectively for the horizontal and vertical scrollbars.
12559 * The both are disabled by default, i.e., are set to
12560 * #ELM_SCROLLER_POLICY_OFF.
12564 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12567 * Get the scrollbar policy.
12569 * @see elm_list_scroller_policy_get() for details.
12571 * @param obj The list object.
12572 * @param policy_h Pointer where to store horizontal scrollbar policy.
12573 * @param policy_v Pointer where to store vertical scrollbar policy.
12577 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);
12580 * Append a new item to the list object.
12582 * @param obj The list object.
12583 * @param label The label of the list item.
12584 * @param icon The icon object to use for the left side of the item. An
12585 * icon can be any Evas object, but usually it is an icon created
12586 * with elm_icon_add().
12587 * @param end The icon object to use for the right side of the item. An
12588 * icon can be any Evas object.
12589 * @param func The function to call when the item is clicked.
12590 * @param data The data to associate with the item for related callbacks.
12592 * @return The created item or @c NULL upon failure.
12594 * A new item will be created and appended to the list, i.e., will
12595 * be set as @b last item.
12597 * Items created with this method can be deleted with
12598 * elm_list_item_del().
12600 * Associated @p data can be properly freed when item is deleted if a
12601 * callback function is set with elm_list_item_del_cb_set().
12603 * If a function is passed as argument, it will be called everytime this item
12604 * is selected, i.e., the user clicks over an unselected item.
12605 * If always select is enabled it will call this function every time
12606 * user clicks over an item (already selected or not).
12607 * If such function isn't needed, just passing
12608 * @c NULL as @p func is enough. The same should be done for @p data.
12610 * Simple example (with no function callback or data associated):
12612 * li = elm_list_add(win);
12613 * ic = elm_icon_add(win);
12614 * elm_icon_file_set(ic, "path/to/image", NULL);
12615 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12616 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12618 * evas_object_show(li);
12621 * @see elm_list_always_select_mode_set()
12622 * @see elm_list_item_del()
12623 * @see elm_list_item_del_cb_set()
12624 * @see elm_list_clear()
12625 * @see elm_icon_add()
12629 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);
12632 * Prepend a new item to the list object.
12634 * @param obj The list object.
12635 * @param label The label of the list item.
12636 * @param icon The icon object to use for the left side of the item. An
12637 * icon can be any Evas object, but usually it is an icon created
12638 * with elm_icon_add().
12639 * @param end The icon object to use for the right side of the item. An
12640 * icon can be any Evas object.
12641 * @param func The function to call when the item is clicked.
12642 * @param data The data to associate with the item for related callbacks.
12644 * @return The created item or @c NULL upon failure.
12646 * A new item will be created and prepended to the list, i.e., will
12647 * be set as @b first item.
12649 * Items created with this method can be deleted with
12650 * elm_list_item_del().
12652 * Associated @p data can be properly freed when item is deleted if a
12653 * callback function is set with elm_list_item_del_cb_set().
12655 * If a function is passed as argument, it will be called everytime this item
12656 * is selected, i.e., the user clicks over an unselected item.
12657 * If always select is enabled it will call this function every time
12658 * user clicks over an item (already selected or not).
12659 * If such function isn't needed, just passing
12660 * @c NULL as @p func is enough. The same should be done for @p data.
12662 * @see elm_list_item_append() for a simple code example.
12663 * @see elm_list_always_select_mode_set()
12664 * @see elm_list_item_del()
12665 * @see elm_list_item_del_cb_set()
12666 * @see elm_list_clear()
12667 * @see elm_icon_add()
12671 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);
12674 * Insert a new item into the list object before item @p before.
12676 * @param obj The list object.
12677 * @param before The list item to insert before.
12678 * @param label The label of the list item.
12679 * @param icon The icon object to use for the left side of the item. An
12680 * icon can be any Evas object, but usually it is an icon created
12681 * with elm_icon_add().
12682 * @param end The icon object to use for the right side of the item. An
12683 * icon can be any Evas object.
12684 * @param func The function to call when the item is clicked.
12685 * @param data The data to associate with the item for related callbacks.
12687 * @return The created item or @c NULL upon failure.
12689 * A new item will be created and added to the list. Its position in
12690 * this list will be just before item @p before.
12692 * Items created with this method can be deleted with
12693 * elm_list_item_del().
12695 * Associated @p data can be properly freed when item is deleted if a
12696 * callback function is set with elm_list_item_del_cb_set().
12698 * If a function is passed as argument, it will be called everytime this item
12699 * is selected, i.e., the user clicks over an unselected item.
12700 * If always select is enabled it will call this function every time
12701 * user clicks over an item (already selected or not).
12702 * If such function isn't needed, just passing
12703 * @c NULL as @p func is enough. The same should be done for @p data.
12705 * @see elm_list_item_append() for a simple code example.
12706 * @see elm_list_always_select_mode_set()
12707 * @see elm_list_item_del()
12708 * @see elm_list_item_del_cb_set()
12709 * @see elm_list_clear()
12710 * @see elm_icon_add()
12714 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);
12717 * Insert a new item into the list object after item @p after.
12719 * @param obj The list object.
12720 * @param after The list item to insert after.
12721 * @param label The label of the list item.
12722 * @param icon The icon object to use for the left side of the item. An
12723 * icon can be any Evas object, but usually it is an icon created
12724 * with elm_icon_add().
12725 * @param end The icon object to use for the right side of the item. An
12726 * icon can be any Evas object.
12727 * @param func The function to call when the item is clicked.
12728 * @param data The data to associate with the item for related callbacks.
12730 * @return The created item or @c NULL upon failure.
12732 * A new item will be created and added to the list. Its position in
12733 * this list will be just after item @p after.
12735 * Items created with this method can be deleted with
12736 * elm_list_item_del().
12738 * Associated @p data can be properly freed when item is deleted if a
12739 * callback function is set with elm_list_item_del_cb_set().
12741 * If a function is passed as argument, it will be called everytime this item
12742 * is selected, i.e., the user clicks over an unselected item.
12743 * If always select is enabled it will call this function every time
12744 * user clicks over an item (already selected or not).
12745 * If such function isn't needed, just passing
12746 * @c NULL as @p func is enough. The same should be done for @p data.
12748 * @see elm_list_item_append() for a simple code example.
12749 * @see elm_list_always_select_mode_set()
12750 * @see elm_list_item_del()
12751 * @see elm_list_item_del_cb_set()
12752 * @see elm_list_clear()
12753 * @see elm_icon_add()
12757 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);
12760 * Insert a new item into the sorted list object.
12762 * @param obj The list object.
12763 * @param label The label of the list item.
12764 * @param icon The icon object to use for the left side of the item. An
12765 * icon can be any Evas object, but usually it is an icon created
12766 * with elm_icon_add().
12767 * @param end The icon object to use for the right side of the item. An
12768 * icon can be any Evas object.
12769 * @param func The function to call when the item is clicked.
12770 * @param data The data to associate with the item for related callbacks.
12771 * @param cmp_func The comparing function to be used to sort list
12772 * items <b>by #Elm_List_Item item handles</b>. This function will
12773 * receive two items and compare them, returning a non-negative integer
12774 * if the second item should be place after the first, or negative value
12775 * if should be placed before.
12777 * @return The created item or @c NULL upon failure.
12779 * @note This function inserts values into a list object assuming it was
12780 * sorted and the result will be sorted.
12782 * A new item will be created and added to the list. Its position in
12783 * this list will be found comparing the new item with previously inserted
12784 * items using function @p cmp_func.
12786 * Items created with this method can be deleted with
12787 * elm_list_item_del().
12789 * Associated @p data can be properly freed when item is deleted if a
12790 * callback function is set with elm_list_item_del_cb_set().
12792 * If a function is passed as argument, it will be called everytime this item
12793 * is selected, i.e., the user clicks over an unselected item.
12794 * If always select is enabled it will call this function every time
12795 * user clicks over an item (already selected or not).
12796 * If such function isn't needed, just passing
12797 * @c NULL as @p func is enough. The same should be done for @p data.
12799 * @see elm_list_item_append() for a simple code example.
12800 * @see elm_list_always_select_mode_set()
12801 * @see elm_list_item_del()
12802 * @see elm_list_item_del_cb_set()
12803 * @see elm_list_clear()
12804 * @see elm_icon_add()
12808 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);
12811 * Remove all list's items.
12813 * @param obj The list object
12815 * @see elm_list_item_del()
12816 * @see elm_list_item_append()
12820 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12823 * Get a list of all the list items.
12825 * @param obj The list object
12826 * @return An @c Eina_List of list items, #Elm_List_Item,
12827 * or @c NULL on failure.
12829 * @see elm_list_item_append()
12830 * @see elm_list_item_del()
12831 * @see elm_list_clear()
12835 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12838 * Get the selected item.
12840 * @param obj The list object.
12841 * @return The selected list item.
12843 * The selected item can be unselected with function
12844 * elm_list_item_selected_set().
12846 * The selected item always will be highlighted on list.
12848 * @see elm_list_selected_items_get()
12852 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12855 * Return a list of the currently selected list items.
12857 * @param obj The list object.
12858 * @return An @c Eina_List of list items, #Elm_List_Item,
12859 * or @c NULL on failure.
12861 * Multiple items can be selected if multi select is enabled. It can be
12862 * done with elm_list_multi_select_set().
12864 * @see elm_list_selected_item_get()
12865 * @see elm_list_multi_select_set()
12869 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12872 * Set the selected state of an item.
12874 * @param item The list item
12875 * @param selected The selected state
12877 * This sets the selected state of the given item @p it.
12878 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
12880 * If a new item is selected the previosly selected will be unselected,
12881 * unless multiple selection is enabled with elm_list_multi_select_set().
12882 * Previoulsy selected item can be get with function
12883 * elm_list_selected_item_get().
12885 * Selected items will be highlighted.
12887 * @see elm_list_item_selected_get()
12888 * @see elm_list_selected_item_get()
12889 * @see elm_list_multi_select_set()
12893 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12896 * Get whether the @p item is selected or not.
12898 * @param item The list item.
12899 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
12900 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
12902 * @see elm_list_selected_item_set() for details.
12903 * @see elm_list_item_selected_get()
12907 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12910 * Set or unset item as a separator.
12912 * @param it The list item.
12913 * @param setting @c EINA_TRUE to set item @p it as separator or
12914 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
12916 * Items aren't set as separator by default.
12918 * If set as separator it will display separator theme, so won't display
12921 * @see elm_list_item_separator_get()
12925 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
12928 * Get a value whether item is a separator or not.
12930 * @see elm_list_item_separator_set() for details.
12932 * @param it The list item.
12933 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
12934 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
12938 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
12941 * Show @p item in the list view.
12943 * @param item The list item to be shown.
12945 * It won't animate list until item is visible. If such behavior is wanted,
12946 * use elm_list_bring_in() intead.
12950 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12953 * Bring in the given item to list view.
12955 * @param item The item.
12957 * This causes list to jump to the given item @p item and show it
12958 * (by scrolling), if it is not fully visible.
12960 * This may use animation to do so and take a period of time.
12962 * If animation isn't wanted, elm_list_item_show() can be used.
12966 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12969 * Delete them item from the list.
12971 * @param item The item of list to be deleted.
12973 * If deleting all list items is required, elm_list_clear()
12974 * should be used instead of getting items list and deleting each one.
12976 * @see elm_list_clear()
12977 * @see elm_list_item_append()
12978 * @see elm_list_item_del_cb_set()
12982 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12985 * Set the function called when a list item is freed.
12987 * @param item The item to set the callback on
12988 * @param func The function called
12990 * If there is a @p func, then it will be called prior item's memory release.
12991 * That will be called with the following arguments:
12993 * @li item's Evas object;
12996 * This way, a data associated to a list item could be properly freed.
13000 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13003 * Get the data associated to the item.
13005 * @param item The list item
13006 * @return The data associated to @p item
13008 * The return value is a pointer to data associated to @p item when it was
13009 * created, with function elm_list_item_append() or similar. If no data
13010 * was passed as argument, it will return @c NULL.
13012 * @see elm_list_item_append()
13016 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13019 * Get the left side icon associated to the item.
13021 * @param item The list item
13022 * @return The left side icon associated to @p item
13024 * The return value is a pointer to the icon associated to @p item when
13026 * created, with function elm_list_item_append() or similar, or later
13027 * with function elm_list_item_icon_set(). If no icon
13028 * was passed as argument, it will return @c NULL.
13030 * @see elm_list_item_append()
13031 * @see elm_list_item_icon_set()
13035 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13038 * Set the left side icon associated to the item.
13040 * @param item The list item
13041 * @param icon The left side icon object to associate with @p item
13043 * The icon object to use at left side of the item. An
13044 * icon can be any Evas object, but usually it is an icon created
13045 * with elm_icon_add().
13047 * Once the icon object is set, a previously set one will be deleted.
13048 * @warning Setting the same icon for two items will cause the icon to
13049 * dissapear from the first item.
13051 * If an icon was passed as argument on item creation, with function
13052 * elm_list_item_append() or similar, it will be already
13053 * associated to the item.
13055 * @see elm_list_item_append()
13056 * @see elm_list_item_icon_get()
13060 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13063 * Get the right side icon associated to the item.
13065 * @param item The list item
13066 * @return The right side icon associated to @p item
13068 * The return value is a pointer to the icon associated to @p item when
13070 * created, with function elm_list_item_append() or similar, or later
13071 * with function elm_list_item_icon_set(). If no icon
13072 * was passed as argument, it will return @c NULL.
13074 * @see elm_list_item_append()
13075 * @see elm_list_item_icon_set()
13079 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13082 * Set the right side icon associated to the item.
13084 * @param item The list item
13085 * @param end The right side icon object to associate with @p item
13087 * The icon object to use at right side of the item. An
13088 * icon can be any Evas object, but usually it is an icon created
13089 * with elm_icon_add().
13091 * Once the icon object is set, a previously set one will be deleted.
13092 * @warning Setting the same icon for two items will cause the icon to
13093 * dissapear from the first item.
13095 * If an icon was passed as argument on item creation, with function
13096 * elm_list_item_append() or similar, it will be already
13097 * associated to the item.
13099 * @see elm_list_item_append()
13100 * @see elm_list_item_end_get()
13104 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13107 * Gets the base object of the item.
13109 * @param item The list item
13110 * @return The base object associated with @p item
13112 * Base object is the @c Evas_Object that represents that item.
13116 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13119 * Get the label of item.
13121 * @param item The item of list.
13122 * @return The label of item.
13124 * The return value is a pointer to the label associated to @p item when
13125 * it was created, with function elm_list_item_append(), or later
13126 * with function elm_list_item_label_set. If no label
13127 * was passed as argument, it will return @c NULL.
13129 * @see elm_list_item_label_set() for more details.
13130 * @see elm_list_item_append()
13134 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13137 * Set the label of item.
13139 * @param item The item of list.
13140 * @param text The label of item.
13142 * The label to be displayed by the item.
13143 * Label will be placed between left and right side icons (if set).
13145 * If a label was passed as argument on item creation, with function
13146 * elm_list_item_append() or similar, it will be already
13147 * displayed by the item.
13149 * @see elm_list_item_label_get()
13150 * @see elm_list_item_append()
13154 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13158 * Get the item before @p it in list.
13160 * @param it The list item.
13161 * @return The item before @p it, or @c NULL if none or on failure.
13163 * @note If it is the first item, @c NULL will be returned.
13165 * @see elm_list_item_append()
13166 * @see elm_list_items_get()
13170 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13173 * Get the item after @p it in list.
13175 * @param it The list item.
13176 * @return The item after @p it, or @c NULL if none or on failure.
13178 * @note If it is the last item, @c NULL will be returned.
13180 * @see elm_list_item_append()
13181 * @see elm_list_items_get()
13185 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13188 * Sets the disabled/enabled state of a list item.
13190 * @param it The item.
13191 * @param disabled The disabled state.
13193 * A disabled item cannot be selected or unselected. It will also
13194 * change its appearance (generally greyed out). This sets the
13195 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13200 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13203 * Get a value whether list item is disabled or not.
13205 * @param it The item.
13206 * @return The disabled state.
13208 * @see elm_list_item_disabled_set() for more details.
13212 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13215 * Set the text to be shown in a given list item's tooltips.
13217 * @param item Target item.
13218 * @param text The text to set in the content.
13220 * Setup the text as tooltip to object. The item can have only one tooltip,
13221 * so any previous tooltip data - set with this function or
13222 * elm_list_item_tooltip_content_cb_set() - is removed.
13224 * @see elm_object_tooltip_text_set() for more details.
13228 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13232 * @brief Disable size restrictions on an object's tooltip
13233 * @param item The tooltip's anchor object
13234 * @param disable If EINA_TRUE, size restrictions are disabled
13235 * @return EINA_FALSE on failure, EINA_TRUE on success
13237 * This function allows a tooltip to expand beyond its parant window's canvas.
13238 * It will instead be limited only by the size of the display.
13240 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13242 * @brief Retrieve size restriction state of an object's tooltip
13243 * @param obj The tooltip's anchor object
13244 * @return If EINA_TRUE, size restrictions are disabled
13246 * This function returns whether a tooltip is allowed to expand beyond
13247 * its parant window's canvas.
13248 * It will instead be limited only by the size of the display.
13250 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13253 * Set the content to be shown in the tooltip item.
13255 * Setup the tooltip to item. The item can have only one tooltip,
13256 * so any previous tooltip data is removed. @p func(with @p data) will
13257 * be called every time that need show the tooltip and it should
13258 * return a valid Evas_Object. This object is then managed fully by
13259 * tooltip system and is deleted when the tooltip is gone.
13261 * @param item the list item being attached a tooltip.
13262 * @param func the function used to create the tooltip contents.
13263 * @param data what to provide to @a func as callback data/context.
13264 * @param del_cb called when data is not needed anymore, either when
13265 * another callback replaces @a func, the tooltip is unset with
13266 * elm_list_item_tooltip_unset() or the owner @a item
13267 * dies. This callback receives as the first parameter the
13268 * given @a data, and @c event_info is the item.
13270 * @see elm_object_tooltip_content_cb_set() for more details.
13274 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);
13277 * Unset tooltip from item.
13279 * @param item list item to remove previously set tooltip.
13281 * Remove tooltip from item. The callback provided as del_cb to
13282 * elm_list_item_tooltip_content_cb_set() will be called to notify
13283 * it is not used anymore.
13285 * @see elm_object_tooltip_unset() for more details.
13286 * @see elm_list_item_tooltip_content_cb_set()
13290 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13293 * Sets a different style for this item tooltip.
13295 * @note before you set a style you should define a tooltip with
13296 * elm_list_item_tooltip_content_cb_set() or
13297 * elm_list_item_tooltip_text_set()
13299 * @param item list item with tooltip already set.
13300 * @param style the theme style to use (default, transparent, ...)
13302 * @see elm_object_tooltip_style_set() for more details.
13306 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13309 * Get the style for this item tooltip.
13311 * @param item list item with tooltip already set.
13312 * @return style the theme style in use, defaults to "default". If the
13313 * object does not have a tooltip set, then NULL is returned.
13315 * @see elm_object_tooltip_style_get() for more details.
13316 * @see elm_list_item_tooltip_style_set()
13320 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13323 * Set the type of mouse pointer/cursor decoration to be shown,
13324 * when the mouse pointer is over the given list widget item
13326 * @param item list item to customize cursor on
13327 * @param cursor the cursor type's name
13329 * This function works analogously as elm_object_cursor_set(), but
13330 * here the cursor's changing area is restricted to the item's
13331 * area, and not the whole widget's. Note that that item cursors
13332 * have precedence over widget cursors, so that a mouse over an
13333 * item with custom cursor set will always show @b that cursor.
13335 * If this function is called twice for an object, a previously set
13336 * cursor will be unset on the second call.
13338 * @see elm_object_cursor_set()
13339 * @see elm_list_item_cursor_get()
13340 * @see elm_list_item_cursor_unset()
13344 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13347 * Get the type of mouse pointer/cursor decoration set to be shown,
13348 * when the mouse pointer is over the given list widget item
13350 * @param item list item with custom cursor set
13351 * @return the cursor type's name or @c NULL, if no custom cursors
13352 * were set to @p item (and on errors)
13354 * @see elm_object_cursor_get()
13355 * @see elm_list_item_cursor_set()
13356 * @see elm_list_item_cursor_unset()
13360 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13363 * Unset any custom mouse pointer/cursor decoration set to be
13364 * shown, when the mouse pointer is over the given list widget
13365 * item, thus making it show the @b default cursor again.
13367 * @param item a list item
13369 * Use this call to undo any custom settings on this item's cursor
13370 * decoration, bringing it back to defaults (no custom style set).
13372 * @see elm_object_cursor_unset()
13373 * @see elm_list_item_cursor_set()
13377 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13380 * Set a different @b style for a given custom cursor set for a
13383 * @param item list item with custom cursor set
13384 * @param style the <b>theme style</b> to use (e.g. @c "default",
13385 * @c "transparent", etc)
13387 * This function only makes sense when one is using custom mouse
13388 * cursor decorations <b>defined in a theme file</b>, which can have,
13389 * given a cursor name/type, <b>alternate styles</b> on it. It
13390 * works analogously as elm_object_cursor_style_set(), but here
13391 * applyed only to list item objects.
13393 * @warning Before you set a cursor style you should have definen a
13394 * custom cursor previously on the item, with
13395 * elm_list_item_cursor_set()
13397 * @see elm_list_item_cursor_engine_only_set()
13398 * @see elm_list_item_cursor_style_get()
13402 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13405 * Get the current @b style set for a given list item's custom
13408 * @param item list item with custom cursor set.
13409 * @return style the cursor style in use. If the object does not
13410 * have a cursor set, then @c NULL is returned.
13412 * @see elm_list_item_cursor_style_set() for more details
13416 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13419 * Set if the (custom)cursor for a given list item should be
13420 * searched in its theme, also, or should only rely on the
13421 * rendering engine.
13423 * @param item item with custom (custom) cursor already set on
13424 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13425 * only on those provided by the rendering engine, @c EINA_FALSE to
13426 * have them searched on the widget's theme, as well.
13428 * @note This call is of use only if you've set a custom cursor
13429 * for list items, with elm_list_item_cursor_set().
13431 * @note By default, cursors will only be looked for between those
13432 * provided by the rendering engine.
13436 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13439 * Get if the (custom) cursor for a given list item is being
13440 * searched in its theme, also, or is only relying on the rendering
13443 * @param item a list item
13444 * @return @c EINA_TRUE, if cursors are being looked for only on
13445 * those provided by the rendering engine, @c EINA_FALSE if they
13446 * are being searched on the widget's theme, as well.
13448 * @see elm_list_item_cursor_engine_only_set(), for more details
13452 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13459 * @defgroup Slider Slider
13460 * @ingroup Elementary
13462 * @image html img/widget/slider/preview-00.png
13463 * @image latex img/widget/slider/preview-00.eps width=\textwidth
13465 * The slider adds a dragable “slider” widget for selecting the value of
13466 * something within a range.
13468 * A slider can be horizontal or vertical. It can contain an Icon and has a
13469 * primary label as well as a units label (that is formatted with floating
13470 * point values and thus accepts a printf-style format string, like
13471 * “%1.2f units”. There is also an indicator string that may be somewhere
13472 * else (like on the slider itself) that also accepts a format string like
13473 * units. Label, Icon Unit and Indicator strings/objects are optional.
13475 * A slider may be inverted which means values invert, with high vales being
13476 * on the left or top and low values on the right or bottom (as opposed to
13477 * normally being low on the left or top and high on the bottom and right).
13479 * The slider should have its minimum and maximum values set by the
13480 * application with elm_slider_min_max_set() and value should also be set by
13481 * the application before use with elm_slider_value_set(). The span of the
13482 * slider is its length (horizontally or vertically). This will be scaled by
13483 * the object or applications scaling factor. At any point code can query the
13484 * slider for its value with elm_slider_value_get().
13486 * Smart callbacks one can listen to:
13487 * - "changed" - Whenever the slider value is changed by the user.
13488 * - "slider,drag,start" - dragging the slider indicator around has started.
13489 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13490 * - "delay,changed" - A short time after the value is changed by the user.
13491 * This will be called only when the user stops dragging for
13492 * a very short period or when they release their
13493 * finger/mouse, so it avoids possibly expensive reactions to
13494 * the value change.
13496 * Available styles for it:
13499 * Here is an example on its usage:
13500 * @li @ref slider_example
13504 * @addtogroup Slider
13509 * Add a new slider widget to the given parent Elementary
13510 * (container) object.
13512 * @param parent The parent object.
13513 * @return a new slider widget handle or @c NULL, on errors.
13515 * This function inserts a new slider widget on the canvas.
13519 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13522 * Set the label of a given slider widget
13524 * @param obj The progress bar object
13525 * @param label The text label string, in UTF-8
13528 * @deprecated use elm_object_text_set() instead.
13530 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13533 * Get the label of a given slider widget
13535 * @param obj The progressbar object
13536 * @return The text label string, in UTF-8
13539 * @deprecated use elm_object_text_get() instead.
13541 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13544 * Set the icon object of the slider object.
13546 * @param obj The slider object.
13547 * @param icon The icon object.
13549 * On horizontal mode, icon is placed at left, and on vertical mode,
13552 * @note Once the icon object is set, a previously set one will be deleted.
13553 * If you want to keep that old content object, use the
13554 * elm_slider_icon_unset() function.
13556 * @warning If the object being set does not have minimum size hints set,
13557 * it won't get properly displayed.
13561 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13564 * Unset an icon set on a given slider widget.
13566 * @param obj The slider object.
13567 * @return The icon object that was being used, if any was set, or
13568 * @c NULL, otherwise (and on errors).
13570 * On horizontal mode, icon is placed at left, and on vertical mode,
13573 * This call will unparent and return the icon object which was set
13574 * for this widget, previously, on success.
13576 * @see elm_slider_icon_set() for more details
13577 * @see elm_slider_icon_get()
13581 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13584 * Retrieve the icon object set for a given slider widget.
13586 * @param obj The slider object.
13587 * @return The icon object's handle, if @p obj had one set, or @c NULL,
13588 * otherwise (and on errors).
13590 * On horizontal mode, icon is placed at left, and on vertical mode,
13593 * @see elm_slider_icon_set() for more details
13594 * @see elm_slider_icon_unset()
13598 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13601 * Set the end object of the slider object.
13603 * @param obj The slider object.
13604 * @param end The end object.
13606 * On horizontal mode, end is placed at left, and on vertical mode,
13607 * placed at bottom.
13609 * @note Once the icon object is set, a previously set one will be deleted.
13610 * If you want to keep that old content object, use the
13611 * elm_slider_end_unset() function.
13613 * @warning If the object being set does not have minimum size hints set,
13614 * it won't get properly displayed.
13618 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13621 * Unset an end object set on a given slider widget.
13623 * @param obj The slider object.
13624 * @return The end object that was being used, if any was set, or
13625 * @c NULL, otherwise (and on errors).
13627 * On horizontal mode, end is placed at left, and on vertical mode,
13628 * placed at bottom.
13630 * This call will unparent and return the icon object which was set
13631 * for this widget, previously, on success.
13633 * @see elm_slider_end_set() for more details.
13634 * @see elm_slider_end_get()
13638 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13641 * Retrieve the end object set for a given slider widget.
13643 * @param obj The slider object.
13644 * @return The end object's handle, if @p obj had one set, or @c NULL,
13645 * otherwise (and on errors).
13647 * On horizontal mode, icon is placed at right, and on vertical mode,
13648 * placed at bottom.
13650 * @see elm_slider_end_set() for more details.
13651 * @see elm_slider_end_unset()
13655 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13658 * Set the (exact) length of the bar region of a given slider widget.
13660 * @param obj The slider object.
13661 * @param size The length of the slider's bar region.
13663 * This sets the minimum width (when in horizontal mode) or height
13664 * (when in vertical mode) of the actual bar area of the slider
13665 * @p obj. This in turn affects the object's minimum size. Use
13666 * this when you're not setting other size hints expanding on the
13667 * given direction (like weight and alignment hints) and you would
13668 * like it to have a specific size.
13670 * @note Icon, end, label, indicator and unit text around @p obj
13671 * will require their
13672 * own space, which will make @p obj to require more the @p size,
13675 * @see elm_slider_span_size_get()
13679 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13682 * Get the length set for the bar region of a given slider widget
13684 * @param obj The slider object.
13685 * @return The length of the slider's bar region.
13687 * If that size was not set previously, with
13688 * elm_slider_span_size_set(), this call will return @c 0.
13692 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13695 * Set the format string for the unit label.
13697 * @param obj The slider object.
13698 * @param format The format string for the unit display.
13700 * Unit label is displayed all the time, if set, after slider's bar.
13701 * In horizontal mode, at right and in vertical mode, at bottom.
13703 * If @c NULL, unit label won't be visible. If not it sets the format
13704 * string for the label text. To the label text is provided a floating point
13705 * value, so the label text can display up to 1 floating point value.
13706 * Note that this is optional.
13708 * Use a format string such as "%1.2f meters" for example, and it will
13709 * display values like: "3.14 meters" for a value equal to 3.14159.
13711 * Default is unit label disabled.
13713 * @see elm_slider_indicator_format_get()
13717 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13720 * Get the unit label format of the slider.
13722 * @param obj The slider object.
13723 * @return The unit label format string in UTF-8.
13725 * Unit label is displayed all the time, if set, after slider's bar.
13726 * In horizontal mode, at right and in vertical mode, at bottom.
13728 * @see elm_slider_unit_format_set() for more
13729 * information on how this works.
13733 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13736 * Set the format string for the indicator label.
13738 * @param obj The slider object.
13739 * @param indicator The format string for the indicator display.
13741 * The slider may display its value somewhere else then unit label,
13742 * for example, above the slider knob that is dragged around. This function
13743 * sets the format string used for this.
13745 * If @c NULL, indicator label won't be visible. If not it sets the format
13746 * string for the label text. To the label text is provided a floating point
13747 * value, so the label text can display up to 1 floating point value.
13748 * Note that this is optional.
13750 * Use a format string such as "%1.2f meters" for example, and it will
13751 * display values like: "3.14 meters" for a value equal to 3.14159.
13753 * Default is indicator label disabled.
13755 * @see elm_slider_indicator_format_get()
13759 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
13762 * Get the indicator label format of the slider.
13764 * @param obj The slider object.
13765 * @return The indicator label format string in UTF-8.
13767 * The slider may display its value somewhere else then unit label,
13768 * for example, above the slider knob that is dragged around. This function
13769 * gets the format string used for this.
13771 * @see elm_slider_indicator_format_set() for more
13772 * information on how this works.
13776 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13779 * Set the format function pointer for the indicator label
13781 * @param obj The slider object.
13782 * @param func The indicator format function.
13783 * @param free_func The freeing function for the format string.
13785 * Set the callback function to format the indicator string.
13787 * @see elm_slider_indicator_format_set() for more info on how this works.
13791 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);
13794 * Set the format function pointer for the units label
13796 * @param obj The slider object.
13797 * @param func The units format function.
13798 * @param free_func The freeing function for the format string.
13800 * Set the callback function to format the indicator string.
13802 * @see elm_slider_units_format_set() for more info on how this works.
13806 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);
13809 * Set the orientation of a given slider widget.
13811 * @param obj The slider object.
13812 * @param horizontal Use @c EINA_TRUE to make @p obj to be
13813 * @b horizontal, @c EINA_FALSE to make it @b vertical.
13815 * Use this function to change how your slider is to be
13816 * disposed: vertically or horizontally.
13818 * By default it's displayed horizontally.
13820 * @see elm_slider_horizontal_get()
13824 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13827 * Retrieve the orientation of a given slider widget
13829 * @param obj The slider object.
13830 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
13831 * @c EINA_FALSE if it's @b vertical (and on errors).
13833 * @see elm_slider_horizontal_set() for more details.
13837 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13840 * Set the minimum and maximum values for the slider.
13842 * @param obj The slider object.
13843 * @param min The minimum value.
13844 * @param max The maximum value.
13846 * Define the allowed range of values to be selected by the user.
13848 * If actual value is less than @p min, it will be updated to @p min. If it
13849 * is bigger then @p max, will be updated to @p max. Actual value can be
13850 * get with elm_slider_value_get().
13852 * By default, min is equal to 0.0, and max is equal to 1.0.
13854 * @warning Maximum must be greater than minimum, otherwise behavior
13857 * @see elm_slider_min_max_get()
13861 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
13864 * Get the minimum and maximum values of the slider.
13866 * @param obj The slider object.
13867 * @param min Pointer where to store the minimum value.
13868 * @param max Pointer where to store the maximum value.
13870 * @note If only one value is needed, the other pointer can be passed
13873 * @see elm_slider_min_max_set() for details.
13877 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
13880 * Set the value the slider displays.
13882 * @param obj The slider object.
13883 * @param val The value to be displayed.
13885 * Value will be presented on the unit label following format specified with
13886 * elm_slider_unit_format_set() and on indicator with
13887 * elm_slider_indicator_format_set().
13889 * @warning The value must to be between min and max values. This values
13890 * are set by elm_slider_min_max_set().
13892 * @see elm_slider_value_get()
13893 * @see elm_slider_unit_format_set()
13894 * @see elm_slider_indicator_format_set()
13895 * @see elm_slider_min_max_set()
13899 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
13902 * Get the value displayed by the spinner.
13904 * @param obj The spinner object.
13905 * @return The value displayed.
13907 * @see elm_spinner_value_set() for details.
13911 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13914 * Invert a given slider widget's displaying values order
13916 * @param obj The slider object.
13917 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
13918 * @c EINA_FALSE to bring it back to default, non-inverted values.
13920 * A slider may be @b inverted, in which state it gets its
13921 * values inverted, with high vales being on the left or top and
13922 * low values on the right or bottom, as opposed to normally have
13923 * the low values on the former and high values on the latter,
13924 * respectively, for horizontal and vertical modes.
13926 * @see elm_slider_inverted_get()
13930 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
13933 * Get whether a given slider widget's displaying values are
13936 * @param obj The slider object.
13937 * @return @c EINA_TRUE, if @p obj has inverted values,
13938 * @c EINA_FALSE otherwise (and on errors).
13940 * @see elm_slider_inverted_set() for more details.
13944 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13947 * Set whether to enlarge slider indicator (augmented knob) or not.
13949 * @param obj The slider object.
13950 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
13951 * let the knob always at default size.
13953 * By default, indicator will be bigger while dragged by the user.
13955 * @warning It won't display values set with
13956 * elm_slider_indicator_format_set() if you disable indicator.
13960 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
13963 * Get whether a given slider widget's enlarging indicator or not.
13965 * @param obj The slider object.
13966 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
13967 * @c EINA_FALSE otherwise (and on errors).
13969 * @see elm_slider_indicator_show_set() for details.
13973 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13980 * @addtogroup Actionslider Actionslider
13982 * @image html img/widget/actionslider/preview-00.png
13983 * @image latex img/widget/actionslider/preview-00.eps
13985 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
13986 * properties. The indicator is the element the user drags to choose a label.
13987 * When the position is set with magnet, when released the indicator will be
13988 * moved to it if it's nearest the magnetized position.
13990 * @note By default all positions are set as enabled.
13992 * Signals that you can add callbacks for are:
13994 * "selected" - when user selects an enabled position (the label is passed
13997 * "pos_changed" - when the indicator reaches any of the positions("left",
13998 * "right" or "center").
14000 * See an example of actionslider usage @ref actionslider_example_page "here"
14003 typedef enum _Elm_Actionslider_Pos
14005 ELM_ACTIONSLIDER_NONE = 0,
14006 ELM_ACTIONSLIDER_LEFT = 1 << 0,
14007 ELM_ACTIONSLIDER_CENTER = 1 << 1,
14008 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
14009 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
14010 } Elm_Actionslider_Pos;
14013 * Add a new actionslider to the parent.
14015 * @param parent The parent object
14016 * @return The new actionslider object or NULL if it cannot be created
14018 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14020 * Set actionslider labels.
14022 * @param obj The actionslider object
14023 * @param left_label The label to be set on the left.
14024 * @param center_label The label to be set on the center.
14025 * @param right_label The label to be set on the right.
14026 * @deprecated use elm_object_text_set() instead.
14028 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);
14030 * Get actionslider labels.
14032 * @param obj The actionslider object
14033 * @param left_label A char** to place the left_label of @p obj into.
14034 * @param center_label A char** to place the center_label of @p obj into.
14035 * @param right_label A char** to place the right_label of @p obj into.
14036 * @deprecated use elm_object_text_set() instead.
14038 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);
14040 * Get actionslider selected label.
14042 * @param obj The actionslider object
14043 * @return The selected label
14045 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14047 * Set actionslider indicator position.
14049 * @param obj The actionslider object.
14050 * @param pos The position of the indicator.
14052 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14054 * Get actionslider indicator position.
14056 * @param obj The actionslider object.
14057 * @return The position of the indicator.
14059 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14061 * Set actionslider magnet position. To make multiple positions magnets @c or
14062 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14064 * @param obj The actionslider object.
14065 * @param pos Bit mask indicating the magnet positions.
14067 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14069 * Get actionslider magnet position.
14071 * @param obj The actionslider object.
14072 * @return The positions with magnet property.
14074 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14076 * Set actionslider enabled position. To set multiple positions as enabled @c or
14077 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14079 * @note All the positions are enabled by default.
14081 * @param obj The actionslider object.
14082 * @param pos Bit mask indicating the enabled positions.
14084 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14086 * Get actionslider enabled position.
14088 * @param obj The actionslider object.
14089 * @return The enabled positions.
14091 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14093 * Set the label used on the indicator.
14095 * @param obj The actionslider object
14096 * @param label The label to be set on the indicator.
14097 * @deprecated use elm_object_text_set() instead.
14099 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14101 * Get the label used on the indicator object.
14103 * @param obj The actionslider object
14104 * @return The indicator label
14105 * @deprecated use elm_object_text_get() instead.
14107 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14113 * @defgroup Genlist Genlist
14115 * @image html img/widget/genlist/preview-00.png
14116 * @image latex img/widget/genlist/preview-00.eps
14117 * @image html img/genlist.png
14118 * @image latex img/genlist.eps
14120 * This widget aims to have more expansive list than the simple list in
14121 * Elementary that could have more flexible items and allow many more entries
14122 * while still being fast and low on memory usage. At the same time it was
14123 * also made to be able to do tree structures. But the price to pay is more
14124 * complexity when it comes to usage. If all you want is a simple list with
14125 * icons and a single label, use the normal @ref List object.
14127 * Genlist has a fairly large API, mostly because it's relatively complex,
14128 * trying to be both expansive, powerful and efficient. First we will begin
14129 * an overview on the theory behind genlist.
14131 * @section Genlist_Item_Class Genlist item classes - creating items
14133 * In order to have the ability to add and delete items on the fly, genlist
14134 * implements a class (callback) system where the application provides a
14135 * structure with information about that type of item (genlist may contain
14136 * multiple different items with different classes, states and styles).
14137 * Genlist will call the functions in this struct (methods) when an item is
14138 * "realized" (i.e., created dynamically, while the user is scrolling the
14139 * grid). All objects will simply be deleted when no longer needed with
14140 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14141 * following members:
14142 * - @c item_style - This is a constant string and simply defines the name
14143 * of the item style. It @b must be specified and the default should be @c
14146 * - @c func - A struct with pointers to functions that will be called when
14147 * an item is going to be actually created. All of them receive a @c data
14148 * parameter that will point to the same data passed to
14149 * elm_genlist_item_append() and related item creation functions, and a @c
14150 * obj parameter that points to the genlist object itself.
14152 * The function pointers inside @c func are @c label_get, @c icon_get, @c
14153 * state_get and @c del. The 3 first functions also receive a @c part
14154 * parameter described below. A brief description of these functions follows:
14156 * - @c label_get - The @c part parameter is the name string of one of the
14157 * existing text parts in the Edje group implementing the item's theme.
14158 * This function @b must return a strdup'()ed string, as the caller will
14159 * free() it when done. See #GenlistItemLabelGetFunc.
14160 * - @c icon_get - The @c part parameter is the name string of one of the
14161 * existing (icon) swallow parts in the Edje group implementing the item's
14162 * theme. It must return @c NULL, when no icon is desired, or a valid
14163 * object handle, otherwise. The object will be deleted by the genlist on
14164 * its deletion or when the item is "unrealized". See
14165 * #GenlistItemIconGetFunc.
14166 * - @c func.state_get - The @c part parameter is the name string of one of
14167 * the state parts in the Edje group implementing the item's theme. Return
14168 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14169 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14170 * and @c "elm" as "emission" and "source" arguments, respectively, when
14171 * the state is true (the default is false), where @c XXX is the name of
14172 * the (state) part. See #GenlistItemStateGetFunc.
14173 * - @c func.del - This is intended for use when genlist items are deleted,
14174 * so any data attached to the item (e.g. its data parameter on creation)
14175 * can be deleted. See #GenlistItemDelFunc.
14177 * available item styles:
14179 * - default_style - The text part is a textblock
14181 * @image html img/widget/genlist/preview-04.png
14182 * @image latex img/widget/genlist/preview-04.eps
14186 * @image html img/widget/genlist/preview-01.png
14187 * @image latex img/widget/genlist/preview-01.eps
14189 * - icon_top_text_bottom
14191 * @image html img/widget/genlist/preview-02.png
14192 * @image latex img/widget/genlist/preview-02.eps
14196 * @image html img/widget/genlist/preview-03.png
14197 * @image latex img/widget/genlist/preview-03.eps
14199 * @section Genlist_Items Structure of items
14201 * An item in a genlist can have 0 or more text labels (they can be regular
14202 * text or textblock Evas objects - that's up to the style to determine), 0
14203 * or more icons (which are simply objects swallowed into the genlist item's
14204 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14205 * behavior left to the user to define. The Edje part names for each of
14206 * these properties will be looked up, in the theme file for the genlist,
14207 * under the Edje (string) data items named @c "labels", @c "icons" and @c
14208 * "states", respectively. For each of those properties, if more than one
14209 * part is provided, they must have names listed separated by spaces in the
14210 * data fields. For the default genlist item theme, we have @b one label
14211 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14212 * "elm.swallow.end") and @b no state parts.
14214 * A genlist item may be at one of several styles. Elementary provides one
14215 * by default - "default", but this can be extended by system or application
14216 * custom themes/overlays/extensions (see @ref Theme "themes" for more
14219 * @section Genlist_Manipulation Editing and Navigating
14221 * Items can be added by several calls. All of them return a @ref
14222 * Elm_Genlist_Item handle that is an internal member inside the genlist.
14223 * They all take a data parameter that is meant to be used for a handle to
14224 * the applications internal data (eg the struct with the original item
14225 * data). The parent parameter is the parent genlist item this belongs to if
14226 * it is a tree or an indexed group, and NULL if there is no parent. The
14227 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14228 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14229 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14230 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
14231 * is set then this item is group index item that is displayed at the top
14232 * until the next group comes. The func parameter is a convenience callback
14233 * that is called when the item is selected and the data parameter will be
14234 * the func_data parameter, obj be the genlist object and event_info will be
14235 * the genlist item.
14237 * elm_genlist_item_append() adds an item to the end of the list, or if
14238 * there is a parent, to the end of all the child items of the parent.
14239 * elm_genlist_item_prepend() is the same but adds to the beginning of
14240 * the list or children list. elm_genlist_item_insert_before() inserts at
14241 * item before another item and elm_genlist_item_insert_after() inserts after
14242 * the indicated item.
14244 * The application can clear the list with elm_genlist_clear() which deletes
14245 * all the items in the list and elm_genlist_item_del() will delete a specific
14246 * item. elm_genlist_item_subitems_clear() will clear all items that are
14247 * children of the indicated parent item.
14249 * To help inspect list items you can jump to the item at the top of the list
14250 * with elm_genlist_first_item_get() which will return the item pointer, and
14251 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14252 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14253 * and previous items respectively relative to the indicated item. Using
14254 * these calls you can walk the entire item list/tree. Note that as a tree
14255 * the items are flattened in the list, so elm_genlist_item_parent_get() will
14256 * let you know which item is the parent (and thus know how to skip them if
14259 * @section Genlist_Muti_Selection Multi-selection
14261 * If the application wants multiple items to be able to be selected,
14262 * elm_genlist_multi_select_set() can enable this. If the list is
14263 * single-selection only (the default), then elm_genlist_selected_item_get()
14264 * will return the selected item, if any, or NULL I none is selected. If the
14265 * list is multi-select then elm_genlist_selected_items_get() will return a
14266 * list (that is only valid as long as no items are modified (added, deleted,
14267 * selected or unselected)).
14269 * @section Genlist_Usage_Hints Usage hints
14271 * There are also convenience functions. elm_genlist_item_genlist_get() will
14272 * return the genlist object the item belongs to. elm_genlist_item_show()
14273 * will make the scroller scroll to show that specific item so its visible.
14274 * elm_genlist_item_data_get() returns the data pointer set by the item
14275 * creation functions.
14277 * If an item changes (state of boolean changes, label or icons change),
14278 * then use elm_genlist_item_update() to have genlist update the item with
14279 * the new state. Genlist will re-realize the item thus call the functions
14280 * in the _Elm_Genlist_Item_Class for that item.
14282 * To programmatically (un)select an item use elm_genlist_item_selected_set().
14283 * To get its selected state use elm_genlist_item_selected_get(). Similarly
14284 * to expand/contract an item and get its expanded state, use
14285 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14286 * again to make an item disabled (unable to be selected and appear
14287 * differently) use elm_genlist_item_disabled_set() to set this and
14288 * elm_genlist_item_disabled_get() to get the disabled state.
14290 * In general to indicate how the genlist should expand items horizontally to
14291 * fill the list area, use elm_genlist_horizontal_mode_set(). Valid modes are
14292 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14293 * mode means that if items are too wide to fit, the scroller will scroll
14294 * horizontally. Otherwise items are expanded to fill the width of the
14295 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14296 * to the viewport width and limited to that size. This can be combined with
14297 * a different style that uses edjes' ellipsis feature (cutting text off like
14300 * Items will only call their selection func and callback when first becoming
14301 * selected. Any further clicks will do nothing, unless you enable always
14302 * select with elm_genlist_always_select_mode_set(). This means even if
14303 * selected, every click will make the selected callbacks be called.
14304 * elm_genlist_no_select_mode_set() will turn off the ability to select
14305 * items entirely and they will neither appear selected nor call selected
14306 * callback functions.
14308 * Remember that you can create new styles and add your own theme augmentation
14309 * per application with elm_theme_extension_add(). If you absolutely must
14310 * have a specific style that overrides any theme the user or system sets up
14311 * you can use elm_theme_overlay_add() to add such a file.
14313 * @section Genlist_Implementation Implementation
14315 * Evas tracks every object you create. Every time it processes an event
14316 * (mouse move, down, up etc.) it needs to walk through objects and find out
14317 * what event that affects. Even worse every time it renders display updates,
14318 * in order to just calculate what to re-draw, it needs to walk through many
14319 * many many objects. Thus, the more objects you keep active, the more
14320 * overhead Evas has in just doing its work. It is advisable to keep your
14321 * active objects to the minimum working set you need. Also remember that
14322 * object creation and deletion carries an overhead, so there is a
14323 * middle-ground, which is not easily determined. But don't keep massive lists
14324 * of objects you can't see or use. Genlist does this with list objects. It
14325 * creates and destroys them dynamically as you scroll around. It groups them
14326 * into blocks so it can determine the visibility etc. of a whole block at
14327 * once as opposed to having to walk the whole list. This 2-level list allows
14328 * for very large numbers of items to be in the list (tests have used up to
14329 * 2,000,000 items). Also genlist employs a queue for adding items. As items
14330 * may be different sizes, every item added needs to be calculated as to its
14331 * size and thus this presents a lot of overhead on populating the list, this
14332 * genlist employs a queue. Any item added is queued and spooled off over
14333 * time, actually appearing some time later, so if your list has many members
14334 * you may find it takes a while for them to all appear, with your process
14335 * consuming a lot of CPU while it is busy spooling.
14337 * Genlist also implements a tree structure, but it does so with callbacks to
14338 * the application, with the application filling in tree structures when
14339 * requested (allowing for efficient building of a very deep tree that could
14340 * even be used for file-management). See the above smart signal callbacks for
14343 * @section Genlist_Smart_Events Genlist smart events
14345 * Signals that you can add callbacks for are:
14346 * - @c "activated" - The user has double-clicked or pressed
14347 * (enter|return|spacebar) on an item. The @c event_info parameter is the
14348 * item that was activated.
14349 * - @c "clicked,double" - The user has double-clicked an item. The @c
14350 * event_info parameter is the item that was double-clicked.
14351 * - @c "selected" - This is called when a user has made an item selected.
14352 * The event_info parameter is the genlist item that was selected.
14353 * - @c "unselected" - This is called when a user has made an item
14354 * unselected. The event_info parameter is the genlist item that was
14356 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14357 * called and the item is now meant to be expanded. The event_info
14358 * parameter is the genlist item that was indicated to expand. It is the
14359 * job of this callback to then fill in the child items.
14360 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14361 * called and the item is now meant to be contracted. The event_info
14362 * parameter is the genlist item that was indicated to contract. It is the
14363 * job of this callback to then delete the child items.
14364 * - @c "expand,request" - This is called when a user has indicated they want
14365 * to expand a tree branch item. The callback should decide if the item can
14366 * expand (has any children) and then call elm_genlist_item_expanded_set()
14367 * appropriately to set the state. The event_info parameter is the genlist
14368 * item that was indicated to expand.
14369 * - @c "contract,request" - This is called when a user has indicated they
14370 * want to contract a tree branch item. The callback should decide if the
14371 * item can contract (has any children) and then call
14372 * elm_genlist_item_expanded_set() appropriately to set the state. The
14373 * event_info parameter is the genlist item that was indicated to contract.
14374 * - @c "realized" - This is called when the item in the list is created as a
14375 * real evas object. event_info parameter is the genlist item that was
14376 * created. The object may be deleted at any time, so it is up to the
14377 * caller to not use the object pointer from elm_genlist_item_object_get()
14378 * in a way where it may point to freed objects.
14379 * - @c "unrealized" - This is called just before an item is unrealized.
14380 * After this call icon objects provided will be deleted and the item
14381 * object itself delete or be put into a floating cache.
14382 * - @c "drag,start,up" - This is called when the item in the list has been
14383 * dragged (not scrolled) up.
14384 * - @c "drag,start,down" - This is called when the item in the list has been
14385 * dragged (not scrolled) down.
14386 * - @c "drag,start,left" - This is called when the item in the list has been
14387 * dragged (not scrolled) left.
14388 * - @c "drag,start,right" - This is called when the item in the list has
14389 * been dragged (not scrolled) right.
14390 * - @c "drag,stop" - This is called when the item in the list has stopped
14392 * - @c "drag" - This is called when the item in the list is being dragged.
14393 * - @c "longpressed" - This is called when the item is pressed for a certain
14394 * amount of time. By default it's 1 second.
14395 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14397 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14398 * until the bottom edge.
14399 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14400 * until the left edge.
14401 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14402 * until the right edge.
14403 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14405 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14407 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14409 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14411 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14412 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
14413 * multi-touch pinched in.
14414 * - @c "swipe" - This is called when the genlist is swiped.
14416 * @section Genlist_Examples Examples
14418 * Here is a list of examples that use the genlist, trying to show some of
14419 * its capabilities:
14420 * - @ref genlist_example_01
14421 * - @ref genlist_example_02
14422 * - @ref genlist_example_03
14423 * - @ref genlist_example_04
14424 * - @ref genlist_example_05
14428 * @addtogroup Genlist
14433 * @enum _Elm_Genlist_Item_Flags
14434 * @typedef Elm_Genlist_Item_Flags
14436 * Defines if the item is of any special type (has subitems or it's the
14437 * index of a group), or is just a simple item.
14441 typedef enum _Elm_Genlist_Item_Flags
14443 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14444 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14445 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14446 } Elm_Genlist_Item_Flags;
14447 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
14448 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14449 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14450 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14451 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
14452 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
14453 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14454 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
14457 * @struct _Elm_Genlist_Item_Class
14459 * Genlist item class definition structs.
14461 * This struct contains the style and fetching functions that will define the
14462 * contents of each item.
14464 * @see @ref Genlist_Item_Class
14466 struct _Elm_Genlist_Item_Class
14468 const char *item_style; /**< style of this class. */
14471 GenlistItemLabelGetFunc label_get; /**< Label fetching class function for genlist item classes.*/
14472 GenlistItemIconGetFunc icon_get; /**< Icon fetching class function for genlist item classes. */
14473 GenlistItemStateGetFunc state_get; /**< State fetching class function for genlist item classes. */
14474 GenlistItemDelFunc del; /**< Deletion class function for genlist item classes. */
14475 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
14477 const char *mode_item_style;
14481 * Add a new genlist widget to the given parent Elementary
14482 * (container) object
14484 * @param parent The parent object
14485 * @return a new genlist widget handle or @c NULL, on errors
14487 * This function inserts a new genlist widget on the canvas.
14489 * @see elm_genlist_item_append()
14490 * @see elm_genlist_item_del()
14491 * @see elm_genlist_clear()
14495 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14497 * Remove all items from a given genlist widget.
14499 * @param obj The genlist object
14501 * This removes (and deletes) all items in @p obj, leaving it empty.
14503 * @see elm_genlist_item_del(), to remove just one item.
14507 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14509 * Enable or disable multi-selection in the genlist
14511 * @param obj The genlist object
14512 * @param multi Multi-select enable/disable. Default is disabled.
14514 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14515 * the list. This allows more than 1 item to be selected. To retrieve the list
14516 * of selected items, use elm_genlist_selected_items_get().
14518 * @see elm_genlist_selected_items_get()
14519 * @see elm_genlist_multi_select_get()
14523 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14525 * Gets if multi-selection in genlist is enabled or disabled.
14527 * @param obj The genlist object
14528 * @return Multi-select enabled/disabled
14529 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14531 * @see elm_genlist_multi_select_set()
14535 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14537 * This sets the horizontal stretching mode.
14539 * @param obj The genlist object
14540 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14542 * This sets the mode used for sizing items horizontally. Valid modes
14543 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14544 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14545 * the scroller will scroll horizontally. Otherwise items are expanded
14546 * to fill the width of the viewport of the scroller. If it is
14547 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14548 * limited to that size.
14550 * @see elm_genlist_horizontal_mode_get()
14554 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14556 * Gets the horizontal stretching mode.
14558 * @param obj The genlist object
14559 * @return The mode to use
14560 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14562 * @see elm_genlist_horizontal_mode_set()
14566 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14568 * Set the always select mode.
14570 * @param obj The genlist object
14571 * @param always_select The always select mode (@c EINA_TRUE = on, @c
14572 * EINA_FALSE = off). Default is @c EINA_FALSE.
14574 * Items will only call their selection func and callback when first
14575 * becoming selected. Any further clicks will do nothing, unless you
14576 * enable always select with elm_genlist_always_select_mode_set().
14577 * This means that, even if selected, every click will make the selected
14578 * callbacks be called.
14580 * @see elm_genlist_always_select_mode_get()
14584 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14586 * Get the always select mode.
14588 * @param obj The genlist object
14589 * @return The always select mode
14590 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14592 * @see elm_genlist_always_select_mode_set()
14596 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14598 * Enable/disable the no select mode.
14600 * @param obj The genlist object
14601 * @param no_select The no select mode
14602 * (EINA_TRUE = on, EINA_FALSE = off)
14604 * This will turn off the ability to select items entirely and they
14605 * will neither appear selected nor call selected callback functions.
14607 * @see elm_genlist_no_select_mode_get()
14611 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14613 * Gets whether the no select mode is enabled.
14615 * @param obj The genlist object
14616 * @return The no select mode
14617 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14619 * @see elm_genlist_no_select_mode_set()
14623 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14625 * Enable/disable compress mode.
14627 * @param obj The genlist object
14628 * @param compress The compress mode
14629 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14631 * This will enable the compress mode where items are "compressed"
14632 * horizontally to fit the genlist scrollable viewport width. This is
14633 * special for genlist. Do not rely on
14634 * elm_genlist_horizontal_mode_set() being set to @c ELM_LIST_COMPRESS to
14635 * work as genlist needs to handle it specially.
14637 * @see elm_genlist_compress_mode_get()
14641 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14643 * Get whether the compress mode is enabled.
14645 * @param obj The genlist object
14646 * @return The compress mode
14647 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14649 * @see elm_genlist_compress_mode_set()
14653 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14655 * Enable/disable height-for-width mode.
14657 * @param obj The genlist object
14658 * @param setting The height-for-width mode (@c EINA_TRUE = on,
14659 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14661 * With height-for-width mode the item width will be fixed (restricted
14662 * to a minimum of) to the list width when calculating its size in
14663 * order to allow the height to be calculated based on it. This allows,
14664 * for instance, text block to wrap lines if the Edje part is
14665 * configured with "text.min: 0 1".
14667 * @note This mode will make list resize slower as it will have to
14668 * recalculate every item height again whenever the list width
14671 * @note When height-for-width mode is enabled, it also enables
14672 * compress mode (see elm_genlist_compress_mode_set()) and
14673 * disables homogeneous (see elm_genlist_homogeneous_set()).
14677 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14679 * Get whether the height-for-width mode is enabled.
14681 * @param obj The genlist object
14682 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14687 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14689 * Enable/disable horizontal and vertical bouncing effect.
14691 * @param obj The genlist object
14692 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14693 * EINA_FALSE = off). Default is @c EINA_FALSE.
14694 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14695 * EINA_FALSE = off). Default is @c EINA_TRUE.
14697 * This will enable or disable the scroller bouncing effect for the
14698 * genlist. See elm_scroller_bounce_set() for details.
14700 * @see elm_scroller_bounce_set()
14701 * @see elm_genlist_bounce_get()
14705 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14707 * Get whether the horizontal and vertical bouncing effect is enabled.
14709 * @param obj The genlist object
14710 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14712 * @param v_bounce Pointer to a bool to receive if the bounce vertically
14715 * @see elm_genlist_bounce_set()
14719 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14721 * Enable/disable homogenous mode.
14723 * @param obj The genlist object
14724 * @param homogeneous Assume the items within the genlist are of the
14725 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
14728 * This will enable the homogeneous mode where items are of the same
14729 * height and width so that genlist may do the lazy-loading at its
14730 * maximum (which increases the performance for scrolling the list). This
14731 * implies 'compressed' mode.
14733 * @see elm_genlist_compress_mode_set()
14734 * @see elm_genlist_homogeneous_get()
14738 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14740 * Get whether the homogenous mode is enabled.
14742 * @param obj The genlist object
14743 * @return Assume the items within the genlist are of the same height
14744 * and width (EINA_TRUE = on, EINA_FALSE = off)
14746 * @see elm_genlist_homogeneous_set()
14750 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14752 * Set the maximum number of items within an item block
14754 * @param obj The genlist object
14755 * @param n Maximum number of items within an item block. Default is 32.
14757 * This will configure the block count to tune to the target with
14758 * particular performance matrix.
14760 * A block of objects will be used to reduce the number of operations due to
14761 * many objects in the screen. It can determine the visibility, or if the
14762 * object has changed, it theme needs to be updated, etc. doing this kind of
14763 * calculation to the entire block, instead of per object.
14765 * The default value for the block count is enough for most lists, so unless
14766 * you know you will have a lot of objects visible in the screen at the same
14767 * time, don't try to change this.
14769 * @see elm_genlist_block_count_get()
14770 * @see @ref Genlist_Implementation
14774 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
14776 * Get the maximum number of items within an item block
14778 * @param obj The genlist object
14779 * @return Maximum number of items within an item block
14781 * @see elm_genlist_block_count_set()
14785 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14787 * Set the timeout in seconds for the longpress event.
14789 * @param obj The genlist object
14790 * @param timeout timeout in seconds. Default is 1.
14792 * This option will change how long it takes to send an event "longpressed"
14793 * after the mouse down signal is sent to the list. If this event occurs, no
14794 * "clicked" event will be sent.
14796 * @see elm_genlist_longpress_timeout_set()
14800 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
14802 * Get the timeout in seconds for the longpress event.
14804 * @param obj The genlist object
14805 * @return timeout in seconds
14807 * @see elm_genlist_longpress_timeout_get()
14811 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14813 * Append a new item in a given genlist widget.
14815 * @param obj The genlist object
14816 * @param itc The item class for the item
14817 * @param data The item data
14818 * @param parent The parent item, or NULL if none
14819 * @param flags Item flags
14820 * @param func Convenience function called when the item is selected
14821 * @param func_data Data passed to @p func above.
14822 * @return A handle to the item added or @c NULL if not possible
14824 * This adds the given item to the end of the list or the end of
14825 * the children list if the @p parent is given.
14827 * @see elm_genlist_item_prepend()
14828 * @see elm_genlist_item_insert_before()
14829 * @see elm_genlist_item_insert_after()
14830 * @see elm_genlist_item_del()
14834 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);
14836 * Prepend a new item in a given genlist widget.
14838 * @param obj The genlist object
14839 * @param itc The item class for the item
14840 * @param data The item data
14841 * @param parent The parent item, or NULL if none
14842 * @param flags Item flags
14843 * @param func Convenience function called when the item is selected
14844 * @param func_data Data passed to @p func above.
14845 * @return A handle to the item added or NULL if not possible
14847 * This adds an item to the beginning of the list or beginning of the
14848 * children of the parent if given.
14850 * @see elm_genlist_item_append()
14851 * @see elm_genlist_item_insert_before()
14852 * @see elm_genlist_item_insert_after()
14853 * @see elm_genlist_item_del()
14857 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);
14859 * Insert an item before another in a genlist widget
14861 * @param obj The genlist object
14862 * @param itc The item class for the item
14863 * @param data The item data
14864 * @param before The item to place this new one before.
14865 * @param flags Item flags
14866 * @param func Convenience function called when the item is selected
14867 * @param func_data Data passed to @p func above.
14868 * @return A handle to the item added or @c NULL if not possible
14870 * This inserts an item before another in the list. It will be in the
14871 * same tree level or group as the item it is inserted before.
14873 * @see elm_genlist_item_append()
14874 * @see elm_genlist_item_prepend()
14875 * @see elm_genlist_item_insert_after()
14876 * @see elm_genlist_item_del()
14880 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);
14882 * Insert an item after another in a genlist widget
14884 * @param obj The genlist object
14885 * @param itc The item class for the item
14886 * @param data The item data
14887 * @param after The item to place this new one after.
14888 * @param flags Item flags
14889 * @param func Convenience function called when the item is selected
14890 * @param func_data Data passed to @p func above.
14891 * @return A handle to the item added or @c NULL if not possible
14893 * This inserts an item after another in the list. It will be in the
14894 * same tree level or group as the item it is inserted after.
14896 * @see elm_genlist_item_append()
14897 * @see elm_genlist_item_prepend()
14898 * @see elm_genlist_item_insert_before()
14899 * @see elm_genlist_item_del()
14903 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);
14905 * Insert a new item into the sorted genlist object
14907 * @param obj The genlist object
14908 * @param itc The item class for the item
14909 * @param data The item data
14910 * @param parent The parent item, or NULL if none
14911 * @param flags Item flags
14912 * @param comp The function called for the sort
14913 * @param func Convenience function called when item selected
14914 * @param func_data Data passed to @p func above.
14915 * @return A handle to the item added or NULL if not possible
14919 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);
14920 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);
14921 /* operations to retrieve existing items */
14923 * Get the selectd item in the genlist.
14925 * @param obj The genlist object
14926 * @return The selected item, or NULL if none is selected.
14928 * This gets the selected item in the list (if multi-selection is enabled, only
14929 * the item that was first selected in the list is returned - which is not very
14930 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
14933 * If no item is selected, NULL is returned.
14935 * @see elm_genlist_selected_items_get()
14939 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14941 * Get a list of selected items in the genlist.
14943 * @param obj The genlist object
14944 * @return The list of selected items, or NULL if none are selected.
14946 * It returns a list of the selected items. This list pointer is only valid so
14947 * long as the selection doesn't change (no items are selected or unselected, or
14948 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
14949 * pointers. The order of the items in this list is the order which they were
14950 * selected, i.e. the first item in this list is the first item that was
14951 * selected, and so on.
14953 * @note If not in multi-select mode, consider using function
14954 * elm_genlist_selected_item_get() instead.
14956 * @see elm_genlist_multi_select_set()
14957 * @see elm_genlist_selected_item_get()
14961 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14963 * Get a list of realized items in genlist
14965 * @param obj The genlist object
14966 * @return The list of realized items, nor NULL if none are realized.
14968 * This returns a list of the realized items in the genlist. The list
14969 * contains Elm_Genlist_Item pointers. The list must be freed by the
14970 * caller when done with eina_list_free(). The item pointers in the
14971 * list are only valid so long as those items are not deleted or the
14972 * genlist is not deleted.
14974 * @see elm_genlist_realized_items_update()
14978 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14980 * Get the item that is at the x, y canvas coords.
14982 * @param obj The gelinst object.
14983 * @param x The input x coordinate
14984 * @param y The input y coordinate
14985 * @param posret The position relative to the item returned here
14986 * @return The item at the coordinates or NULL if none
14988 * This returns the item at the given coordinates (which are canvas
14989 * relative, not object-relative). If an item is at that coordinate,
14990 * that item handle is returned, and if @p posret is not NULL, the
14991 * integer pointed to is set to a value of -1, 0 or 1, depending if
14992 * the coordinate is on the upper portion of that item (-1), on the
14993 * middle section (0) or on the lower part (1). If NULL is returned as
14994 * an item (no item found there), then posret may indicate -1 or 1
14995 * based if the coordinate is above or below all items respectively in
15000 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);
15002 * Get the first item in the genlist
15004 * This returns the first item in the list.
15006 * @param obj The genlist object
15007 * @return The first item, or NULL if none
15011 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15013 * Get the last item in the genlist
15015 * This returns the last item in the list.
15017 * @return The last item, or NULL if none
15021 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15023 * Set the scrollbar policy
15025 * @param obj The genlist object
15026 * @param policy_h Horizontal scrollbar policy.
15027 * @param policy_v Vertical scrollbar policy.
15029 * This sets the scrollbar visibility policy for the given genlist
15030 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15031 * made visible if it is needed, and otherwise kept hidden.
15032 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15033 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15034 * respectively for the horizontal and vertical scrollbars. Default is
15035 * #ELM_SMART_SCROLLER_POLICY_AUTO
15037 * @see elm_genlist_scroller_policy_get()
15041 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15043 * Get the scrollbar policy
15045 * @param obj The genlist object
15046 * @param policy_h Pointer to store the horizontal scrollbar policy.
15047 * @param policy_v Pointer to store the vertical scrollbar policy.
15049 * @see elm_genlist_scroller_policy_set()
15053 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);
15055 * Get the @b next item in a genlist widget's internal list of items,
15056 * given a handle to one of those items.
15058 * @param item The genlist item to fetch next from
15059 * @return The item after @p item, or @c NULL if there's none (and
15062 * This returns the item placed after the @p item, on the container
15065 * @see elm_genlist_item_prev_get()
15069 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15071 * Get the @b previous item in a genlist widget's internal list of items,
15072 * given a handle to one of those items.
15074 * @param item The genlist item to fetch previous from
15075 * @return The item before @p item, or @c NULL if there's none (and
15078 * This returns the item placed before the @p item, on the container
15081 * @see elm_genlist_item_next_get()
15085 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15087 * Get the genlist object's handle which contains a given genlist
15090 * @param item The item to fetch the container from
15091 * @return The genlist (parent) object
15093 * This returns the genlist object itself that an item belongs to.
15097 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15099 * Get the parent item of the given item
15101 * @param it The item
15102 * @return The parent of the item or @c NULL if it has no parent.
15104 * This returns the item that was specified as parent of the item @p it on
15105 * elm_genlist_item_append() and insertion related functions.
15109 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15111 * Remove all sub-items (children) of the given item
15113 * @param it The item
15115 * This removes all items that are children (and their descendants) of the
15116 * given item @p it.
15118 * @see elm_genlist_clear()
15119 * @see elm_genlist_item_del()
15123 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15125 * Set whether a given genlist item is selected or not
15127 * @param it The item
15128 * @param selected Use @c EINA_TRUE, to make it selected, @c
15129 * EINA_FALSE to make it unselected
15131 * This sets the selected state of an item. If multi selection is
15132 * not enabled on the containing genlist and @p selected is @c
15133 * EINA_TRUE, any other previously selected items will get
15134 * unselected in favor of this new one.
15136 * @see elm_genlist_item_selected_get()
15140 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15142 * Get whether a given genlist item is selected or not
15144 * @param it The item
15145 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15147 * @see elm_genlist_item_selected_set() for more details
15151 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15153 * Sets the expanded state of an item.
15155 * @param it The item
15156 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15158 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15161 * The theme will respond to this change visually, and a signal "expanded" or
15162 * "contracted" will be sent from the genlist with a pointer to the item that
15163 * has been expanded/contracted.
15165 * Calling this function won't show or hide any child of this item (if it is
15166 * a parent). You must manually delete and create them on the callbacks fo
15167 * the "expanded" or "contracted" signals.
15169 * @see elm_genlist_item_expanded_get()
15173 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15175 * Get the expanded state of an item
15177 * @param it The item
15178 * @return The expanded state
15180 * This gets the expanded state of an item.
15182 * @see elm_genlist_item_expanded_set()
15186 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15188 * Get the depth of expanded item
15190 * @param it The genlist item object
15191 * @return The depth of expanded item
15195 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15197 * Set whether a given genlist item is disabled or not.
15199 * @param it The item
15200 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15201 * to enable it back.
15203 * A disabled item cannot be selected or unselected. It will also
15204 * change its appearance, to signal the user it's disabled.
15206 * @see elm_genlist_item_disabled_get()
15210 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15212 * Get whether a given genlist item is disabled or not.
15214 * @param it The item
15215 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15218 * @see elm_genlist_item_disabled_set() for more details
15222 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15224 * Sets the display only state of an item.
15226 * @param it The item
15227 * @param display_only @c EINA_TRUE if the item is display only, @c
15228 * EINA_FALSE otherwise.
15230 * A display only item cannot be selected or unselected. It is for
15231 * display only and not selecting or otherwise clicking, dragging
15232 * etc. by the user, thus finger size rules will not be applied to
15235 * It's good to set group index items to display only state.
15237 * @see elm_genlist_item_display_only_get()
15241 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15243 * Get the display only state of an item
15245 * @param it The item
15246 * @return @c EINA_TRUE if the item is display only, @c
15247 * EINA_FALSE otherwise.
15249 * @see elm_genlist_item_display_only_set()
15253 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15255 * Show the portion of a genlist's internal list containing a given
15256 * item, immediately.
15258 * @param it The item to display
15260 * This causes genlist to jump to the given item @p it and show it (by
15261 * immediately scrolling to that position), if it is not fully visible.
15263 * @see elm_genlist_item_bring_in()
15264 * @see elm_genlist_item_top_show()
15265 * @see elm_genlist_item_middle_show()
15269 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15271 * Animatedly bring in, to the visible are of a genlist, a given
15274 * @param it The item to display
15276 * This causes genlist to jump to the given item @p it and show it (by
15277 * animatedly scrolling), if it is not fully visible. This may use animation
15278 * to do so and take a period of time
15280 * @see elm_genlist_item_show()
15281 * @see elm_genlist_item_top_bring_in()
15282 * @see elm_genlist_item_middle_bring_in()
15286 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15288 * Show the portion of a genlist's internal list containing a given
15289 * item, immediately.
15291 * @param it The item to display
15293 * This causes genlist to jump to the given item @p it and show it (by
15294 * immediately scrolling to that position), if it is not fully visible.
15296 * The item will be positioned at the top of the genlist viewport.
15298 * @see elm_genlist_item_show()
15299 * @see elm_genlist_item_top_bring_in()
15303 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15305 * Animatedly bring in, to the visible are of a genlist, a given
15308 * @param it The item
15310 * This causes genlist to jump to the given item @p it and show it (by
15311 * animatedly scrolling), if it is not fully visible. This may use animation
15312 * to do so and take a period of time
15314 * The item will be positioned at the top of the genlist viewport.
15316 * @see elm_genlist_item_bring_in()
15317 * @see elm_genlist_item_top_show()
15321 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15323 * Show the portion of a genlist's internal list containing a given
15324 * item, immediately.
15326 * @param it The item to display
15328 * This causes genlist to jump to the given item @p it and show it (by
15329 * immediately scrolling to that position), if it is not fully visible.
15331 * The item will be positioned at the middle of the genlist viewport.
15333 * @see elm_genlist_item_show()
15334 * @see elm_genlist_item_middle_bring_in()
15338 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15340 * Animatedly bring in, to the visible are of a genlist, a given
15343 * @param it The item
15345 * This causes genlist to jump to the given item @p it and show it (by
15346 * animatedly scrolling), if it is not fully visible. This may use animation
15347 * to do so and take a period of time
15349 * The item will be positioned at the middle of the genlist viewport.
15351 * @see elm_genlist_item_bring_in()
15352 * @see elm_genlist_item_middle_show()
15356 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15358 * Remove a genlist item from the its parent, deleting it.
15360 * @param item The item to be removed.
15361 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15363 * @see elm_genlist_clear(), to remove all items in a genlist at
15368 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15370 * Return the data associated to a given genlist item
15372 * @param item The genlist item.
15373 * @return the data associated to this item.
15375 * This returns the @c data value passed on the
15376 * elm_genlist_item_append() and related item addition calls.
15378 * @see elm_genlist_item_append()
15379 * @see elm_genlist_item_data_set()
15383 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15385 * Set the data associated to a given genlist item
15387 * @param item The genlist item
15388 * @param data The new data pointer to set on it
15390 * This @b overrides the @c data value passed on the
15391 * elm_genlist_item_append() and related item addition calls. This
15392 * function @b won't call elm_genlist_item_update() automatically,
15393 * so you'd issue it afterwards if you want to hove the item
15394 * updated to reflect the that new data.
15396 * @see elm_genlist_item_data_get()
15400 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15402 * Tells genlist to "orphan" icons fetchs by the item class
15404 * @param it The item
15406 * This instructs genlist to release references to icons in the item,
15407 * meaning that they will no longer be managed by genlist and are
15408 * floating "orphans" that can be re-used elsewhere if the user wants
15413 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15415 * Get the real Evas object created to implement the view of a
15416 * given genlist item
15418 * @param item The genlist item.
15419 * @return the Evas object implementing this item's view.
15421 * This returns the actual Evas object used to implement the
15422 * specified genlist item's view. This may be @c NULL, as it may
15423 * not have been created or may have been deleted, at any time, by
15424 * the genlist. <b>Do not modify this object</b> (move, resize,
15425 * show, hide, etc.), as the genlist is controlling it. This
15426 * function is for querying, emitting custom signals or hooking
15427 * lower level callbacks for events on that object. Do not delete
15428 * this object under any circumstances.
15430 * @see elm_genlist_item_data_get()
15434 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15436 * Update the contents of an item
15438 * @param it The item
15440 * This updates an item by calling all the item class functions again
15441 * to get the icons, labels and states. Use this when the original
15442 * item data has changed and the changes are desired to be reflected.
15444 * Use elm_genlist_realized_items_update() to update all already realized
15447 * @see elm_genlist_realized_items_update()
15451 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15453 * Update the item class of an item
15455 * @param it The item
15456 * @param itc The item class for the item
15458 * This sets another class fo the item, changing the way that it is
15459 * displayed. After changing the item class, elm_genlist_item_update() is
15460 * called on the item @p it.
15464 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15465 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15467 * Set the text to be shown in a given genlist item's tooltips.
15469 * @param item The genlist item
15470 * @param text The text to set in the content
15472 * This call will setup the text to be used as tooltip to that item
15473 * (analogous to elm_object_tooltip_text_set(), but being item
15474 * tooltips with higher precedence than object tooltips). It can
15475 * have only one tooltip at a time, so any previous tooltip data
15476 * will get removed.
15478 * In order to set an icon or something else as a tooltip, look at
15479 * elm_genlist_item_tooltip_content_cb_set().
15483 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15485 * Set the content to be shown in a given genlist item's tooltips
15487 * @param item The genlist item.
15488 * @param func The function returning the tooltip contents.
15489 * @param data What to provide to @a func as callback data/context.
15490 * @param del_cb Called when data is not needed anymore, either when
15491 * another callback replaces @p func, the tooltip is unset with
15492 * elm_genlist_item_tooltip_unset() or the owner @p item
15493 * dies. This callback receives as its first parameter the
15494 * given @p data, being @c event_info the item handle.
15496 * This call will setup the tooltip's contents to @p item
15497 * (analogous to elm_object_tooltip_content_cb_set(), but being
15498 * item tooltips with higher precedence than object tooltips). It
15499 * can have only one tooltip at a time, so any previous tooltip
15500 * content will get removed. @p func (with @p data) will be called
15501 * every time Elementary needs to show the tooltip and it should
15502 * return a valid Evas object, which will be fully managed by the
15503 * tooltip system, getting deleted when the tooltip is gone.
15505 * In order to set just a text as a tooltip, look at
15506 * elm_genlist_item_tooltip_text_set().
15510 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);
15512 * Unset a tooltip from a given genlist item
15514 * @param item genlist item to remove a previously set tooltip from.
15516 * This call removes any tooltip set on @p item. The callback
15517 * provided as @c del_cb to
15518 * elm_genlist_item_tooltip_content_cb_set() will be called to
15519 * notify it is not used anymore (and have resources cleaned, if
15522 * @see elm_genlist_item_tooltip_content_cb_set()
15526 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15528 * Set a different @b style for a given genlist item's tooltip.
15530 * @param item genlist item with tooltip set
15531 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15532 * "default", @c "transparent", etc)
15534 * Tooltips can have <b>alternate styles</b> to be displayed on,
15535 * which are defined by the theme set on Elementary. This function
15536 * works analogously as elm_object_tooltip_style_set(), but here
15537 * applied only to genlist item objects. The default style for
15538 * tooltips is @c "default".
15540 * @note before you set a style you should define a tooltip with
15541 * elm_genlist_item_tooltip_content_cb_set() or
15542 * elm_genlist_item_tooltip_text_set()
15544 * @see elm_genlist_item_tooltip_style_get()
15548 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15550 * Get the style set a given genlist item's tooltip.
15552 * @param item genlist item with tooltip already set on.
15553 * @return style the theme style in use, which defaults to
15554 * "default". If the object does not have a tooltip set,
15555 * then @c NULL is returned.
15557 * @see elm_genlist_item_tooltip_style_set() for more details
15561 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15563 * @brief Disable size restrictions on an object's tooltip
15564 * @param item The tooltip's anchor object
15565 * @param disable If EINA_TRUE, size restrictions are disabled
15566 * @return EINA_FALSE on failure, EINA_TRUE on success
15568 * This function allows a tooltip to expand beyond its parant window's canvas.
15569 * It will instead be limited only by the size of the display.
15571 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15573 * @brief Retrieve size restriction state of an object's tooltip
15574 * @param item The tooltip's anchor object
15575 * @return If EINA_TRUE, size restrictions are disabled
15577 * This function returns whether a tooltip is allowed to expand beyond
15578 * its parant window's canvas.
15579 * It will instead be limited only by the size of the display.
15581 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15583 * Set the type of mouse pointer/cursor decoration to be shown,
15584 * when the mouse pointer is over the given genlist widget item
15586 * @param item genlist item to customize cursor on
15587 * @param cursor the cursor type's name
15589 * This function works analogously as elm_object_cursor_set(), but
15590 * here the cursor's changing area is restricted to the item's
15591 * area, and not the whole widget's. Note that that item cursors
15592 * have precedence over widget cursors, so that a mouse over @p
15593 * item will always show cursor @p type.
15595 * If this function is called twice for an object, a previously set
15596 * cursor will be unset on the second call.
15598 * @see elm_object_cursor_set()
15599 * @see elm_genlist_item_cursor_get()
15600 * @see elm_genlist_item_cursor_unset()
15604 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15606 * Get the type of mouse pointer/cursor decoration set to be shown,
15607 * when the mouse pointer is over the given genlist widget item
15609 * @param item genlist item with custom cursor set
15610 * @return the cursor type's name or @c NULL, if no custom cursors
15611 * were set to @p item (and on errors)
15613 * @see elm_object_cursor_get()
15614 * @see elm_genlist_item_cursor_set() for more details
15615 * @see elm_genlist_item_cursor_unset()
15619 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15621 * Unset any custom mouse pointer/cursor decoration set to be
15622 * shown, when the mouse pointer is over the given genlist widget
15623 * item, thus making it show the @b default cursor again.
15625 * @param item a genlist item
15627 * Use this call to undo any custom settings on this item's cursor
15628 * decoration, bringing it back to defaults (no custom style set).
15630 * @see elm_object_cursor_unset()
15631 * @see elm_genlist_item_cursor_set() for more details
15635 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15637 * Set a different @b style for a given custom cursor set for a
15640 * @param item genlist item with custom cursor set
15641 * @param style the <b>theme style</b> to use (e.g. @c "default",
15642 * @c "transparent", etc)
15644 * This function only makes sense when one is using custom mouse
15645 * cursor decorations <b>defined in a theme file</b> , which can
15646 * have, given a cursor name/type, <b>alternate styles</b> on
15647 * it. It works analogously as elm_object_cursor_style_set(), but
15648 * here applied only to genlist item objects.
15650 * @warning Before you set a cursor style you should have defined a
15651 * custom cursor previously on the item, with
15652 * elm_genlist_item_cursor_set()
15654 * @see elm_genlist_item_cursor_engine_only_set()
15655 * @see elm_genlist_item_cursor_style_get()
15659 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15661 * Get the current @b style set for a given genlist item's custom
15664 * @param item genlist item with custom cursor set.
15665 * @return style the cursor style in use. If the object does not
15666 * have a cursor set, then @c NULL is returned.
15668 * @see elm_genlist_item_cursor_style_set() for more details
15672 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15674 * Set if the (custom) cursor for a given genlist item should be
15675 * searched in its theme, also, or should only rely on the
15676 * rendering engine.
15678 * @param item item with custom (custom) cursor already set on
15679 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15680 * only on those provided by the rendering engine, @c EINA_FALSE to
15681 * have them searched on the widget's theme, as well.
15683 * @note This call is of use only if you've set a custom cursor
15684 * for genlist items, with elm_genlist_item_cursor_set().
15686 * @note By default, cursors will only be looked for between those
15687 * provided by the rendering engine.
15691 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15693 * Get if the (custom) cursor for a given genlist item is being
15694 * searched in its theme, also, or is only relying on the rendering
15697 * @param item a genlist item
15698 * @return @c EINA_TRUE, if cursors are being looked for only on
15699 * those provided by the rendering engine, @c EINA_FALSE if they
15700 * are being searched on the widget's theme, as well.
15702 * @see elm_genlist_item_cursor_engine_only_set(), for more details
15706 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15708 * Update the contents of all realized items.
15710 * @param obj The genlist object.
15712 * This updates all realized items by calling all the item class functions again
15713 * to get the icons, labels and states. Use this when the original
15714 * item data has changed and the changes are desired to be reflected.
15716 * To update just one item, use elm_genlist_item_update().
15718 * @see elm_genlist_realized_items_get()
15719 * @see elm_genlist_item_update()
15723 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15724 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
15725 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15726 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15727 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
15728 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15735 * @defgroup Check Check
15737 * @image html img/widget/check/preview-00.png
15738 * @image latex img/widget/check/preview-00.eps
15739 * @image html img/widget/check/preview-01.png
15740 * @image latex img/widget/check/preview-01.eps
15741 * @image html img/widget/check/preview-02.png
15742 * @image latex img/widget/check/preview-02.eps
15744 * @brief The check widget allows for toggling a value between true and
15747 * Check objects are a lot like radio objects in layout and functionality
15748 * except they do not work as a group, but independently and only toggle the
15749 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
15750 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
15751 * returns the current state. For convenience, like the radio objects, you
15752 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
15753 * for it to modify.
15755 * Signals that you can add callbacks for are:
15756 * "changed" - This is called whenever the user changes the state of one of
15757 * the check object(event_info is NULL).
15759 * @ref tutorial_check should give you a firm grasp of how to use this widget.
15763 * @brief Add a new Check object
15765 * @param parent The parent object
15766 * @return The new object or NULL if it cannot be created
15768 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15770 * @brief Set the text label of the check object
15772 * @param obj The check object
15773 * @param label The text label string in UTF-8
15775 * @deprecated use elm_object_text_set() instead.
15777 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15779 * @brief Get the text label of the check object
15781 * @param obj The check object
15782 * @return The text label string in UTF-8
15784 * @deprecated use elm_object_text_get() instead.
15786 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15788 * @brief Set the icon object of the check object
15790 * @param obj The check object
15791 * @param icon The icon object
15793 * Once the icon object is set, a previously set one will be deleted.
15794 * If you want to keep that old content object, use the
15795 * elm_check_icon_unset() function.
15797 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15799 * @brief Get the icon object of the check object
15801 * @param obj The check object
15802 * @return The icon object
15804 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15806 * @brief Unset the icon used for the check object
15808 * @param obj The check object
15809 * @return The icon object that was being used
15811 * Unparent and return the icon object which was set for this widget.
15813 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15815 * @brief Set the on/off state of the check object
15817 * @param obj The check object
15818 * @param state The state to use (1 == on, 0 == off)
15820 * This sets the state of the check. If set
15821 * with elm_check_state_pointer_set() the state of that variable is also
15822 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
15824 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
15826 * @brief Get the state of the check object
15828 * @param obj The check object
15829 * @return The boolean state
15831 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15833 * @brief Set a convenience pointer to a boolean to change
15835 * @param obj The check object
15836 * @param statep Pointer to the boolean to modify
15838 * This sets a pointer to a boolean, that, in addition to the check objects
15839 * state will also be modified directly. To stop setting the object pointed
15840 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
15841 * then when this is called, the check objects state will also be modified to
15842 * reflect the value of the boolean @p statep points to, just like calling
15843 * elm_check_state_set().
15845 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
15851 * @defgroup Radio Radio
15853 * @image html img/widget/radio/preview-00.png
15854 * @image latex img/widget/radio/preview-00.eps
15856 * @brief Radio is a widget that allows for 1 or more options to be displayed
15857 * and have the user choose only 1 of them.
15859 * A radio object contains an indicator, an optional Label and an optional
15860 * icon object. While it's possible to have a group of only one radio they,
15861 * are normally used in groups of 2 or more. To add a radio to a group use
15862 * elm_radio_group_add(). The radio object(s) will select from one of a set
15863 * of integer values, so any value they are configuring needs to be mapped to
15864 * a set of integers. To configure what value that radio object represents,
15865 * use elm_radio_state_value_set() to set the integer it represents. To set
15866 * the value the whole group(which one is currently selected) is to indicate
15867 * use elm_radio_value_set() on any group member, and to get the groups value
15868 * use elm_radio_value_get(). For convenience the radio objects are also able
15869 * to directly set an integer(int) to the value that is selected. To specify
15870 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
15871 * The radio objects will modify this directly. That implies the pointer must
15872 * point to valid memory for as long as the radio objects exist.
15874 * Signals that you can add callbacks for are:
15875 * @li changed - This is called whenever the user changes the state of one of
15876 * the radio objects within the group of radio objects that work together.
15878 * @ref tutorial_radio show most of this API in action.
15882 * @brief Add a new radio to the parent
15884 * @param parent The parent object
15885 * @return The new object or NULL if it cannot be created
15887 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15889 * @brief Set the text label of the radio object
15891 * @param obj The radio object
15892 * @param label The text label string in UTF-8
15894 * @deprecated use elm_object_text_set() instead.
15896 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15898 * @brief Get the text label of the radio object
15900 * @param obj The radio object
15901 * @return The text label string in UTF-8
15903 * @deprecated use elm_object_text_set() instead.
15905 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15907 * @brief Set the icon object of the radio object
15909 * @param obj The radio object
15910 * @param icon The icon object
15912 * Once the icon object is set, a previously set one will be deleted. If you
15913 * want to keep that old content object, use the elm_radio_icon_unset()
15916 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15918 * @brief Get the icon object of the radio object
15920 * @param obj The radio object
15921 * @return The icon object
15923 * @see elm_radio_icon_set()
15925 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15927 * @brief Unset the icon used for the radio object
15929 * @param obj The radio object
15930 * @return The icon object that was being used
15932 * Unparent and return the icon object which was set for this widget.
15934 * @see elm_radio_icon_set()
15936 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15938 * @brief Add this radio to a group of other radio objects
15940 * @param obj The radio object
15941 * @param group Any object whose group the @p obj is to join.
15943 * Radio objects work in groups. Each member should have a different integer
15944 * value assigned. In order to have them work as a group, they need to know
15945 * about each other. This adds the given radio object to the group of which
15946 * the group object indicated is a member.
15948 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
15950 * @brief Set the integer value that this radio object represents
15952 * @param obj The radio object
15953 * @param value The value to use if this radio object is selected
15955 * This sets the value of the radio.
15957 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
15959 * @brief Get the integer value that this radio object represents
15961 * @param obj The radio object
15962 * @return The value used if this radio object is selected
15964 * This gets the value of the radio.
15966 * @see elm_radio_value_set()
15968 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15970 * @brief Set the value of the radio.
15972 * @param obj The radio object
15973 * @param value The value to use for the group
15975 * This sets the value of the radio group and will also set the value if
15976 * pointed to, to the value supplied, but will not call any callbacks.
15978 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
15980 * @brief Get the state of the radio object
15982 * @param obj The radio object
15983 * @return The integer state
15985 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15987 * @brief Set a convenience pointer to a integer to change
15989 * @param obj The radio object
15990 * @param valuep Pointer to the integer to modify
15992 * This sets a pointer to a integer, that, in addition to the radio objects
15993 * state will also be modified directly. To stop setting the object pointed
15994 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
15995 * when this is called, the radio objects state will also be modified to
15996 * reflect the value of the integer valuep points to, just like calling
15997 * elm_radio_value_set().
15999 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
16005 * @defgroup Pager Pager
16007 * @image html img/widget/pager/preview-00.png
16008 * @image latex img/widget/pager/preview-00.eps
16010 * @brief Widget that allows flipping between 1 or more “pages” of objects.
16012 * The flipping between “pages” of objects is animated. All content in pager
16013 * is kept in a stack, the last content to be added will be on the top of the
16014 * stack(be visible).
16016 * Objects can be pushed or popped from the stack or deleted as normal.
16017 * Pushes and pops will animate (and a pop will delete the object once the
16018 * animation is finished). Any object already in the pager can be promoted to
16019 * the top(from its current stacking position) through the use of
16020 * elm_pager_content_promote(). Objects are pushed to the top with
16021 * elm_pager_content_push() and when the top item is no longer wanted, simply
16022 * pop it with elm_pager_content_pop() and it will also be deleted. If an
16023 * object is no longer needed and is not the top item, just delete it as
16024 * normal. You can query which objects are the top and bottom with
16025 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16027 * Signals that you can add callbacks for are:
16028 * "hide,finished" - when the previous page is hided
16030 * This widget has the following styles available:
16033 * @li fade_translucide
16034 * @li fade_invisible
16035 * @note This styles affect only the flipping animations, the appearance when
16036 * not animating is unaffected by styles.
16038 * @ref tutorial_pager gives a good overview of the usage of the API.
16042 * Add a new pager to the parent
16044 * @param parent The parent object
16045 * @return The new object or NULL if it cannot be created
16049 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16051 * @brief Push an object to the top of the pager stack (and show it).
16053 * @param obj The pager object
16054 * @param content The object to push
16056 * The object pushed becomes a child of the pager, it will be controlled and
16057 * deleted when the pager is deleted.
16059 * @note If the content is already in the stack use
16060 * elm_pager_content_promote().
16061 * @warning Using this function on @p content already in the stack results in
16062 * undefined behavior.
16064 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16066 * @brief Pop the object that is on top of the stack
16068 * @param obj The pager object
16070 * This pops the object that is on the top(visible) of the pager, makes it
16071 * disappear, then deletes the object. The object that was underneath it on
16072 * the stack will become visible.
16074 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16076 * @brief Moves an object already in the pager stack to the top of the stack.
16078 * @param obj The pager object
16079 * @param content The object to promote
16081 * This will take the @p content and move it to the top of the stack as
16082 * if it had been pushed there.
16084 * @note If the content isn't already in the stack use
16085 * elm_pager_content_push().
16086 * @warning Using this function on @p content not already in the stack
16087 * results in undefined behavior.
16089 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16091 * @brief Return the object at the bottom of the pager stack
16093 * @param obj The pager object
16094 * @return The bottom object or NULL if none
16096 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16098 * @brief Return the object at the top of the pager stack
16100 * @param obj The pager object
16101 * @return The top object or NULL if none
16103 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16109 * @defgroup Slideshow Slideshow
16111 * @image html img/widget/slideshow/preview-00.png
16112 * @image latex img/widget/slideshow/preview-00.eps
16114 * This widget, as the name indicates, is a pre-made image
16115 * slideshow panel, with API functions acting on (child) image
16116 * items presentation. Between those actions, are:
16117 * - advance to next/previous image
16118 * - select the style of image transition animation
16119 * - set the exhibition time for each image
16120 * - start/stop the slideshow
16122 * The transition animations are defined in the widget's theme,
16123 * consequently new animations can be added without having to
16124 * update the widget's code.
16126 * @section Slideshow_Items Slideshow items
16128 * For slideshow items, just like for @ref Genlist "genlist" ones,
16129 * the user defines a @b classes, specifying functions that will be
16130 * called on the item's creation and deletion times.
16132 * The #Elm_Slideshow_Item_Class structure contains the following
16135 * - @c func.get - When an item is displayed, this function is
16136 * called, and it's where one should create the item object, de
16137 * facto. For example, the object can be a pure Evas image object
16138 * or an Elementary @ref Photocam "photocam" widget. See
16139 * #SlideshowItemGetFunc.
16140 * - @c func.del - When an item is no more displayed, this function
16141 * is called, where the user must delete any data associated to
16142 * the item. See #SlideshowItemDelFunc.
16144 * @section Slideshow_Caching Slideshow caching
16146 * The slideshow provides facilities to have items adjacent to the
16147 * one being displayed <b>already "realized"</b> (i.e. loaded) for
16148 * you, so that the system does not have to decode image data
16149 * anymore at the time it has to actually switch images on its
16150 * viewport. The user is able to set the numbers of items to be
16151 * cached @b before and @b after the current item, in the widget's
16154 * Smart events one can add callbacks for are:
16156 * - @c "changed" - when the slideshow switches its view to a new
16159 * List of examples for the slideshow widget:
16160 * @li @ref slideshow_example
16164 * @addtogroup Slideshow
16168 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16169 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16170 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
16171 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16172 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16175 * @struct _Elm_Slideshow_Item_Class
16177 * Slideshow item class definition. See @ref Slideshow_Items for
16180 struct _Elm_Slideshow_Item_Class
16182 struct _Elm_Slideshow_Item_Class_Func
16184 SlideshowItemGetFunc get;
16185 SlideshowItemDelFunc del;
16187 }; /**< #Elm_Slideshow_Item_Class member definitions */
16190 * Add a new slideshow widget to the given parent Elementary
16191 * (container) object
16193 * @param parent The parent object
16194 * @return A new slideshow widget handle or @c NULL, on errors
16196 * This function inserts a new slideshow widget on the canvas.
16198 * @ingroup Slideshow
16200 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16203 * Add (append) a new item in a given slideshow widget.
16205 * @param obj The slideshow object
16206 * @param itc The item class for the item
16207 * @param data The item's data
16208 * @return A handle to the item added or @c NULL, on errors
16210 * Add a new item to @p obj's internal list of items, appending it.
16211 * The item's class must contain the function really fetching the
16212 * image object to show for this item, which could be an Evas image
16213 * object or an Elementary photo, for example. The @p data
16214 * parameter is going to be passed to both class functions of the
16217 * @see #Elm_Slideshow_Item_Class
16218 * @see elm_slideshow_item_sorted_insert()
16220 * @ingroup Slideshow
16222 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16225 * Insert a new item into the given slideshow widget, using the @p func
16226 * function to sort items (by item handles).
16228 * @param obj The slideshow object
16229 * @param itc The item class for the item
16230 * @param data The item's data
16231 * @param func The comparing function to be used to sort slideshow
16232 * items <b>by #Elm_Slideshow_Item item handles</b>
16233 * @return Returns The slideshow item handle, on success, or
16234 * @c NULL, on errors
16236 * Add a new item to @p obj's internal list of items, in a position
16237 * determined by the @p func comparing function. The item's class
16238 * must contain the function really fetching the image object to
16239 * show for this item, which could be an Evas image object or an
16240 * Elementary photo, for example. The @p data parameter is going to
16241 * be passed to both class functions of the item.
16243 * @see #Elm_Slideshow_Item_Class
16244 * @see elm_slideshow_item_add()
16246 * @ingroup Slideshow
16248 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);
16251 * Display a given slideshow widget's item, programmatically.
16253 * @param obj The slideshow object
16254 * @param item The item to display on @p obj's viewport
16256 * The change between the current item and @p item will use the
16257 * transition @p obj is set to use (@see
16258 * elm_slideshow_transition_set()).
16260 * @ingroup Slideshow
16262 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16265 * Slide to the @b next item, in a given slideshow widget
16267 * @param obj The slideshow object
16269 * The sliding animation @p obj is set to use will be the
16270 * transition effect used, after this call is issued.
16272 * @note If the end of the slideshow's internal list of items is
16273 * reached, it'll wrap around to the list's beginning, again.
16275 * @ingroup Slideshow
16277 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16280 * Slide to the @b previous item, in a given slideshow widget
16282 * @param obj The slideshow object
16284 * The sliding animation @p obj is set to use will be the
16285 * transition effect used, after this call is issued.
16287 * @note If the beginning of the slideshow's internal list of items
16288 * is reached, it'll wrap around to the list's end, again.
16290 * @ingroup Slideshow
16292 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16295 * Returns the list of sliding transition/effect names available, for a
16296 * given slideshow widget.
16298 * @param obj The slideshow object
16299 * @return The list of transitions (list of @b stringshared strings
16302 * The transitions, which come from @p obj's theme, must be an EDC
16303 * data item named @c "transitions" on the theme file, with (prefix)
16304 * names of EDC programs actually implementing them.
16306 * The available transitions for slideshows on the default theme are:
16307 * - @c "fade" - the current item fades out, while the new one
16308 * fades in to the slideshow's viewport.
16309 * - @c "black_fade" - the current item fades to black, and just
16310 * then, the new item will fade in.
16311 * - @c "horizontal" - the current item slides horizontally, until
16312 * it gets out of the slideshow's viewport, while the new item
16313 * comes from the left to take its place.
16314 * - @c "vertical" - the current item slides vertically, until it
16315 * gets out of the slideshow's viewport, while the new item comes
16316 * from the bottom to take its place.
16317 * - @c "square" - the new item starts to appear from the middle of
16318 * the current one, but with a tiny size, growing until its
16319 * target (full) size and covering the old one.
16321 * @warning The stringshared strings get no new references
16322 * exclusive to the user grabbing the list, here, so if you'd like
16323 * to use them out of this call's context, you'd better @c
16324 * eina_stringshare_ref() them.
16326 * @see elm_slideshow_transition_set()
16328 * @ingroup Slideshow
16330 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16333 * Set the current slide transition/effect in use for a given
16336 * @param obj The slideshow object
16337 * @param transition The new transition's name string
16339 * If @p transition is implemented in @p obj's theme (i.e., is
16340 * contained in the list returned by
16341 * elm_slideshow_transitions_get()), this new sliding effect will
16342 * be used on the widget.
16344 * @see elm_slideshow_transitions_get() for more details
16346 * @ingroup Slideshow
16348 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16351 * Get the current slide transition/effect in use for a given
16354 * @param obj The slideshow object
16355 * @return The current transition's name
16357 * @see elm_slideshow_transition_set() for more details
16359 * @ingroup Slideshow
16361 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16364 * Set the interval between each image transition on a given
16365 * slideshow widget, <b>and start the slideshow, itself</b>
16367 * @param obj The slideshow object
16368 * @param timeout The new displaying timeout for images
16370 * After this call, the slideshow widget will start cycling its
16371 * view, sequentially and automatically, with the images of the
16372 * items it has. The time between each new image displayed is going
16373 * to be @p timeout, in @b seconds. If a different timeout was set
16374 * previously and an slideshow was in progress, it will continue
16375 * with the new time between transitions, after this call.
16377 * @note A value less than or equal to 0 on @p timeout will disable
16378 * the widget's internal timer, thus halting any slideshow which
16379 * could be happening on @p obj.
16381 * @see elm_slideshow_timeout_get()
16383 * @ingroup Slideshow
16385 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16388 * Get the interval set for image transitions on a given slideshow
16391 * @param obj The slideshow object
16392 * @return Returns the timeout set on it
16394 * @see elm_slideshow_timeout_set() for more details
16396 * @ingroup Slideshow
16398 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16401 * Set if, after a slideshow is started, for a given slideshow
16402 * widget, its items should be displayed cyclically or not.
16404 * @param obj The slideshow object
16405 * @param loop Use @c EINA_TRUE to make it cycle through items or
16406 * @c EINA_FALSE for it to stop at the end of @p obj's internal
16409 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16410 * ignore what is set by this functions, i.e., they'll @b always
16411 * cycle through items. This affects only the "automatic"
16412 * slideshow, as set by elm_slideshow_timeout_set().
16414 * @see elm_slideshow_loop_get()
16416 * @ingroup Slideshow
16418 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16421 * Get if, after a slideshow is started, for a given slideshow
16422 * widget, its items are to be displayed cyclically or not.
16424 * @param obj The slideshow object
16425 * @return @c EINA_TRUE, if the items in @p obj will be cycled
16426 * through or @c EINA_FALSE, otherwise
16428 * @see elm_slideshow_loop_set() for more details
16430 * @ingroup Slideshow
16432 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16435 * Remove all items from a given slideshow widget
16437 * @param obj The slideshow object
16439 * This removes (and deletes) all items in @p obj, leaving it
16442 * @see elm_slideshow_item_del(), to remove just one item.
16444 * @ingroup Slideshow
16446 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16449 * Get the internal list of items in a given slideshow widget.
16451 * @param obj The slideshow object
16452 * @return The list of items (#Elm_Slideshow_Item as data) or
16453 * @c NULL on errors.
16455 * This list is @b not to be modified in any way and must not be
16456 * freed. Use the list members with functions like
16457 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16459 * @warning This list is only valid until @p obj object's internal
16460 * items list is changed. It should be fetched again with another
16461 * call to this function when changes happen.
16463 * @ingroup Slideshow
16465 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16468 * Delete a given item from a slideshow widget.
16470 * @param item The slideshow item
16472 * @ingroup Slideshow
16474 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16477 * Return the data associated with a given slideshow item
16479 * @param item The slideshow item
16480 * @return Returns the data associated to this item
16482 * @ingroup Slideshow
16484 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16487 * Returns the currently displayed item, in a given slideshow widget
16489 * @param obj The slideshow object
16490 * @return A handle to the item being displayed in @p obj or
16491 * @c NULL, if none is (and on errors)
16493 * @ingroup Slideshow
16495 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16498 * Get the real Evas object created to implement the view of a
16499 * given slideshow item
16501 * @param item The slideshow item.
16502 * @return the Evas object implementing this item's view.
16504 * This returns the actual Evas object used to implement the
16505 * specified slideshow item's view. This may be @c NULL, as it may
16506 * not have been created or may have been deleted, at any time, by
16507 * the slideshow. <b>Do not modify this object</b> (move, resize,
16508 * show, hide, etc.), as the slideshow is controlling it. This
16509 * function is for querying, emitting custom signals or hooking
16510 * lower level callbacks for events on that object. Do not delete
16511 * this object under any circumstances.
16513 * @see elm_slideshow_item_data_get()
16515 * @ingroup Slideshow
16517 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16520 * Get the the item, in a given slideshow widget, placed at
16521 * position @p nth, in its internal items list
16523 * @param obj The slideshow object
16524 * @param nth The number of the item to grab a handle to (0 being
16526 * @return The item stored in @p obj at position @p nth or @c NULL,
16527 * if there's no item with that index (and on errors)
16529 * @ingroup Slideshow
16531 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16534 * Set the current slide layout in use for a given slideshow widget
16536 * @param obj The slideshow object
16537 * @param layout The new layout's name string
16539 * If @p layout is implemented in @p obj's theme (i.e., is contained
16540 * in the list returned by elm_slideshow_layouts_get()), this new
16541 * images layout will be used on the widget.
16543 * @see elm_slideshow_layouts_get() for more details
16545 * @ingroup Slideshow
16547 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16550 * Get the current slide layout in use for a given slideshow widget
16552 * @param obj The slideshow object
16553 * @return The current layout's name
16555 * @see elm_slideshow_layout_set() for more details
16557 * @ingroup Slideshow
16559 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16562 * Returns the list of @b layout names available, for a given
16563 * slideshow widget.
16565 * @param obj The slideshow object
16566 * @return The list of layouts (list of @b stringshared strings
16569 * Slideshow layouts will change how the widget is to dispose each
16570 * image item in its viewport, with regard to cropping, scaling,
16573 * The layouts, which come from @p obj's theme, must be an EDC
16574 * data item name @c "layouts" on the theme file, with (prefix)
16575 * names of EDC programs actually implementing them.
16577 * The available layouts for slideshows on the default theme are:
16578 * - @c "fullscreen" - item images with original aspect, scaled to
16579 * touch top and down slideshow borders or, if the image's heigh
16580 * is not enough, left and right slideshow borders.
16581 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16582 * one, but always leaving 10% of the slideshow's dimensions of
16583 * distance between the item image's borders and the slideshow
16584 * borders, for each axis.
16586 * @warning The stringshared strings get no new references
16587 * exclusive to the user grabbing the list, here, so if you'd like
16588 * to use them out of this call's context, you'd better @c
16589 * eina_stringshare_ref() them.
16591 * @see elm_slideshow_layout_set()
16593 * @ingroup Slideshow
16595 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16598 * Set the number of items to cache, on a given slideshow widget,
16599 * <b>before the current item</b>
16601 * @param obj The slideshow object
16602 * @param count Number of items to cache before the current one
16604 * The default value for this property is @c 2. See
16605 * @ref Slideshow_Caching "slideshow caching" for more details.
16607 * @see elm_slideshow_cache_before_get()
16609 * @ingroup Slideshow
16611 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16614 * Retrieve the number of items to cache, on a given slideshow widget,
16615 * <b>before the current item</b>
16617 * @param obj The slideshow object
16618 * @return The number of items set to be cached before the current one
16620 * @see elm_slideshow_cache_before_set() for more details
16622 * @ingroup Slideshow
16624 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16627 * Set the number of items to cache, on a given slideshow widget,
16628 * <b>after the current item</b>
16630 * @param obj The slideshow object
16631 * @param count Number of items to cache after the current one
16633 * The default value for this property is @c 2. See
16634 * @ref Slideshow_Caching "slideshow caching" for more details.
16636 * @see elm_slideshow_cache_after_get()
16638 * @ingroup Slideshow
16640 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16643 * Retrieve the number of items to cache, on a given slideshow widget,
16644 * <b>after the current item</b>
16646 * @param obj The slideshow object
16647 * @return The number of items set to be cached after the current one
16649 * @see elm_slideshow_cache_after_set() for more details
16651 * @ingroup Slideshow
16653 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16656 * Get the number of items stored in a given slideshow widget
16658 * @param obj The slideshow object
16659 * @return The number of items on @p obj, at the moment of this call
16661 * @ingroup Slideshow
16663 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16670 * @defgroup Fileselector File Selector
16672 * @image html img/widget/fileselector/preview-00.png
16673 * @image latex img/widget/fileselector/preview-00.eps
16675 * A file selector is a widget that allows a user to navigate
16676 * through a file system, reporting file selections back via its
16679 * It contains shortcut buttons for home directory (@c ~) and to
16680 * jump one directory upwards (..), as well as cancel/ok buttons to
16681 * confirm/cancel a given selection. After either one of those two
16682 * former actions, the file selector will issue its @c "done" smart
16685 * There's a text entry on it, too, showing the name of the current
16686 * selection. There's the possibility of making it editable, so it
16687 * is useful on file saving dialogs on applications, where one
16688 * gives a file name to save contents to, in a given directory in
16689 * the system. This custom file name will be reported on the @c
16690 * "done" smart callback (explained in sequence).
16692 * Finally, it has a view to display file system items into in two
16697 * If Elementary is built with support of the Ethumb thumbnailing
16698 * library, the second form of view will display preview thumbnails
16699 * of files which it supports.
16701 * Smart callbacks one can register to:
16703 * - @c "selected" - the user has clicked on a file (when not in
16704 * folders-only mode) or directory (when in folders-only mode)
16705 * - @c "directory,open" - the list has been populated with new
16706 * content (@c event_info is a pointer to the directory's
16707 * path, a @b stringshared string)
16708 * - @c "done" - the user has clicked on the "ok" or "cancel"
16709 * buttons (@c event_info is a pointer to the selection's
16710 * path, a @b stringshared string)
16712 * Here is an example on its usage:
16713 * @li @ref fileselector_example
16717 * @addtogroup Fileselector
16722 * Defines how a file selector widget is to layout its contents
16723 * (file system entries).
16725 typedef enum _Elm_Fileselector_Mode
16727 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
16728 ELM_FILESELECTOR_GRID, /**< layout as a grid */
16729 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
16730 } Elm_Fileselector_Mode;
16733 * Add a new file selector widget to the given parent Elementary
16734 * (container) object
16736 * @param parent The parent object
16737 * @return a new file selector widget handle or @c NULL, on errors
16739 * This function inserts a new file selector widget on the canvas.
16741 * @ingroup Fileselector
16743 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16746 * Enable/disable the file name entry box where the user can type
16747 * in a name for a file, in a given file selector widget
16749 * @param obj The file selector object
16750 * @param is_save @c EINA_TRUE to make the file selector a "saving
16751 * dialog", @c EINA_FALSE otherwise
16753 * Having the entry editable is useful on file saving dialogs on
16754 * applications, where one gives a file name to save contents to,
16755 * in a given directory in the system. This custom file name will
16756 * be reported on the @c "done" smart callback.
16758 * @see elm_fileselector_is_save_get()
16760 * @ingroup Fileselector
16762 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
16765 * Get whether the given file selector is in "saving dialog" mode
16767 * @param obj The file selector object
16768 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
16769 * mode, @c EINA_FALSE otherwise (and on errors)
16771 * @see elm_fileselector_is_save_set() for more details
16773 * @ingroup Fileselector
16775 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16778 * Enable/disable folder-only view for a given file selector widget
16780 * @param obj The file selector object
16781 * @param only @c EINA_TRUE to make @p obj only display
16782 * directories, @c EINA_FALSE to make files to be displayed in it
16785 * If enabled, the widget's view will only display folder items,
16788 * @see elm_fileselector_folder_only_get()
16790 * @ingroup Fileselector
16792 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
16795 * Get whether folder-only view is set for a given file selector
16798 * @param obj The file selector object
16799 * @return only @c EINA_TRUE if @p obj is only displaying
16800 * directories, @c EINA_FALSE if files are being displayed in it
16801 * too (and on errors)
16803 * @see elm_fileselector_folder_only_get()
16805 * @ingroup Fileselector
16807 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16810 * Enable/disable the "ok" and "cancel" buttons on a given file
16813 * @param obj The file selector object
16814 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
16816 * @note A file selector without those buttons will never emit the
16817 * @c "done" smart event, and is only usable if one is just hooking
16818 * to the other two events.
16820 * @see elm_fileselector_buttons_ok_cancel_get()
16822 * @ingroup Fileselector
16824 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
16827 * Get whether the "ok" and "cancel" buttons on a given file
16828 * selector widget are being shown.
16830 * @param obj The file selector object
16831 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
16832 * otherwise (and on errors)
16834 * @see elm_fileselector_buttons_ok_cancel_set() for more details
16836 * @ingroup Fileselector
16838 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16841 * Enable/disable a tree view in the given file selector widget,
16842 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
16844 * @param obj The file selector object
16845 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
16848 * In a tree view, arrows are created on the sides of directories,
16849 * allowing them to expand in place.
16851 * @note If it's in other mode, the changes made by this function
16852 * will only be visible when one switches back to "list" mode.
16854 * @see elm_fileselector_expandable_get()
16856 * @ingroup Fileselector
16858 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
16861 * Get whether tree view is enabled for the given file selector
16864 * @param obj The file selector object
16865 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
16866 * otherwise (and or errors)
16868 * @see elm_fileselector_expandable_set() for more details
16870 * @ingroup Fileselector
16872 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16875 * Set, programmatically, the @b directory that a given file
16876 * selector widget will display contents from
16878 * @param obj The file selector object
16879 * @param path The path to display in @p obj
16881 * This will change the @b directory that @p obj is displaying. It
16882 * will also clear the text entry area on the @p obj object, which
16883 * displays select files' names.
16885 * @see elm_fileselector_path_get()
16887 * @ingroup Fileselector
16889 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16892 * Get the parent directory's path that a given file selector
16893 * widget is displaying
16895 * @param obj The file selector object
16896 * @return The (full) path of the directory the file selector is
16897 * displaying, a @b stringshared string
16899 * @see elm_fileselector_path_set()
16901 * @ingroup Fileselector
16903 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16906 * Set, programmatically, the currently selected file/directory in
16907 * the given file selector widget
16909 * @param obj The file selector object
16910 * @param path The (full) path to a file or directory
16911 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
16912 * latter case occurs if the directory or file pointed to do not
16915 * @see elm_fileselector_selected_get()
16917 * @ingroup Fileselector
16919 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16922 * Get the currently selected item's (full) path, in the given file
16925 * @param obj The file selector object
16926 * @return The absolute path of the selected item, a @b
16927 * stringshared string
16929 * @note Custom editions on @p obj object's text entry, if made,
16930 * will appear on the return string of this function, naturally.
16932 * @see elm_fileselector_selected_set() for more details
16934 * @ingroup Fileselector
16936 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16939 * Set the mode in which a given file selector widget will display
16940 * (layout) file system entries in its view
16942 * @param obj The file selector object
16943 * @param mode The mode of the fileselector, being it one of
16944 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
16945 * first one, naturally, will display the files in a list. The
16946 * latter will make the widget to display its entries in a grid
16949 * @note By using elm_fileselector_expandable_set(), the user may
16950 * trigger a tree view for that list.
16952 * @note If Elementary is built with support of the Ethumb
16953 * thumbnailing library, the second form of view will display
16954 * preview thumbnails of files which it supports. You must have
16955 * elm_need_ethumb() called in your Elementary for thumbnailing to
16958 * @see elm_fileselector_expandable_set().
16959 * @see elm_fileselector_mode_get().
16961 * @ingroup Fileselector
16963 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
16966 * Get the mode in which a given file selector widget is displaying
16967 * (layouting) file system entries in its view
16969 * @param obj The fileselector object
16970 * @return The mode in which the fileselector is at
16972 * @see elm_fileselector_mode_set() for more details
16974 * @ingroup Fileselector
16976 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16983 * @defgroup Progressbar Progress bar
16985 * The progress bar is a widget for visually representing the
16986 * progress status of a given job/task.
16988 * A progress bar may be horizontal or vertical. It may display an
16989 * icon besides it, as well as primary and @b units labels. The
16990 * former is meant to label the widget as a whole, while the
16991 * latter, which is formatted with floating point values (and thus
16992 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
16993 * units"</c>), is meant to label the widget's <b>progress
16994 * value</b>. Label, icon and unit strings/objects are @b optional
16995 * for progress bars.
16997 * A progress bar may be @b inverted, in which state it gets its
16998 * values inverted, with high values being on the left or top and
16999 * low values on the right or bottom, as opposed to normally have
17000 * the low values on the former and high values on the latter,
17001 * respectively, for horizontal and vertical modes.
17003 * The @b span of the progress, as set by
17004 * elm_progressbar_span_size_set(), is its length (horizontally or
17005 * vertically), unless one puts size hints on the widget to expand
17006 * on desired directions, by any container. That length will be
17007 * scaled by the object or applications scaling factor. At any
17008 * point code can query the progress bar for its value with
17009 * elm_progressbar_value_get().
17011 * Available widget styles for progress bars:
17013 * - @c "wheel" (simple style, no text, no progression, only
17014 * "pulse" effect is available)
17016 * Here is an example on its usage:
17017 * @li @ref progressbar_example
17021 * Add a new progress bar widget to the given parent Elementary
17022 * (container) object
17024 * @param parent The parent object
17025 * @return a new progress bar widget handle or @c NULL, on errors
17027 * This function inserts a new progress bar widget on the canvas.
17029 * @ingroup Progressbar
17031 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17034 * Set whether a given progress bar widget is at "pulsing mode" or
17037 * @param obj The progress bar object
17038 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
17039 * @c EINA_FALSE to put it back to its default one
17041 * By default, progress bars will display values from the low to
17042 * high value boundaries. There are, though, contexts in which the
17043 * state of progression of a given task is @b unknown. For those,
17044 * one can set a progress bar widget to a "pulsing state", to give
17045 * the user an idea that some computation is being held, but
17046 * without exact progress values. In the default theme it will
17047 * animate its bar with the contents filling in constantly and back
17048 * to non-filled, in a loop. To start and stop this pulsing
17049 * animation, one has to explicitly call elm_progressbar_pulse().
17051 * @see elm_progressbar_pulse_get()
17052 * @see elm_progressbar_pulse()
17054 * @ingroup Progressbar
17056 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17059 * Get whether a given progress bar widget is at "pulsing mode" or
17062 * @param obj The progress bar object
17063 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
17064 * if it's in the default one (and on errors)
17066 * @ingroup Progressbar
17068 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17071 * Start/stop a given progress bar "pulsing" animation, if its
17074 * @param obj The progress bar object
17075 * @param state @c EINA_TRUE, to @b start the pulsing animation,
17076 * @c EINA_FALSE to @b stop it
17078 * @note This call won't do anything if @p obj is not under "pulsing mode".
17080 * @see elm_progressbar_pulse_set() for more details.
17082 * @ingroup Progressbar
17084 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17087 * Set the progress value (in percentage) on a given progress bar
17090 * @param obj The progress bar object
17091 * @param val The progress value (@b must be between @c 0.0 and @c
17094 * Use this call to set progress bar levels.
17096 * @note If you passes a value out of the specified range for @p
17097 * val, it will be interpreted as the @b closest of the @b boundary
17098 * values in the range.
17100 * @ingroup Progressbar
17102 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17105 * Get the progress value (in percentage) on a given progress bar
17108 * @param obj The progress bar object
17109 * @return The value of the progressbar
17111 * @see elm_progressbar_value_set() for more details
17113 * @ingroup Progressbar
17115 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17118 * Set the label of a given progress bar widget
17120 * @param obj The progress bar object
17121 * @param label The text label string, in UTF-8
17123 * @ingroup Progressbar
17124 * @deprecated use elm_object_text_set() instead.
17126 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17129 * Get the label of a given progress bar widget
17131 * @param obj The progressbar object
17132 * @return The text label string, in UTF-8
17134 * @ingroup Progressbar
17135 * @deprecated use elm_object_text_set() instead.
17137 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17140 * Set the icon object of a given progress bar widget
17142 * @param obj The progress bar object
17143 * @param icon The icon object
17145 * Use this call to decorate @p obj with an icon next to it.
17147 * @note Once the icon object is set, a previously set one will be
17148 * deleted. If you want to keep that old content object, use the
17149 * elm_progressbar_icon_unset() function.
17151 * @see elm_progressbar_icon_get()
17153 * @ingroup Progressbar
17155 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17158 * Retrieve the icon object set for a given progress bar widget
17160 * @param obj The progress bar object
17161 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17162 * otherwise (and on errors)
17164 * @see elm_progressbar_icon_set() for more details
17166 * @ingroup Progressbar
17168 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17171 * Unset an icon set on a given progress bar widget
17173 * @param obj The progress bar object
17174 * @return The icon object that was being used, if any was set, or
17175 * @c NULL, otherwise (and on errors)
17177 * This call will unparent and return the icon object which was set
17178 * for this widget, previously, on success.
17180 * @see elm_progressbar_icon_set() for more details
17182 * @ingroup Progressbar
17184 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17187 * Set the (exact) length of the bar region of a given progress bar
17190 * @param obj The progress bar object
17191 * @param size The length of the progress bar's bar region
17193 * This sets the minimum width (when in horizontal mode) or height
17194 * (when in vertical mode) of the actual bar area of the progress
17195 * bar @p obj. This in turn affects the object's minimum size. Use
17196 * this when you're not setting other size hints expanding on the
17197 * given direction (like weight and alignment hints) and you would
17198 * like it to have a specific size.
17200 * @note Icon, label and unit text around @p obj will require their
17201 * own space, which will make @p obj to require more the @p size,
17204 * @see elm_progressbar_span_size_get()
17206 * @ingroup Progressbar
17208 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17211 * Get the length set for the bar region of a given progress bar
17214 * @param obj The progress bar object
17215 * @return The length of the progress bar's bar region
17217 * If that size was not set previously, with
17218 * elm_progressbar_span_size_set(), this call will return @c 0.
17220 * @ingroup Progressbar
17222 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17225 * Set the format string for a given progress bar widget's units
17228 * @param obj The progress bar object
17229 * @param format The format string for @p obj's units label
17231 * If @c NULL is passed on @p format, it will make @p obj's units
17232 * area to be hidden completely. If not, it'll set the <b>format
17233 * string</b> for the units label's @b text. The units label is
17234 * provided a floating point value, so the units text is up display
17235 * at most one floating point falue. Note that the units label is
17236 * optional. Use a format string such as "%1.2f meters" for
17239 * @note The default format string for a progress bar is an integer
17240 * percentage, as in @c "%.0f %%".
17242 * @see elm_progressbar_unit_format_get()
17244 * @ingroup Progressbar
17246 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17249 * Retrieve the format string set for a given progress bar widget's
17252 * @param obj The progress bar object
17253 * @return The format set string for @p obj's units label or
17254 * @c NULL, if none was set (and on errors)
17256 * @see elm_progressbar_unit_format_set() for more details
17258 * @ingroup Progressbar
17260 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17263 * Set the orientation of a given progress bar widget
17265 * @param obj The progress bar object
17266 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17267 * @b horizontal, @c EINA_FALSE to make it @b vertical
17269 * Use this function to change how your progress bar is to be
17270 * disposed: vertically or horizontally.
17272 * @see elm_progressbar_horizontal_get()
17274 * @ingroup Progressbar
17276 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17279 * Retrieve the orientation of a given progress bar widget
17281 * @param obj The progress bar object
17282 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17283 * @c EINA_FALSE if it's @b vertical (and on errors)
17285 * @see elm_progressbar_horizontal_set() for more details
17287 * @ingroup Progressbar
17289 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17292 * Invert a given progress bar widget's displaying values order
17294 * @param obj The progress bar object
17295 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17296 * @c EINA_FALSE to bring it back to default, non-inverted values.
17298 * A progress bar may be @b inverted, in which state it gets its
17299 * values inverted, with high values being on the left or top and
17300 * low values on the right or bottom, as opposed to normally have
17301 * the low values on the former and high values on the latter,
17302 * respectively, for horizontal and vertical modes.
17304 * @see elm_progressbar_inverted_get()
17306 * @ingroup Progressbar
17308 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17311 * Get whether a given progress bar widget's displaying values are
17314 * @param obj The progress bar object
17315 * @return @c EINA_TRUE, if @p obj has inverted values,
17316 * @c EINA_FALSE otherwise (and on errors)
17318 * @see elm_progressbar_inverted_set() for more details
17320 * @ingroup Progressbar
17322 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17325 * @defgroup Separator Separator
17327 * @brief Separator is a very thin object used to separate other objects.
17329 * A separator can be vertical or horizontal.
17331 * @ref tutorial_separator is a good example of how to use a separator.
17335 * @brief Add a separator object to @p parent
17337 * @param parent The parent object
17339 * @return The separator object, or NULL upon failure
17341 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17343 * @brief Set the horizontal mode of a separator object
17345 * @param obj The separator object
17346 * @param horizontal If true, the separator is horizontal
17348 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17350 * @brief Get the horizontal mode of a separator object
17352 * @param obj The separator object
17353 * @return If true, the separator is horizontal
17355 * @see elm_separator_horizontal_set()
17357 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17363 * @defgroup Spinner Spinner
17364 * @ingroup Elementary
17366 * @image html img/widget/spinner/preview-00.png
17367 * @image latex img/widget/spinner/preview-00.eps
17369 * A spinner is a widget which allows the user to increase or decrease
17370 * numeric values using arrow buttons, or edit values directly, clicking
17371 * over it and typing the new value.
17373 * By default the spinner will not wrap and has a label
17374 * of "%.0f" (just showing the integer value of the double).
17376 * A spinner has a label that is formatted with floating
17377 * point values and thus accepts a printf-style format string, like
17380 * It also allows specific values to be replaced by pre-defined labels.
17382 * Smart callbacks one can register to:
17384 * - "changed" - Whenever the spinner value is changed.
17385 * - "delay,changed" - A short time after the value is changed by the user.
17386 * This will be called only when the user stops dragging for a very short
17387 * period or when they release their finger/mouse, so it avoids possibly
17388 * expensive reactions to the value change.
17390 * Available styles for it:
17392 * - @c "vertical": up/down buttons at the right side and text left aligned.
17394 * Here is an example on its usage:
17395 * @ref spinner_example
17399 * @addtogroup Spinner
17404 * Add a new spinner widget to the given parent Elementary
17405 * (container) object.
17407 * @param parent The parent object.
17408 * @return a new spinner widget handle or @c NULL, on errors.
17410 * This function inserts a new spinner widget on the canvas.
17415 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17418 * Set the format string of the displayed label.
17420 * @param obj The spinner object.
17421 * @param fmt The format string for the label display.
17423 * If @c NULL, this sets the format to "%.0f". If not it sets the format
17424 * string for the label text. The label text is provided a floating point
17425 * value, so the label text can display up to 1 floating point value.
17426 * Note that this is optional.
17428 * Use a format string such as "%1.2f meters" for example, and it will
17429 * display values like: "3.14 meters" for a value equal to 3.14159.
17431 * Default is "%0.f".
17433 * @see elm_spinner_label_format_get()
17437 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17440 * Get the label format of the spinner.
17442 * @param obj The spinner object.
17443 * @return The text label format string in UTF-8.
17445 * @see elm_spinner_label_format_set() for details.
17449 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17452 * Set the minimum and maximum values for the spinner.
17454 * @param obj The spinner object.
17455 * @param min The minimum value.
17456 * @param max The maximum value.
17458 * Define the allowed range of values to be selected by the user.
17460 * If actual value is less than @p min, it will be updated to @p min. If it
17461 * is bigger then @p max, will be updated to @p max. Actual value can be
17462 * get with elm_spinner_value_get().
17464 * By default, min is equal to 0, and max is equal to 100.
17466 * @warning Maximum must be greater than minimum.
17468 * @see elm_spinner_min_max_get()
17472 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17475 * Get the minimum and maximum values of the spinner.
17477 * @param obj The spinner object.
17478 * @param min Pointer where to store the minimum value.
17479 * @param max Pointer where to store the maximum value.
17481 * @note If only one value is needed, the other pointer can be passed
17484 * @see elm_spinner_min_max_set() for details.
17488 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17491 * Set the step used to increment or decrement the spinner value.
17493 * @param obj The spinner object.
17494 * @param step The step value.
17496 * This value will be incremented or decremented to the displayed value.
17497 * It will be incremented while the user keep right or top arrow pressed,
17498 * and will be decremented while the user keep left or bottom arrow pressed.
17500 * The interval to increment / decrement can be set with
17501 * elm_spinner_interval_set().
17503 * By default step value is equal to 1.
17505 * @see elm_spinner_step_get()
17509 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17512 * Get the step used to increment or decrement the spinner value.
17514 * @param obj The spinner object.
17515 * @return The step value.
17517 * @see elm_spinner_step_get() for more details.
17521 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17524 * Set the value the spinner displays.
17526 * @param obj The spinner object.
17527 * @param val The value to be displayed.
17529 * Value will be presented on the label following format specified with
17530 * elm_spinner_format_set().
17532 * @warning The value must to be between min and max values. This values
17533 * are set by elm_spinner_min_max_set().
17535 * @see elm_spinner_value_get().
17536 * @see elm_spinner_format_set().
17537 * @see elm_spinner_min_max_set().
17541 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17544 * Get the value displayed by the spinner.
17546 * @param obj The spinner object.
17547 * @return The value displayed.
17549 * @see elm_spinner_value_set() for details.
17553 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17556 * Set whether the spinner should wrap when it reaches its
17557 * minimum or maximum value.
17559 * @param obj The spinner object.
17560 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17563 * Disabled by default. If disabled, when the user tries to increment the
17565 * but displayed value plus step value is bigger than maximum value,
17567 * won't allow it. The same happens when the user tries to decrement it,
17568 * but the value less step is less than minimum value.
17570 * When wrap is enabled, in such situations it will allow these changes,
17571 * but will get the value that would be less than minimum and subtracts
17572 * from maximum. Or add the value that would be more than maximum to
17576 * @li min value = 10
17577 * @li max value = 50
17578 * @li step value = 20
17579 * @li displayed value = 20
17581 * When the user decrement value (using left or bottom arrow), it will
17582 * displays @c 40, because max - (min - (displayed - step)) is
17583 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17585 * @see elm_spinner_wrap_get().
17589 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17592 * Get whether the spinner should wrap when it reaches its
17593 * minimum or maximum value.
17595 * @param obj The spinner object
17596 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17597 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17599 * @see elm_spinner_wrap_set() for details.
17603 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17606 * Set whether the spinner can be directly edited by the user or not.
17608 * @param obj The spinner object.
17609 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17610 * don't allow users to edit it directly.
17612 * Spinner objects can have edition @b disabled, in which state they will
17613 * be changed only by arrows.
17614 * Useful for contexts
17615 * where you don't want your users to interact with it writting the value.
17617 * when using special values, the user can see real value instead
17618 * of special label on edition.
17620 * It's enabled by default.
17622 * @see elm_spinner_editable_get()
17626 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17629 * Get whether the spinner can be directly edited by the user or not.
17631 * @param obj The spinner object.
17632 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17633 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17635 * @see elm_spinner_editable_set() for details.
17639 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17642 * Set a special string to display in the place of the numerical value.
17644 * @param obj The spinner object.
17645 * @param value The value to be replaced.
17646 * @param label The label to be used.
17648 * It's useful for cases when a user should select an item that is
17649 * better indicated by a label than a value. For example, weekdays or months.
17653 * sp = elm_spinner_add(win);
17654 * elm_spinner_min_max_set(sp, 1, 3);
17655 * elm_spinner_special_value_add(sp, 1, "January");
17656 * elm_spinner_special_value_add(sp, 2, "February");
17657 * elm_spinner_special_value_add(sp, 3, "March");
17658 * evas_object_show(sp);
17663 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
17666 * Set the interval on time updates for an user mouse button hold
17667 * on spinner widgets' arrows.
17669 * @param obj The spinner object.
17670 * @param interval The (first) interval value in seconds.
17672 * This interval value is @b decreased while the user holds the
17673 * mouse pointer either incrementing or decrementing spinner's value.
17675 * This helps the user to get to a given value distant from the
17676 * current one easier/faster, as it will start to change quicker and
17677 * quicker on mouse button holds.
17679 * The calculation for the next change interval value, starting from
17680 * the one set with this call, is the previous interval divided by
17681 * @c 1.05, so it decreases a little bit.
17683 * The default starting interval value for automatic changes is
17686 * @see elm_spinner_interval_get()
17690 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
17693 * Get the interval on time updates for an user mouse button hold
17694 * on spinner widgets' arrows.
17696 * @param obj The spinner object.
17697 * @return The (first) interval value, in seconds, set on it.
17699 * @see elm_spinner_interval_set() for more details.
17703 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17710 * @defgroup Index Index
17712 * @image html img/widget/index/preview-00.png
17714 * An index widget gives you an index for fast access to whichever
17715 * group of other UI items one might have. It's a list of text
17716 * items (usually letters, for alphabetically ordered access).
17718 * Index widgets are by default hidden and just appear when the
17719 * user clicks over it's reserved area in the canvas. In its
17720 * default theme, it's an area one @ref Fingers "finger" wide on
17721 * the right side of the index widget's container.
17723 * When items on the index are selected, smart callbacks get
17724 * called, so that its user can make other container objects to
17725 * show a given area or child object depending on the index item
17726 * selected. You'd probably be using an index together with @ref
17727 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
17730 * Smart events one can add callbacks for are:
17731 * - @c "changed" - When the selected index item changes. @c
17732 * event_info is the selected item's data pointer.
17733 * - @c "delay,changed" - When the selected index item changes, but
17734 * after a small idling period. @c event_info is the selected
17735 * item's data pointer.
17736 * - @c "selected" - When the user releases a mouse button and
17737 * selects an item. @c event_info is the selected item's data
17739 * - @c "level,up" - when the user moves a finger from the first
17740 * level to the second level
17741 * - @c "level,down" - when the user moves a finger from the second
17742 * level to the first level
17744 * The @c "delay,changed" event is so that it'll wait a small time
17745 * before actually reporting those events and, moreover, just the
17746 * last event happening on those time frames will actually be
17749 * Here are some examples on its usage:
17750 * @li @ref index_example_01
17751 * @li @ref index_example_02
17755 * @addtogroup Index
17759 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
17762 * Add a new index widget to the given parent Elementary
17763 * (container) object
17765 * @param parent The parent object
17766 * @return a new index widget handle or @c NULL, on errors
17768 * This function inserts a new index widget on the canvas.
17772 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17775 * Set whether a given index widget is or not visible,
17778 * @param obj The index object
17779 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
17781 * Not to be confused with visible as in @c evas_object_show() --
17782 * visible with regard to the widget's auto hiding feature.
17784 * @see elm_index_active_get()
17788 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
17791 * Get whether a given index widget is currently visible or not.
17793 * @param obj The index object
17794 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
17796 * @see elm_index_active_set() for more details
17800 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17803 * Set the items level for a given index widget.
17805 * @param obj The index object.
17806 * @param level @c 0 or @c 1, the currently implemented levels.
17808 * @see elm_index_item_level_get()
17812 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17815 * Get the items level set for a given index widget.
17817 * @param obj The index object.
17818 * @return @c 0 or @c 1, which are the levels @p obj might be at.
17820 * @see elm_index_item_level_set() for more information
17824 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17827 * Returns the last selected item's data, for a given index widget.
17829 * @param obj The index object.
17830 * @return The item @b data associated to the last selected item on
17831 * @p obj (or @c NULL, on errors).
17833 * @warning The returned value is @b not an #Elm_Index_Item item
17834 * handle, but the data associated to it (see the @c item parameter
17835 * in elm_index_item_append(), as an example).
17839 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17842 * Append a new item on a given index widget.
17844 * @param obj The index object.
17845 * @param letter Letter under which the item should be indexed
17846 * @param item The item data to set for the index's item
17848 * Despite the most common usage of the @p letter argument is for
17849 * single char strings, one could use arbitrary strings as index
17852 * @c item will be the pointer returned back on @c "changed", @c
17853 * "delay,changed" and @c "selected" smart events.
17857 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17860 * Prepend a new item on a given index widget.
17862 * @param obj The index object.
17863 * @param letter Letter under which the item should be indexed
17864 * @param item The item data to set for the index's item
17866 * Despite the most common usage of the @p letter argument is for
17867 * single char strings, one could use arbitrary strings as index
17870 * @c item will be the pointer returned back on @c "changed", @c
17871 * "delay,changed" and @c "selected" smart events.
17875 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17878 * Append a new item, on a given index widget, <b>after the item
17879 * having @p relative as data</b>.
17881 * @param obj The index object.
17882 * @param letter Letter under which the item should be indexed
17883 * @param item The item data to set for the index's item
17884 * @param relative The item data of the index item to be the
17885 * predecessor of this new one
17887 * Despite the most common usage of the @p letter argument is for
17888 * single char strings, one could use arbitrary strings as index
17891 * @c item will be the pointer returned back on @c "changed", @c
17892 * "delay,changed" and @c "selected" smart events.
17894 * @note If @p relative is @c NULL or if it's not found to be data
17895 * set on any previous item on @p obj, this function will behave as
17896 * elm_index_item_append().
17900 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17903 * Prepend a new item, on a given index widget, <b>after the item
17904 * having @p relative as data</b>.
17906 * @param obj The index object.
17907 * @param letter Letter under which the item should be indexed
17908 * @param item The item data to set for the index's item
17909 * @param relative The item data of the index item to be the
17910 * successor of this new one
17912 * Despite the most common usage of the @p letter argument is for
17913 * single char strings, one could use arbitrary strings as index
17916 * @c item will be the pointer returned back on @c "changed", @c
17917 * "delay,changed" and @c "selected" smart events.
17919 * @note If @p relative is @c NULL or if it's not found to be data
17920 * set on any previous item on @p obj, this function will behave as
17921 * elm_index_item_prepend().
17925 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17928 * Insert a new item into the given index widget, using @p cmp_func
17929 * function to sort items (by item handles).
17931 * @param obj The index object.
17932 * @param letter Letter under which the item should be indexed
17933 * @param item The item data to set for the index's item
17934 * @param cmp_func The comparing function to be used to sort index
17935 * items <b>by #Elm_Index_Item item handles</b>
17936 * @param cmp_data_func A @b fallback function to be called for the
17937 * sorting of index items <b>by item data</b>). It will be used
17938 * when @p cmp_func returns @c 0 (equality), which means an index
17939 * item with provided item data already exists. To decide which
17940 * data item should be pointed to by the index item in question, @p
17941 * cmp_data_func will be used. If @p cmp_data_func returns a
17942 * non-negative value, the previous index item data will be
17943 * replaced by the given @p item pointer. If the previous data need
17944 * to be freed, it should be done by the @p cmp_data_func function,
17945 * because all references to it will be lost. If this function is
17946 * not provided (@c NULL is given), index items will be @b
17947 * duplicated, if @p cmp_func returns @c 0.
17949 * Despite the most common usage of the @p letter argument is for
17950 * single char strings, one could use arbitrary strings as index
17953 * @c item will be the pointer returned back on @c "changed", @c
17954 * "delay,changed" and @c "selected" smart events.
17958 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);
17961 * Remove an item from a given index widget, <b>to be referenced by
17962 * it's data value</b>.
17964 * @param obj The index object
17965 * @param item The item's data pointer for the item to be removed
17968 * If a deletion callback is set, via elm_index_item_del_cb_set(),
17969 * that callback function will be called by this one.
17971 * @warning The item to be removed from @p obj will be found via
17972 * its item data pointer, and not by an #Elm_Index_Item handle.
17976 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
17979 * Find a given index widget's item, <b>using item data</b>.
17981 * @param obj The index object
17982 * @param item The item data pointed to by the desired index item
17983 * @return The index item handle, if found, or @c NULL otherwise
17987 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
17990 * Removes @b all items from a given index widget.
17992 * @param obj The index object.
17994 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
17995 * that callback function will be called for each item in @p obj.
17999 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18002 * Go to a given items level on a index widget
18004 * @param obj The index object
18005 * @param level The index level (one of @c 0 or @c 1)
18009 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18012 * Return the data associated with a given index widget item
18014 * @param it The index widget item handle
18015 * @return The data associated with @p it
18017 * @see elm_index_item_data_set()
18021 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18024 * Set the data associated with a given index widget item
18026 * @param it The index widget item handle
18027 * @param data The new data pointer to set to @p it
18029 * This sets new item data on @p it.
18031 * @warning The old data pointer won't be touched by this function, so
18032 * the user had better to free that old data himself/herself.
18036 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18039 * Set the function to be called when a given index widget item is freed.
18041 * @param it The item to set the callback on
18042 * @param func The function to call on the item's deletion
18044 * When called, @p func will have both @c data and @c event_info
18045 * arguments with the @p it item's data value and, naturally, the
18046 * @c obj argument with a handle to the parent index widget.
18050 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18053 * Get the letter (string) set on a given index widget item.
18055 * @param it The index item handle
18056 * @return The letter string set on @p it
18060 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18067 * @defgroup Photocam Photocam
18069 * @image html img/widget/photocam/preview-00.png
18070 * @image latex img/widget/photocam/preview-00.eps
18072 * This is a widget specifically for displaying high-resolution digital
18073 * camera photos giving speedy feedback (fast load), low memory footprint
18074 * and zooming and panning as well as fitting logic. It is entirely focused
18075 * on jpeg images, and takes advantage of properties of the jpeg format (via
18076 * evas loader features in the jpeg loader).
18078 * Signals that you can add callbacks for are:
18079 * @li "clicked" - This is called when a user has clicked the photo without
18081 * @li "press" - This is called when a user has pressed down on the photo.
18082 * @li "longpressed" - This is called when a user has pressed down on the
18083 * photo for a long time without dragging around.
18084 * @li "clicked,double" - This is called when a user has double-clicked the
18086 * @li "load" - Photo load begins.
18087 * @li "loaded" - This is called when the image file load is complete for the
18088 * first view (low resolution blurry version).
18089 * @li "load,detail" - Photo detailed data load begins.
18090 * @li "loaded,detail" - This is called when the image file load is complete
18091 * for the detailed image data (full resolution needed).
18092 * @li "zoom,start" - Zoom animation started.
18093 * @li "zoom,stop" - Zoom animation stopped.
18094 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18095 * @li "scroll" - the content has been scrolled (moved)
18096 * @li "scroll,anim,start" - scrolling animation has started
18097 * @li "scroll,anim,stop" - scrolling animation has stopped
18098 * @li "scroll,drag,start" - dragging the contents around has started
18099 * @li "scroll,drag,stop" - dragging the contents around has stopped
18101 * @ref tutorial_photocam shows the API in action.
18105 * @brief Types of zoom available.
18107 typedef enum _Elm_Photocam_Zoom_Mode
18109 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18110 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18111 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18112 ELM_PHOTOCAM_ZOOM_MODE_LAST
18113 } Elm_Photocam_Zoom_Mode;
18115 * @brief Add a new Photocam object
18117 * @param parent The parent object
18118 * @return The new object or NULL if it cannot be created
18120 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18122 * @brief Set the photo file to be shown
18124 * @param obj The photocam object
18125 * @param file The photo file
18126 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18128 * This sets (and shows) the specified file (with a relative or absolute
18129 * path) and will return a load error (same error that
18130 * evas_object_image_load_error_get() will return). The image will change and
18131 * adjust its size at this point and begin a background load process for this
18132 * photo that at some time in the future will be displayed at the full
18135 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18137 * @brief Returns the path of the current image file
18139 * @param obj The photocam object
18140 * @return Returns the path
18142 * @see elm_photocam_file_set()
18144 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18146 * @brief Set the zoom level of the photo
18148 * @param obj The photocam object
18149 * @param zoom The zoom level to set
18151 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18152 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18153 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18154 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18157 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18159 * @brief Get the zoom level of the photo
18161 * @param obj The photocam object
18162 * @return The current zoom level
18164 * This returns the current zoom level of the photocam object. Note that if
18165 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18166 * (which is the default), the zoom level may be changed at any time by the
18167 * photocam object itself to account for photo size and photocam viewpoer
18170 * @see elm_photocam_zoom_set()
18171 * @see elm_photocam_zoom_mode_set()
18173 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18175 * @brief Set the zoom mode
18177 * @param obj The photocam object
18178 * @param mode The desired mode
18180 * This sets the zoom mode to manual or one of several automatic levels.
18181 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18182 * elm_photocam_zoom_set() and will stay at that level until changed by code
18183 * or until zoom mode is changed. This is the default mode. The Automatic
18184 * modes will allow the photocam object to automatically adjust zoom mode
18185 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18186 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18187 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18188 * pixels within the frame are left unfilled.
18190 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18192 * @brief Get the zoom mode
18194 * @param obj The photocam object
18195 * @return The current zoom mode
18197 * This gets the current zoom mode of the photocam object.
18199 * @see elm_photocam_zoom_mode_set()
18201 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18203 * @brief Get the current image pixel width and height
18205 * @param obj The photocam object
18206 * @param w A pointer to the width return
18207 * @param h A pointer to the height return
18209 * This gets the current photo pixel width and height (for the original).
18210 * The size will be returned in the integers @p w and @p h that are pointed
18213 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18215 * @brief Get the area of the image that is currently shown
18218 * @param x A pointer to the X-coordinate of region
18219 * @param y A pointer to the Y-coordinate of region
18220 * @param w A pointer to the width
18221 * @param h A pointer to the height
18223 * @see elm_photocam_image_region_show()
18224 * @see elm_photocam_image_region_bring_in()
18226 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18228 * @brief Set the viewed portion of the image
18230 * @param obj The photocam object
18231 * @param x X-coordinate of region in image original pixels
18232 * @param y Y-coordinate of region in image original pixels
18233 * @param w Width of region in image original pixels
18234 * @param h Height of region in image original pixels
18236 * This shows the region of the image without using animation.
18238 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18240 * @brief Bring in the viewed portion of the image
18242 * @param obj The photocam object
18243 * @param x X-coordinate of region in image original pixels
18244 * @param y Y-coordinate of region in image original pixels
18245 * @param w Width of region in image original pixels
18246 * @param h Height of region in image original pixels
18248 * This shows the region of the image using animation.
18250 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18252 * @brief Set the paused state for photocam
18254 * @param obj The photocam object
18255 * @param paused The pause state to set
18257 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18258 * photocam. The default is off. This will stop zooming using animation on
18259 * zoom levels changes and change instantly. This will stop any existing
18260 * animations that are running.
18262 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18264 * @brief Get the paused state for photocam
18266 * @param obj The photocam object
18267 * @return The current paused state
18269 * This gets the current paused state for the photocam object.
18271 * @see elm_photocam_paused_set()
18273 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18275 * @brief Get the internal low-res image used for photocam
18277 * @param obj The photocam object
18278 * @return The internal image object handle, or NULL if none exists
18280 * This gets the internal image object inside photocam. Do not modify it. It
18281 * is for inspection only, and hooking callbacks to. Nothing else. It may be
18282 * deleted at any time as well.
18284 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18286 * @brief Set the photocam scrolling bouncing.
18288 * @param obj The photocam object
18289 * @param h_bounce bouncing for horizontal
18290 * @param v_bounce bouncing for vertical
18292 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18294 * @brief Get the photocam scrolling bouncing.
18296 * @param obj The photocam object
18297 * @param h_bounce bouncing for horizontal
18298 * @param v_bounce bouncing for vertical
18300 * @see elm_photocam_bounce_set()
18302 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18308 * @defgroup Map Map
18309 * @ingroup Elementary
18311 * @image html img/widget/map/preview-00.png
18312 * @image latex img/widget/map/preview-00.eps
18314 * This is a widget specifically for displaying a map. It uses basically
18315 * OpenStreetMap provider http://www.openstreetmap.org/,
18316 * but custom providers can be added.
18318 * It supports some basic but yet nice features:
18319 * @li zoom and scroll
18320 * @li markers with content to be displayed when user clicks over it
18321 * @li group of markers
18324 * Smart callbacks one can listen to:
18326 * - "clicked" - This is called when a user has clicked the map without
18328 * - "press" - This is called when a user has pressed down on the map.
18329 * - "longpressed" - This is called when a user has pressed down on the map
18330 * for a long time without dragging around.
18331 * - "clicked,double" - This is called when a user has double-clicked
18333 * - "load,detail" - Map detailed data load begins.
18334 * - "loaded,detail" - This is called when all currently visible parts of
18335 * the map are loaded.
18336 * - "zoom,start" - Zoom animation started.
18337 * - "zoom,stop" - Zoom animation stopped.
18338 * - "zoom,change" - Zoom changed when using an auto zoom mode.
18339 * - "scroll" - the content has been scrolled (moved).
18340 * - "scroll,anim,start" - scrolling animation has started.
18341 * - "scroll,anim,stop" - scrolling animation has stopped.
18342 * - "scroll,drag,start" - dragging the contents around has started.
18343 * - "scroll,drag,stop" - dragging the contents around has stopped.
18344 * - "downloaded" - This is called when all currently required map images
18346 * - "route,load" - This is called when route request begins.
18347 * - "route,loaded" - This is called when route request ends.
18348 * - "name,load" - This is called when name request begins.
18349 * - "name,loaded- This is called when name request ends.
18351 * Available style for map widget:
18354 * Available style for markers:
18359 * Available style for marker bubble:
18362 * List of examples:
18363 * @li @ref map_example_01
18364 * @li @ref map_example_02
18365 * @li @ref map_example_03
18374 * @enum _Elm_Map_Zoom_Mode
18375 * @typedef Elm_Map_Zoom_Mode
18377 * Set map's zoom behavior. It can be set to manual or automatic.
18379 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
18381 * Values <b> don't </b> work as bitmask, only one can be choosen.
18383 * @note Valid sizes are 2^zoom, consequently the map may be smaller
18384 * than the scroller view.
18386 * @see elm_map_zoom_mode_set()
18387 * @see elm_map_zoom_mode_get()
18391 typedef enum _Elm_Map_Zoom_Mode
18393 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
18394 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
18395 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
18396 ELM_MAP_ZOOM_MODE_LAST
18397 } Elm_Map_Zoom_Mode;
18400 * @enum _Elm_Map_Route_Sources
18401 * @typedef Elm_Map_Route_Sources
18403 * Set route service to be used. By default used source is
18404 * #ELM_MAP_ROUTE_SOURCE_YOURS.
18406 * @see elm_map_route_source_set()
18407 * @see elm_map_route_source_get()
18411 typedef enum _Elm_Map_Route_Sources
18413 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
18414 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. */
18415 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
18416 ELM_MAP_ROUTE_SOURCE_LAST
18417 } Elm_Map_Route_Sources;
18419 typedef enum _Elm_Map_Name_Sources
18421 ELM_MAP_NAME_SOURCE_NOMINATIM,
18422 ELM_MAP_NAME_SOURCE_LAST
18423 } Elm_Map_Name_Sources;
18426 * @enum _Elm_Map_Route_Type
18427 * @typedef Elm_Map_Route_Type
18429 * Set type of transport used on route.
18431 * @see elm_map_route_add()
18435 typedef enum _Elm_Map_Route_Type
18437 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
18438 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
18439 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
18440 ELM_MAP_ROUTE_TYPE_LAST
18441 } Elm_Map_Route_Type;
18444 * @enum _Elm_Map_Route_Method
18445 * @typedef Elm_Map_Route_Method
18447 * Set the routing method, what should be priorized, time or distance.
18449 * @see elm_map_route_add()
18453 typedef enum _Elm_Map_Route_Method
18455 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
18456 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
18457 ELM_MAP_ROUTE_METHOD_LAST
18458 } Elm_Map_Route_Method;
18460 typedef enum _Elm_Map_Name_Method
18462 ELM_MAP_NAME_METHOD_SEARCH,
18463 ELM_MAP_NAME_METHOD_REVERSE,
18464 ELM_MAP_NAME_METHOD_LAST
18465 } Elm_Map_Name_Method;
18467 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(). */
18468 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(). */
18469 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(). */
18470 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(). */
18471 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
18472 typedef struct _Elm_Map_Track Elm_Map_Track;
18474 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. */
18475 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
18476 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
18477 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
18479 typedef char *(*ElmMapModuleSourceFunc) (void);
18480 typedef int (*ElmMapModuleZoomMinFunc) (void);
18481 typedef int (*ElmMapModuleZoomMaxFunc) (void);
18482 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18483 typedef int (*ElmMapModuleRouteSourceFunc) (void);
18484 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18485 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18486 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18487 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18490 * Add a new map widget to the given parent Elementary (container) object.
18492 * @param parent The parent object.
18493 * @return a new map widget handle or @c NULL, on errors.
18495 * This function inserts a new map widget on the canvas.
18499 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18502 * Set the zoom level of the map.
18504 * @param obj The map object.
18505 * @param zoom The zoom level to set.
18507 * This sets the zoom level.
18509 * It will respect limits defined by elm_map_source_zoom_min_set() and
18510 * elm_map_source_zoom_max_set().
18512 * By default these values are 0 (world map) and 18 (maximum zoom).
18514 * This function should be used when zoom mode is set to
18515 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
18516 * with elm_map_zoom_mode_set().
18518 * @see elm_map_zoom_mode_set().
18519 * @see elm_map_zoom_get().
18523 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18526 * Get the zoom level of the map.
18528 * @param obj The map object.
18529 * @return The current zoom level.
18531 * This returns the current zoom level of the map object.
18533 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
18534 * (which is the default), the zoom level may be changed at any time by the
18535 * map object itself to account for map size and map viewport size.
18537 * @see elm_map_zoom_set() for details.
18541 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18544 * Set the zoom mode used by the map object.
18546 * @param obj The map object.
18547 * @param mode The zoom mode of the map, being it one of
18548 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18549 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18551 * This sets the zoom mode to manual or one of the automatic levels.
18552 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
18553 * elm_map_zoom_set() and will stay at that level until changed by code
18554 * or until zoom mode is changed. This is the default mode.
18556 * The Automatic modes will allow the map object to automatically
18557 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
18558 * adjust zoom so the map fits inside the scroll frame with no pixels
18559 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
18560 * ensure no pixels within the frame are left unfilled. Do not forget that
18561 * the valid sizes are 2^zoom, consequently the map may be smaller than
18562 * the scroller view.
18564 * @see elm_map_zoom_set()
18568 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18571 * Get the zoom mode used by the map object.
18573 * @param obj The map object.
18574 * @return The zoom mode of the map, being it one of
18575 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18576 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18578 * This function returns the current zoom mode used by the map object.
18580 * @see elm_map_zoom_mode_set() for more details.
18584 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18587 * Get the current coordinates of the map.
18589 * @param obj The map object.
18590 * @param lon Pointer where to store longitude.
18591 * @param lat Pointer where to store latitude.
18593 * This gets the current center coordinates of the map object. It can be
18594 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
18596 * @see elm_map_geo_region_bring_in()
18597 * @see elm_map_geo_region_show()
18601 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18604 * Animatedly bring in given coordinates to the center of the map.
18606 * @param obj The map object.
18607 * @param lon Longitude to center at.
18608 * @param lat Latitude to center at.
18610 * This causes map to jump to the given @p lat and @p lon coordinates
18611 * and show it (by scrolling) in the center of the viewport, if it is not
18612 * already centered. This will use animation to do so and take a period
18613 * of time to complete.
18615 * @see elm_map_geo_region_show() for a function to avoid animation.
18616 * @see elm_map_geo_region_get()
18620 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18623 * Show the given coordinates at the center of the map, @b immediately.
18625 * @param obj The map object.
18626 * @param lon Longitude to center at.
18627 * @param lat Latitude to center at.
18629 * This causes map to @b redraw its viewport's contents to the
18630 * region contining the given @p lat and @p lon, that will be moved to the
18631 * center of the map.
18633 * @see elm_map_geo_region_bring_in() for a function to move with animation.
18634 * @see elm_map_geo_region_get()
18638 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18641 * Pause or unpause the map.
18643 * @param obj The map object.
18644 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
18647 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18650 * The default is off.
18652 * This will stop zooming using animation, changing zoom levels will
18653 * change instantly. This will stop any existing animations that are running.
18655 * @see elm_map_paused_get()
18659 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18662 * Get a value whether map is paused or not.
18664 * @param obj The map object.
18665 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
18666 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
18668 * This gets the current paused state for the map object.
18670 * @see elm_map_paused_set() for details.
18674 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18677 * Set to show markers during zoom level changes or not.
18679 * @param obj The map object.
18680 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
18683 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18686 * The default is off.
18688 * This will stop zooming using animation, changing zoom levels will
18689 * change instantly. This will stop any existing animations that are running.
18691 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18694 * The default is off.
18696 * Enabling it will force the map to stop displaying the markers during
18697 * zoom level changes. Set to on if you have a large number of markers.
18699 * @see elm_map_paused_markers_get()
18703 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18706 * Get a value whether markers will be displayed on zoom level changes or not
18708 * @param obj The map object.
18709 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
18710 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
18712 * This gets the current markers paused state for the map object.
18714 * @see elm_map_paused_markers_set() for details.
18718 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18721 * Get the information of downloading status.
18723 * @param obj The map object.
18724 * @param try_num Pointer where to store number of tiles being downloaded.
18725 * @param finish_num Pointer where to store number of tiles successfully
18728 * This gets the current downloading status for the map object, the number
18729 * of tiles being downloaded and the number of tiles already downloaded.
18733 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
18736 * Convert a pixel coordinate (x,y) into a geographic coordinate
18737 * (longitude, latitude).
18739 * @param obj The map object.
18740 * @param x the coordinate.
18741 * @param y the coordinate.
18742 * @param size the size in pixels of the map.
18743 * The map is a square and generally his size is : pow(2.0, zoom)*256.
18744 * @param lon Pointer where to store the longitude that correspond to x.
18745 * @param lat Pointer where to store the latitude that correspond to y.
18747 * @note Origin pixel point is the top left corner of the viewport.
18748 * Map zoom and size are taken on account.
18750 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
18754 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);
18757 * Convert a geographic coordinate (longitude, latitude) into a pixel
18758 * coordinate (x, y).
18760 * @param obj The map object.
18761 * @param lon the longitude.
18762 * @param lat the latitude.
18763 * @param size the size in pixels of the map. The map is a square
18764 * and generally his size is : pow(2.0, zoom)*256.
18765 * @param x Pointer where to store the horizontal pixel coordinate that
18766 * correspond to the longitude.
18767 * @param y Pointer where to store the vertical pixel coordinate that
18768 * correspond to the latitude.
18770 * @note Origin pixel point is the top left corner of the viewport.
18771 * Map zoom and size are taken on account.
18773 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
18777 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);
18780 * Convert a geographic coordinate (longitude, latitude) into a name
18783 * @param obj The map object.
18784 * @param lon the longitude.
18785 * @param lat the latitude.
18786 * @return name A #Elm_Map_Name handle for this coordinate.
18788 * To get the string for this address, elm_map_name_address_get()
18791 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
18795 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18798 * Convert a name (address) into a geographic coordinate
18799 * (longitude, latitude).
18801 * @param obj The map object.
18802 * @param name The address.
18803 * @return name A #Elm_Map_Name handle for this address.
18805 * To get the longitude and latitude, elm_map_name_region_get()
18808 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
18812 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
18815 * Convert a pixel coordinate into a rotated pixel coordinate.
18817 * @param obj The map object.
18818 * @param x horizontal coordinate of the point to rotate.
18819 * @param y vertical coordinate of the point to rotate.
18820 * @param cx rotation's center horizontal position.
18821 * @param cy rotation's center vertical position.
18822 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
18823 * @param xx Pointer where to store rotated x.
18824 * @param yy Pointer where to store rotated y.
18828 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);
18831 * Add a new marker to the map object.
18833 * @param obj The map object.
18834 * @param lon The longitude of the marker.
18835 * @param lat The latitude of the marker.
18836 * @param clas The class, to use when marker @b isn't grouped to others.
18837 * @param clas_group The class group, to use when marker is grouped to others
18838 * @param data The data passed to the callbacks.
18840 * @return The created marker or @c NULL upon failure.
18842 * A marker will be created and shown in a specific point of the map, defined
18843 * by @p lon and @p lat.
18845 * It will be displayed using style defined by @p class when this marker
18846 * is displayed alone (not grouped). A new class can be created with
18847 * elm_map_marker_class_new().
18849 * If the marker is grouped to other markers, it will be displayed with
18850 * style defined by @p class_group. Markers with the same group are grouped
18851 * if they are close. A new group class can be created with
18852 * elm_map_marker_group_class_new().
18854 * Markers created with this method can be deleted with
18855 * elm_map_marker_remove().
18857 * A marker can have associated content to be displayed by a bubble,
18858 * when a user click over it, as well as an icon. These objects will
18859 * be fetch using class' callback functions.
18861 * @see elm_map_marker_class_new()
18862 * @see elm_map_marker_group_class_new()
18863 * @see elm_map_marker_remove()
18867 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);
18870 * Set the maximum numbers of markers' content to be displayed in a group.
18872 * @param obj The map object.
18873 * @param max The maximum numbers of items displayed in a bubble.
18875 * A bubble will be displayed when the user clicks over the group,
18876 * and will place the content of markers that belong to this group
18879 * A group can have a long list of markers, consequently the creation
18880 * of the content of the bubble can be very slow.
18882 * In order to avoid this, a maximum number of items is displayed
18885 * By default this number is 30.
18887 * Marker with the same group class are grouped if they are close.
18889 * @see elm_map_marker_add()
18893 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
18896 * Remove a marker from the map.
18898 * @param marker The marker to remove.
18900 * @see elm_map_marker_add()
18904 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18907 * Get the current coordinates of the marker.
18909 * @param marker marker.
18910 * @param lat Pointer where to store the marker's latitude.
18911 * @param lon Pointer where to store the marker's longitude.
18913 * These values are set when adding markers, with function
18914 * elm_map_marker_add().
18916 * @see elm_map_marker_add()
18920 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
18923 * Animatedly bring in given marker to the center of the map.
18925 * @param marker The marker to center at.
18927 * This causes map to jump to the given @p marker's coordinates
18928 * and show it (by scrolling) in the center of the viewport, if it is not
18929 * already centered. This will use animation to do so and take a period
18930 * of time to complete.
18932 * @see elm_map_marker_show() for a function to avoid animation.
18933 * @see elm_map_marker_region_get()
18937 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18940 * Show the given marker at the center of the map, @b immediately.
18942 * @param marker The marker to center at.
18944 * This causes map to @b redraw its viewport's contents to the
18945 * region contining the given @p marker's coordinates, that will be
18946 * moved to the center of the map.
18948 * @see elm_map_marker_bring_in() for a function to move with animation.
18949 * @see elm_map_markers_list_show() if more than one marker need to be
18951 * @see elm_map_marker_region_get()
18955 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18958 * Move and zoom the map to display a list of markers.
18960 * @param markers A list of #Elm_Map_Marker handles.
18962 * The map will be centered on the center point of the markers in the list.
18963 * Then the map will be zoomed in order to fit the markers using the maximum
18964 * zoom which allows display of all the markers.
18966 * @warning All the markers should belong to the same map object.
18968 * @see elm_map_marker_show() to show a single marker.
18969 * @see elm_map_marker_bring_in()
18973 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
18976 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
18978 * @param marker The marker wich content should be returned.
18979 * @return Return the evas object if it exists, else @c NULL.
18981 * To set callback function #ElmMapMarkerGetFunc for the marker class,
18982 * elm_map_marker_class_get_cb_set() should be used.
18984 * This content is what will be inside the bubble that will be displayed
18985 * when an user clicks over the marker.
18987 * This returns the actual Evas object used to be placed inside
18988 * the bubble. This may be @c NULL, as it may
18989 * not have been created or may have been deleted, at any time, by
18990 * the map. <b>Do not modify this object</b> (move, resize,
18991 * show, hide, etc.), as the map is controlling it. This
18992 * function is for querying, emitting custom signals or hooking
18993 * lower level callbacks for events on that object. Do not delete
18994 * this object under any circumstances.
18998 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19001 * Update the marker
19003 * @param marker The marker to be updated.
19005 * If a content is set to this marker, it will call function to delete it,
19006 * #ElmMapMarkerDelFunc, and then will fetch the content again with
19007 * #ElmMapMarkerGetFunc.
19009 * These functions are set for the marker class with
19010 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
19014 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19017 * Close all the bubbles opened by the user.
19019 * @param obj The map object.
19021 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
19022 * when the user clicks on a marker.
19024 * This functions is set for the marker class with
19025 * elm_map_marker_class_get_cb_set().
19029 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
19032 * Create a new group class.
19034 * @param obj The map object.
19035 * @return Returns the new group class.
19037 * Each marker must be associated to a group class. Markers in the same
19038 * group are grouped if they are close.
19040 * The group class defines the style of the marker when a marker is grouped
19041 * to others markers. When it is alone, another class will be used.
19043 * A group class will need to be provided when creating a marker with
19044 * elm_map_marker_add().
19046 * Some properties and functions can be set by class, as:
19047 * - style, with elm_map_group_class_style_set()
19048 * - data - to be associated to the group class. It can be set using
19049 * elm_map_group_class_data_set().
19050 * - min zoom to display markers, set with
19051 * elm_map_group_class_zoom_displayed_set().
19052 * - max zoom to group markers, set using
19053 * elm_map_group_class_zoom_grouped_set().
19054 * - visibility - set if markers will be visible or not, set with
19055 * elm_map_group_class_hide_set().
19056 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
19057 * It can be set using elm_map_group_class_icon_cb_set().
19059 * @see elm_map_marker_add()
19060 * @see elm_map_group_class_style_set()
19061 * @see elm_map_group_class_data_set()
19062 * @see elm_map_group_class_zoom_displayed_set()
19063 * @see elm_map_group_class_zoom_grouped_set()
19064 * @see elm_map_group_class_hide_set()
19065 * @see elm_map_group_class_icon_cb_set()
19069 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19072 * Set the marker's style of a group class.
19074 * @param clas The group class.
19075 * @param style The style to be used by markers.
19077 * Each marker must be associated to a group class, and will use the style
19078 * defined by such class when grouped to other markers.
19080 * The following styles are provided by default theme:
19081 * @li @c radio - blue circle
19082 * @li @c radio2 - green circle
19085 * @see elm_map_group_class_new() for more details.
19086 * @see elm_map_marker_add()
19090 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19093 * Set the icon callback function of a group class.
19095 * @param clas The group class.
19096 * @param icon_get The callback function that will return the icon.
19098 * Each marker must be associated to a group class, and it can display a
19099 * custom icon. The function @p icon_get must return this icon.
19101 * @see elm_map_group_class_new() for more details.
19102 * @see elm_map_marker_add()
19106 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19109 * Set the data associated to the group class.
19111 * @param clas The group class.
19112 * @param data The new user data.
19114 * This data will be passed for callback functions, like icon get callback,
19115 * that can be set with elm_map_group_class_icon_cb_set().
19117 * If a data was previously set, the object will lose the pointer for it,
19118 * so if needs to be freed, you must do it yourself.
19120 * @see elm_map_group_class_new() for more details.
19121 * @see elm_map_group_class_icon_cb_set()
19122 * @see elm_map_marker_add()
19126 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
19129 * Set the minimum zoom from where the markers are displayed.
19131 * @param clas The group class.
19132 * @param zoom The minimum zoom.
19134 * Markers only will be displayed when the map is displayed at @p zoom
19137 * @see elm_map_group_class_new() for more details.
19138 * @see elm_map_marker_add()
19142 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19145 * Set the zoom from where the markers are no more grouped.
19147 * @param clas The group class.
19148 * @param zoom The maximum zoom.
19150 * Markers only will be grouped when the map is displayed at
19151 * less than @p zoom.
19153 * @see elm_map_group_class_new() for more details.
19154 * @see elm_map_marker_add()
19158 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19161 * Set if the markers associated to the group class @clas are hidden or not.
19163 * @param clas The group class.
19164 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
19167 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
19172 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
19175 * Create a new marker class.
19177 * @param obj The map object.
19178 * @return Returns the new group class.
19180 * Each marker must be associated to a class.
19182 * The marker class defines the style of the marker when a marker is
19183 * displayed alone, i.e., not grouped to to others markers. When grouped
19184 * it will use group class style.
19186 * A marker class will need to be provided when creating a marker with
19187 * elm_map_marker_add().
19189 * Some properties and functions can be set by class, as:
19190 * - style, with elm_map_marker_class_style_set()
19191 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
19192 * It can be set using elm_map_marker_class_icon_cb_set().
19193 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
19194 * Set using elm_map_marker_class_get_cb_set().
19195 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
19196 * Set using elm_map_marker_class_del_cb_set().
19198 * @see elm_map_marker_add()
19199 * @see elm_map_marker_class_style_set()
19200 * @see elm_map_marker_class_icon_cb_set()
19201 * @see elm_map_marker_class_get_cb_set()
19202 * @see elm_map_marker_class_del_cb_set()
19206 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19209 * Set the marker's style of a marker class.
19211 * @param clas The marker class.
19212 * @param style The style to be used by markers.
19214 * Each marker must be associated to a marker class, and will use the style
19215 * defined by such class when alone, i.e., @b not grouped to other markers.
19217 * The following styles are provided by default theme:
19222 * @see elm_map_marker_class_new() for more details.
19223 * @see elm_map_marker_add()
19227 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19230 * Set the icon callback function of a marker class.
19232 * @param clas The marker class.
19233 * @param icon_get The callback function that will return the icon.
19235 * Each marker must be associated to a marker class, and it can display a
19236 * custom icon. The function @p icon_get must return this icon.
19238 * @see elm_map_marker_class_new() for more details.
19239 * @see elm_map_marker_add()
19243 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19246 * Set the bubble content callback function of a marker class.
19248 * @param clas The marker class.
19249 * @param get The callback function that will return the content.
19251 * Each marker must be associated to a marker class, and it can display a
19252 * a content on a bubble that opens when the user click over the marker.
19253 * The function @p get must return this content object.
19255 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
19258 * @see elm_map_marker_class_new() for more details.
19259 * @see elm_map_marker_class_del_cb_set()
19260 * @see elm_map_marker_add()
19264 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
19267 * Set the callback function used to delete bubble content of a marker class.
19269 * @param clas The marker class.
19270 * @param del The callback function that will delete the content.
19272 * Each marker must be associated to a marker class, and it can display a
19273 * a content on a bubble that opens when the user click over the marker.
19274 * The function to return such content can be set with
19275 * elm_map_marker_class_get_cb_set().
19277 * If this content must be freed, a callback function need to be
19278 * set for that task with this function.
19280 * If this callback is defined it will have to delete (or not) the
19281 * object inside, but if the callback is not defined the object will be
19282 * destroyed with evas_object_del().
19284 * @see elm_map_marker_class_new() for more details.
19285 * @see elm_map_marker_class_get_cb_set()
19286 * @see elm_map_marker_add()
19290 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
19293 * Get the list of available sources.
19295 * @param obj The map object.
19296 * @return The source names list.
19298 * It will provide a list with all available sources, that can be set as
19299 * current source with elm_map_source_name_set(), or get with
19300 * elm_map_source_name_get().
19302 * Available sources:
19308 * @see elm_map_source_name_set() for more details.
19309 * @see elm_map_source_name_get()
19313 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19316 * Set the source of the map.
19318 * @param obj The map object.
19319 * @param source The source to be used.
19321 * Map widget retrieves images that composes the map from a web service.
19322 * This web service can be set with this method.
19324 * A different service can return a different maps with different
19325 * information and it can use different zoom values.
19327 * The @p source_name need to match one of the names provided by
19328 * elm_map_source_names_get().
19330 * The current source can be get using elm_map_source_name_get().
19332 * @see elm_map_source_names_get()
19333 * @see elm_map_source_name_get()
19338 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
19341 * Get the name of currently used source.
19343 * @param obj The map object.
19344 * @return Returns the name of the source in use.
19346 * @see elm_map_source_name_set() for more details.
19350 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19353 * Set the source of the route service to be used by the map.
19355 * @param obj The map object.
19356 * @param source The route service to be used, being it one of
19357 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
19358 * and #ELM_MAP_ROUTE_SOURCE_ORS.
19360 * Each one has its own algorithm, so the route retrieved may
19361 * differ depending on the source route. Now, only the default is working.
19363 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
19364 * http://www.yournavigation.org/.
19366 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
19367 * assumptions. Its routing core is based on Contraction Hierarchies.
19369 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
19371 * @see elm_map_route_source_get().
19375 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
19378 * Get the current route source.
19380 * @param obj The map object.
19381 * @return The source of the route service used by the map.
19383 * @see elm_map_route_source_set() for details.
19387 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19390 * Set the minimum zoom of the source.
19392 * @param obj The map object.
19393 * @param zoom New minimum zoom value to be used.
19395 * By default, it's 0.
19399 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19402 * Get the minimum zoom of the source.
19404 * @param obj The map object.
19405 * @return Returns the minimum zoom of the source.
19407 * @see elm_map_source_zoom_min_set() for details.
19411 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19414 * Set the maximum zoom of the source.
19416 * @param obj The map object.
19417 * @param zoom New maximum zoom value to be used.
19419 * By default, it's 18.
19423 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19426 * Get the maximum zoom of the source.
19428 * @param obj The map object.
19429 * @return Returns the maximum zoom of the source.
19431 * @see elm_map_source_zoom_min_set() for details.
19435 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19438 * Set the user agent used by the map object to access routing services.
19440 * @param obj The map object.
19441 * @param user_agent The user agent to be used by the map.
19443 * User agent is a client application implementing a network protocol used
19444 * in communications within a client–server distributed computing system
19446 * The @p user_agent identification string will transmitted in a header
19447 * field @c User-Agent.
19449 * @see elm_map_user_agent_get()
19453 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
19456 * Get the user agent used by the map object.
19458 * @param obj The map object.
19459 * @return The user agent identification string used by the map.
19461 * @see elm_map_user_agent_set() for details.
19465 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19468 * Add a new route to the map object.
19470 * @param obj The map object.
19471 * @param type The type of transport to be considered when tracing a route.
19472 * @param method The routing method, what should be priorized.
19473 * @param flon The start longitude.
19474 * @param flat The start latitude.
19475 * @param tlon The destination longitude.
19476 * @param tlat The destination latitude.
19478 * @return The created route or @c NULL upon failure.
19480 * A route will be traced by point on coordinates (@p flat, @p flon)
19481 * to point on coordinates (@p tlat, @p tlon), using the route service
19482 * set with elm_map_route_source_set().
19484 * It will take @p type on consideration to define the route,
19485 * depending if the user will be walking or driving, the route may vary.
19486 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
19487 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
19489 * Another parameter is what the route should priorize, the minor distance
19490 * or the less time to be spend on the route. So @p method should be one
19491 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
19493 * Routes created with this method can be deleted with
19494 * elm_map_route_remove(), colored with elm_map_route_color_set(),
19495 * and distance can be get with elm_map_route_distance_get().
19497 * @see elm_map_route_remove()
19498 * @see elm_map_route_color_set()
19499 * @see elm_map_route_distance_get()
19500 * @see elm_map_route_source_set()
19504 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);
19507 * Remove a route from the map.
19509 * @param route The route to remove.
19511 * @see elm_map_route_add()
19515 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19518 * Set the route color.
19520 * @param route The route object.
19521 * @param r Red channel value, from 0 to 255.
19522 * @param g Green channel value, from 0 to 255.
19523 * @param b Blue channel value, from 0 to 255.
19524 * @param a Alpha channel value, from 0 to 255.
19526 * It uses an additive color model, so each color channel represents
19527 * how much of each primary colors must to be used. 0 represents
19528 * ausence of this color, so if all of the three are set to 0,
19529 * the color will be black.
19531 * These component values should be integers in the range 0 to 255,
19532 * (single 8-bit byte).
19534 * This sets the color used for the route. By default, it is set to
19535 * solid red (r = 255, g = 0, b = 0, a = 255).
19537 * For alpha channel, 0 represents completely transparent, and 255, opaque.
19539 * @see elm_map_route_color_get()
19543 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
19546 * Get the route color.
19548 * @param route The route object.
19549 * @param r Pointer where to store the red channel value.
19550 * @param g Pointer where to store the green channel value.
19551 * @param b Pointer where to store the blue channel value.
19552 * @param a Pointer where to store the alpha channel value.
19554 * @see elm_map_route_color_set() for details.
19558 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
19561 * Get the route distance in kilometers.
19563 * @param route The route object.
19564 * @return The distance of route (unit : km).
19568 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19571 * Get the information of route nodes.
19573 * @param route The route object.
19574 * @return Returns a string with the nodes of route.
19578 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19581 * Get the information of route waypoint.
19583 * @param route the route object.
19584 * @return Returns a string with information about waypoint of route.
19588 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19591 * Get the address of the name.
19593 * @param name The name handle.
19594 * @return Returns the address string of @p name.
19596 * This gets the coordinates of the @p name, created with one of the
19597 * conversion functions.
19599 * @see elm_map_utils_convert_name_into_coord()
19600 * @see elm_map_utils_convert_coord_into_name()
19604 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19607 * Get the current coordinates of the name.
19609 * @param name The name handle.
19610 * @param lat Pointer where to store the latitude.
19611 * @param lon Pointer where to store The longitude.
19613 * This gets the coordinates of the @p name, created with one of the
19614 * conversion functions.
19616 * @see elm_map_utils_convert_name_into_coord()
19617 * @see elm_map_utils_convert_coord_into_name()
19621 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
19624 * Remove a name from the map.
19626 * @param name The name to remove.
19628 * Basically the struct handled by @p name will be freed, so convertions
19629 * between address and coordinates will be lost.
19631 * @see elm_map_utils_convert_name_into_coord()
19632 * @see elm_map_utils_convert_coord_into_name()
19636 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19641 * @param obj The map object.
19642 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
19643 * @param cx Rotation's center horizontal position.
19644 * @param cy Rotation's center vertical position.
19646 * @see elm_map_rotate_get()
19650 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
19653 * Get the rotate degree of the map
19655 * @param obj The map object
19656 * @param degree Pointer where to store degrees from 0.0 to 360.0
19657 * to rotate arount Z axis.
19658 * @param cx Pointer where to store rotation's center horizontal position.
19659 * @param cy Pointer where to store rotation's center vertical position.
19661 * @see elm_map_rotate_set() to set map rotation.
19665 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);
19668 * Enable or disable mouse wheel to be used to zoom in / out the map.
19670 * @param obj The map object.
19671 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
19674 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19676 * It's disabled by default.
19678 * @see elm_map_wheel_disabled_get()
19682 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19685 * Get a value whether mouse wheel is enabled or not.
19687 * @param obj The map object.
19688 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
19689 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19691 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19693 * @see elm_map_wheel_disabled_set() for details.
19697 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19701 * Add a track on the map
19703 * @param obj The map object.
19704 * @param emap The emap route object.
19705 * @return The route object. This is an elm object of type Route.
19707 * @see elm_route_add() for details.
19711 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
19715 * Remove a track from the map
19717 * @param obj The map object.
19718 * @param route The track to remove.
19722 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
19729 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
19731 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
19733 EAPI double elm_route_lon_min_get(Evas_Object *obj);
19734 EAPI double elm_route_lat_min_get(Evas_Object *obj);
19735 EAPI double elm_route_lon_max_get(Evas_Object *obj);
19736 EAPI double elm_route_lat_max_get(Evas_Object *obj);
19740 * @defgroup Panel Panel
19742 * @image html img/widget/panel/preview-00.png
19743 * @image latex img/widget/panel/preview-00.eps
19745 * @brief A panel is a type of animated container that contains subobjects.
19746 * It can be expanded or contracted by clicking the button on it's edge.
19748 * Orientations are as follows:
19749 * @li ELM_PANEL_ORIENT_TOP
19750 * @li ELM_PANEL_ORIENT_LEFT
19751 * @li ELM_PANEL_ORIENT_RIGHT
19753 * @ref tutorial_panel shows one way to use this widget.
19756 typedef enum _Elm_Panel_Orient
19758 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
19759 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
19760 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
19761 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
19762 } Elm_Panel_Orient;
19764 * @brief Adds a panel object
19766 * @param parent The parent object
19768 * @return The panel object, or NULL on failure
19770 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19772 * @brief Sets the orientation of the panel
19774 * @param parent The parent object
19775 * @param orient The panel orientation. Can be one of the following:
19776 * @li ELM_PANEL_ORIENT_TOP
19777 * @li ELM_PANEL_ORIENT_LEFT
19778 * @li ELM_PANEL_ORIENT_RIGHT
19780 * Sets from where the panel will (dis)appear.
19782 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
19784 * @brief Get the orientation of the panel.
19786 * @param obj The panel object
19787 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
19789 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19791 * @brief Set the content of the panel.
19793 * @param obj The panel object
19794 * @param content The panel content
19796 * Once the content object is set, a previously set one will be deleted.
19797 * If you want to keep that old content object, use the
19798 * elm_panel_content_unset() function.
19800 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19802 * @brief Get the content of the panel.
19804 * @param obj The panel object
19805 * @return The content that is being used
19807 * Return the content object which is set for this widget.
19809 * @see elm_panel_content_set()
19811 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19813 * @brief Unset the content of the panel.
19815 * @param obj The panel object
19816 * @return The content that was being used
19818 * Unparent and return the content object which was set for this widget.
19820 * @see elm_panel_content_set()
19822 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19824 * @brief Set the state of the panel.
19826 * @param obj The panel object
19827 * @param hidden If true, the panel will run the animation to contract
19829 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
19831 * @brief Get the state of the panel.
19833 * @param obj The panel object
19834 * @param hidden If true, the panel is in the "hide" state
19836 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19838 * @brief Toggle the hidden state of the panel from code
19840 * @param obj The panel object
19842 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
19848 * @defgroup Panes Panes
19849 * @ingroup Elementary
19851 * @image html img/widget/panes/preview-00.png
19852 * @image latex img/widget/panes/preview-00.eps width=\textwidth
19854 * @image html img/panes.png
19855 * @image latex img/panes.eps width=\textwidth
19857 * The panes adds a dragable bar between two contents. When dragged
19858 * this bar will resize contents size.
19860 * Panes can be displayed vertically or horizontally, and contents
19861 * size proportion can be customized (homogeneous by default).
19863 * Smart callbacks one can listen to:
19864 * - "press" - The panes has been pressed (button wasn't released yet).
19865 * - "unpressed" - The panes was released after being pressed.
19866 * - "clicked" - The panes has been clicked>
19867 * - "clicked,double" - The panes has been double clicked
19869 * Available styles for it:
19872 * Here is an example on its usage:
19873 * @li @ref panes_example
19877 * @addtogroup Panes
19882 * Add a new panes widget to the given parent Elementary
19883 * (container) object.
19885 * @param parent The parent object.
19886 * @return a new panes widget handle or @c NULL, on errors.
19888 * This function inserts a new panes widget on the canvas.
19892 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19895 * Set the left content of the panes widget.
19897 * @param obj The panes object.
19898 * @param content The new left content object.
19900 * Once the content object is set, a previously set one will be deleted.
19901 * If you want to keep that old content object, use the
19902 * elm_panes_content_left_unset() function.
19904 * If panes is displayed vertically, left content will be displayed at
19907 * @see elm_panes_content_left_get()
19908 * @see elm_panes_content_right_set() to set content on the other side.
19912 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19915 * Set the right content of the panes widget.
19917 * @param obj The panes object.
19918 * @param content The new right content object.
19920 * Once the content object is set, a previously set one will be deleted.
19921 * If you want to keep that old content object, use the
19922 * elm_panes_content_right_unset() function.
19924 * If panes is displayed vertically, left content will be displayed at
19927 * @see elm_panes_content_right_get()
19928 * @see elm_panes_content_left_set() to set content on the other side.
19932 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19935 * Get the left content of the panes.
19937 * @param obj The panes object.
19938 * @return The left content object that is being used.
19940 * Return the left content object which is set for this widget.
19942 * @see elm_panes_content_left_set() for details.
19946 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19949 * Get the right content of the panes.
19951 * @param obj The panes object
19952 * @return The right content object that is being used
19954 * Return the right content object which is set for this widget.
19956 * @see elm_panes_content_right_set() for details.
19960 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19963 * Unset the left content used for the panes.
19965 * @param obj The panes object.
19966 * @return The left content object that was being used.
19968 * Unparent and return the left content object which was set for this widget.
19970 * @see elm_panes_content_left_set() for details.
19971 * @see elm_panes_content_left_get().
19975 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19978 * Unset the right content used for the panes.
19980 * @param obj The panes object.
19981 * @return The right content object that was being used.
19983 * Unparent and return the right content object which was set for this
19986 * @see elm_panes_content_right_set() for details.
19987 * @see elm_panes_content_right_get().
19991 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19994 * Get the size proportion of panes widget's left side.
19996 * @param obj The panes object.
19997 * @return float value between 0.0 and 1.0 representing size proportion
20000 * @see elm_panes_content_left_size_set() for more details.
20004 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20007 * Set the size proportion of panes widget's left side.
20009 * @param obj The panes object.
20010 * @param size Value between 0.0 and 1.0 representing size proportion
20013 * By default it's homogeneous, i.e., both sides have the same size.
20015 * If something different is required, it can be set with this function.
20016 * For example, if the left content should be displayed over
20017 * 75% of the panes size, @p size should be passed as @c 0.75.
20018 * This way, right content will be resized to 25% of panes size.
20020 * If displayed vertically, left content is displayed at top, and
20021 * right content at bottom.
20023 * @note This proportion will change when user drags the panes bar.
20025 * @see elm_panes_content_left_size_get()
20029 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
20032 * Set the orientation of a given panes widget.
20034 * @param obj The panes object.
20035 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20036 * @b horizontal, @c EINA_FALSE to make it @b vertical.
20038 * Use this function to change how your panes is to be
20039 * disposed: vertically or horizontally.
20041 * By default it's displayed horizontally.
20043 * @see elm_panes_horizontal_get()
20047 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20050 * Retrieve the orientation of a given panes widget.
20052 * @param obj The panes object.
20053 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20054 * @c EINA_FALSE if it's @b vertical (and on errors).
20056 * @see elm_panes_horizontal_set() for more details.
20060 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20067 * @defgroup Flip Flip
20069 * @image html img/widget/flip/preview-00.png
20070 * @image latex img/widget/flip/preview-00.eps
20072 * This widget holds 2 content objects(Evas_Object): one on the front and one
20073 * on the back. It allows you to flip from front to back and vice-versa using
20074 * various animations.
20076 * If either the front or back contents are not set the flip will treat that
20077 * as transparent. So if you wore to set the front content but not the back,
20078 * and then call elm_flip_go() you would see whatever is below the flip.
20080 * For a list of supported animations see elm_flip_go().
20082 * Signals that you can add callbacks for are:
20083 * "animate,begin" - when a flip animation was started
20084 * "animate,done" - when a flip animation is finished
20086 * @ref tutorial_flip show how to use most of the API.
20090 typedef enum _Elm_Flip_Mode
20092 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
20093 ELM_FLIP_ROTATE_X_CENTER_AXIS,
20094 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
20095 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
20096 ELM_FLIP_CUBE_LEFT,
20097 ELM_FLIP_CUBE_RIGHT,
20099 ELM_FLIP_CUBE_DOWN,
20100 ELM_FLIP_PAGE_LEFT,
20101 ELM_FLIP_PAGE_RIGHT,
20105 typedef enum _Elm_Flip_Interaction
20107 ELM_FLIP_INTERACTION_NONE,
20108 ELM_FLIP_INTERACTION_ROTATE,
20109 ELM_FLIP_INTERACTION_CUBE,
20110 ELM_FLIP_INTERACTION_PAGE
20111 } Elm_Flip_Interaction;
20112 typedef enum _Elm_Flip_Direction
20114 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
20115 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
20116 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
20117 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
20118 } Elm_Flip_Direction;
20120 * @brief Add a new flip to the parent
20122 * @param parent The parent object
20123 * @return The new object or NULL if it cannot be created
20125 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20127 * @brief Set the front content of the flip widget.
20129 * @param obj The flip object
20130 * @param content The new front content object
20132 * Once the content object is set, a previously set one will be deleted.
20133 * If you want to keep that old content object, use the
20134 * elm_flip_content_front_unset() function.
20136 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20138 * @brief Set the back content of the flip widget.
20140 * @param obj The flip object
20141 * @param content The new back content object
20143 * Once the content object is set, a previously set one will be deleted.
20144 * If you want to keep that old content object, use the
20145 * elm_flip_content_back_unset() function.
20147 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20149 * @brief Get the front content used for the flip
20151 * @param obj The flip object
20152 * @return The front content object that is being used
20154 * Return the front content object which is set for this widget.
20156 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20158 * @brief Get the back content used for the flip
20160 * @param obj The flip object
20161 * @return The back content object that is being used
20163 * Return the back content object which is set for this widget.
20165 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20167 * @brief Unset the front content used for the flip
20169 * @param obj The flip object
20170 * @return The front content object that was being used
20172 * Unparent and return the front content object which was set for this widget.
20174 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20176 * @brief Unset the back content used for the flip
20178 * @param obj The flip object
20179 * @return The back content object that was being used
20181 * Unparent and return the back content object which was set for this widget.
20183 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20185 * @brief Get flip front visibility state
20187 * @param obj The flip objct
20188 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
20191 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20193 * @brief Set flip perspective
20195 * @param obj The flip object
20196 * @param foc The coordinate to set the focus on
20197 * @param x The X coordinate
20198 * @param y The Y coordinate
20200 * @warning This function currently does nothing.
20202 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
20204 * @brief Runs the flip animation
20206 * @param obj The flip object
20207 * @param mode The mode type
20209 * Flips the front and back contents using the @p mode animation. This
20210 * efectively hides the currently visible content and shows the hidden one.
20212 * There a number of possible animations to use for the flipping:
20213 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
20214 * around a horizontal axis in the middle of its height, the other content
20215 * is shown as the other side of the flip.
20216 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
20217 * around a vertical axis in the middle of its width, the other content is
20218 * shown as the other side of the flip.
20219 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
20220 * around a diagonal axis in the middle of its width, the other content is
20221 * shown as the other side of the flip.
20222 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
20223 * around a diagonal axis in the middle of its height, the other content is
20224 * shown as the other side of the flip.
20225 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
20226 * as if the flip was a cube, the other content is show as the right face of
20228 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
20229 * right as if the flip was a cube, the other content is show as the left
20230 * face of the cube.
20231 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
20232 * flip was a cube, the other content is show as the bottom face of the cube.
20233 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
20234 * the flip was a cube, the other content is show as the upper face of the
20236 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
20237 * if the flip was a book, the other content is shown as the page below that.
20238 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
20239 * as if the flip was a book, the other content is shown as the page below
20241 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
20242 * flip was a book, the other content is shown as the page below that.
20243 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
20244 * flip was a book, the other content is shown as the page below that.
20246 * @image html elm_flip.png
20247 * @image latex elm_flip.eps width=\textwidth
20249 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
20251 * @brief Set the interactive flip mode
20253 * @param obj The flip object
20254 * @param mode The interactive flip mode to use
20256 * This sets if the flip should be interactive (allow user to click and
20257 * drag a side of the flip to reveal the back page and cause it to flip).
20258 * By default a flip is not interactive. You may also need to set which
20259 * sides of the flip are "active" for flipping and how much space they use
20260 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
20261 * and elm_flip_interacton_direction_hitsize_set()
20263 * The four avilable mode of interaction are:
20264 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
20265 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
20266 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
20267 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
20269 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
20270 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20271 * happen, those can only be acheived with elm_flip_go();
20273 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
20275 * @brief Get the interactive flip mode
20277 * @param obj The flip object
20278 * @return The interactive flip mode
20280 * Returns the interactive flip mode set by elm_flip_interaction_set()
20282 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
20284 * @brief Set which directions of the flip respond to interactive flip
20286 * @param obj The flip object
20287 * @param dir The direction to change
20288 * @param enabled If that direction is enabled or not
20290 * By default all directions are disabled, so you may want to enable the
20291 * desired directions for flipping if you need interactive flipping. You must
20292 * call this function once for each direction that should be enabled.
20294 * @see elm_flip_interaction_set()
20296 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
20298 * @brief Get the enabled state of that flip direction
20300 * @param obj The flip object
20301 * @param dir The direction to check
20302 * @return If that direction is enabled or not
20304 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
20306 * @see elm_flip_interaction_set()
20308 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
20310 * @brief Set the amount of the flip that is sensitive to interactive flip
20312 * @param obj The flip object
20313 * @param dir The direction to modify
20314 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
20316 * Set the amount of the flip that is sensitive to interactive flip, with 0
20317 * representing no area in the flip and 1 representing the entire flip. There
20318 * is however a consideration to be made in that the area will never be
20319 * smaller than the finger size set(as set in your Elementary configuration).
20321 * @see elm_flip_interaction_set()
20323 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
20325 * @brief Get the amount of the flip that is sensitive to interactive flip
20327 * @param obj The flip object
20328 * @param dir The direction to check
20329 * @return The size set for that direction
20331 * Returns the amount os sensitive area set by
20332 * elm_flip_interacton_direction_hitsize_set().
20334 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
20339 /* scrolledentry */
20340 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20341 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
20342 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20343 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
20344 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20345 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20346 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20347 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20348 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20349 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20350 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20351 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
20352 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20353 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20354 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
20355 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
20356 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20357 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20358 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
20359 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
20360 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20361 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20362 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20363 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20364 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
20365 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
20366 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20367 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20368 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20369 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20370 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20371 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
20372 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
20373 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
20374 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20375 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);
20376 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20377 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20378 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);
20379 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20380 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);
20381 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
20382 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20383 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20384 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20385 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
20386 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20387 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20388 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20389 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);
20390 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);
20391 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);
20392 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);
20393 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);
20394 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);
20395 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
20396 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
20397 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
20398 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
20399 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20400 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
20401 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
20404 * @defgroup Conformant Conformant
20405 * @ingroup Elementary
20407 * @image html img/widget/conformant/preview-00.png
20408 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
20410 * @image html img/conformant.png
20411 * @image latex img/conformant.eps width=\textwidth
20413 * The aim is to provide a widget that can be used in elementary apps to
20414 * account for space taken up by the indicator, virtual keypad & softkey
20415 * windows when running the illume2 module of E17.
20417 * So conformant content will be sized and positioned considering the
20418 * space required for such stuff, and when they popup, as a keyboard
20419 * shows when an entry is selected, conformant content won't change.
20421 * Available styles for it:
20424 * See how to use this widget in this example:
20425 * @ref conformant_example
20429 * @addtogroup Conformant
20434 * Add a new conformant widget to the given parent Elementary
20435 * (container) object.
20437 * @param parent The parent object.
20438 * @return A new conformant widget handle or @c NULL, on errors.
20440 * This function inserts a new conformant widget on the canvas.
20442 * @ingroup Conformant
20444 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20447 * Set the content of the conformant widget.
20449 * @param obj The conformant object.
20450 * @param content The content to be displayed by the conformant.
20452 * Content will be sized and positioned considering the space required
20453 * to display a virtual keyboard. So it won't fill all the conformant
20454 * size. This way is possible to be sure that content won't resize
20455 * or be re-positioned after the keyboard is displayed.
20457 * Once the content object is set, a previously set one will be deleted.
20458 * If you want to keep that old content object, use the
20459 * elm_conformat_content_unset() function.
20461 * @see elm_conformant_content_unset()
20462 * @see elm_conformant_content_get()
20464 * @ingroup Conformant
20466 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20469 * Get the content of the conformant widget.
20471 * @param obj The conformant object.
20472 * @return The content that is being used.
20474 * Return the content object which is set for this widget.
20475 * It won't be unparent from conformant. For that, use
20476 * elm_conformant_content_unset().
20478 * @see elm_conformant_content_set() for more details.
20479 * @see elm_conformant_content_unset()
20481 * @ingroup Conformant
20483 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20486 * Unset the content of the conformant widget.
20488 * @param obj The conformant object.
20489 * @return The content that was being used.
20491 * Unparent and return the content object which was set for this widget.
20493 * @see elm_conformant_content_set() for more details.
20495 * @ingroup Conformant
20497 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20500 * Returns the Evas_Object that represents the content area.
20502 * @param obj The conformant object.
20503 * @return The content area of the widget.
20505 * @ingroup Conformant
20507 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20514 * @defgroup Mapbuf Mapbuf
20515 * @ingroup Elementary
20517 * @image html img/widget/mapbuf/preview-00.png
20518 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
20520 * This holds one content object and uses an Evas Map of transformation
20521 * points to be later used with this content. So the content will be
20522 * moved, resized, etc as a single image. So it will improve performance
20523 * when you have a complex interafce, with a lot of elements, and will
20524 * need to resize or move it frequently (the content object and its
20527 * See how to use this widget in this example:
20528 * @ref mapbuf_example
20532 * @addtogroup Mapbuf
20537 * Add a new mapbuf widget to the given parent Elementary
20538 * (container) object.
20540 * @param parent The parent object.
20541 * @return A new mapbuf widget handle or @c NULL, on errors.
20543 * This function inserts a new mapbuf widget on the canvas.
20547 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20550 * Set the content of the mapbuf.
20552 * @param obj The mapbuf object.
20553 * @param content The content that will be filled in this mapbuf object.
20555 * Once the content object is set, a previously set one will be deleted.
20556 * If you want to keep that old content object, use the
20557 * elm_mapbuf_content_unset() function.
20559 * To enable map, elm_mapbuf_enabled_set() should be used.
20563 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20566 * Get the content of the mapbuf.
20568 * @param obj The mapbuf object.
20569 * @return The content that is being used.
20571 * Return the content object which is set for this widget.
20573 * @see elm_mapbuf_content_set() for details.
20577 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20580 * Unset the content of the mapbuf.
20582 * @param obj The mapbuf object.
20583 * @return The content that was being used.
20585 * Unparent and return the content object which was set for this widget.
20587 * @see elm_mapbuf_content_set() for details.
20591 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20594 * Enable or disable the map.
20596 * @param obj The mapbuf object.
20597 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
20599 * This enables the map that is set or disables it. On enable, the object
20600 * geometry will be saved, and the new geometry will change (position and
20601 * size) to reflect the map geometry set.
20603 * Also, when enabled, alpha and smooth states will be used, so if the
20604 * content isn't solid, alpha should be enabled, for example, otherwise
20605 * a black retangle will fill the content.
20607 * When disabled, the stored map will be freed and geometry prior to
20608 * enabling the map will be restored.
20610 * It's disabled by default.
20612 * @see elm_mapbuf_alpha_set()
20613 * @see elm_mapbuf_smooth_set()
20617 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20620 * Get a value whether map is enabled or not.
20622 * @param obj The mapbuf object.
20623 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
20624 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20626 * @see elm_mapbuf_enabled_set() for details.
20630 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20633 * Enable or disable smooth map rendering.
20635 * @param obj The mapbuf object.
20636 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
20639 * This sets smoothing for map rendering. If the object is a type that has
20640 * its own smoothing settings, then both the smooth settings for this object
20641 * and the map must be turned off.
20643 * By default smooth maps are enabled.
20647 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
20650 * Get a value whether smooth map rendering is enabled or not.
20652 * @param obj The mapbuf object.
20653 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
20654 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20656 * @see elm_mapbuf_smooth_set() for details.
20660 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20663 * Set or unset alpha flag for map rendering.
20665 * @param obj The mapbuf object.
20666 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
20669 * This sets alpha flag for map rendering. If the object is a type that has
20670 * its own alpha settings, then this will take precedence. Only image objects
20671 * have this currently. It stops alpha blending of the map area, and is
20672 * useful if you know the object and/or all sub-objects is 100% solid.
20674 * Alpha is enabled by default.
20678 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
20681 * Get a value whether alpha blending is enabled or not.
20683 * @param obj The mapbuf object.
20684 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
20685 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20687 * @see elm_mapbuf_alpha_set() for details.
20691 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20698 * @defgroup Flipselector Flip Selector
20700 * @image html img/widget/flipselector/preview-00.png
20701 * @image latex img/widget/flipselector/preview-00.eps
20703 * A flip selector is a widget to show a set of @b text items, one
20704 * at a time, with the same sheet switching style as the @ref Clock
20705 * "clock" widget, when one changes the current displaying sheet
20706 * (thus, the "flip" in the name).
20708 * User clicks to flip sheets which are @b held for some time will
20709 * make the flip selector to flip continuosly and automatically for
20710 * the user. The interval between flips will keep growing in time,
20711 * so that it helps the user to reach an item which is distant from
20712 * the current selection.
20714 * Smart callbacks one can register to:
20715 * - @c "selected" - when the widget's selected text item is changed
20716 * - @c "overflowed" - when the widget's current selection is changed
20717 * from the first item in its list to the last
20718 * - @c "underflowed" - when the widget's current selection is changed
20719 * from the last item in its list to the first
20721 * Available styles for it:
20724 * Here is an example on its usage:
20725 * @li @ref flipselector_example
20729 * @addtogroup Flipselector
20733 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
20736 * Add a new flip selector widget to the given parent Elementary
20737 * (container) widget
20739 * @param parent The parent object
20740 * @return a new flip selector widget handle or @c NULL, on errors
20742 * This function inserts a new flip selector widget on the canvas.
20744 * @ingroup Flipselector
20746 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20749 * Programmatically select the next item of a flip selector widget
20751 * @param obj The flipselector object
20753 * @note The selection will be animated. Also, if it reaches the
20754 * end of its list of member items, it will continue with the first
20757 * @ingroup Flipselector
20759 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20762 * Programmatically select the previous item of a flip selector
20765 * @param obj The flipselector object
20767 * @note The selection will be animated. Also, if it reaches the
20768 * beginning of its list of member items, it will continue with the
20769 * last one backwards.
20771 * @ingroup Flipselector
20773 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20776 * Append a (text) item to a flip selector widget
20778 * @param obj The flipselector object
20779 * @param label The (text) label of the new item
20780 * @param func Convenience callback function to take place when
20782 * @param data Data passed to @p func, above
20783 * @return A handle to the item added or @c NULL, on errors
20785 * The widget's list of labels to show will be appended with the
20786 * given value. If the user wishes so, a callback function pointer
20787 * can be passed, which will get called when this same item is
20790 * @note The current selection @b won't be modified by appending an
20791 * element to the list.
20793 * @note The maximum length of the text label is going to be
20794 * determined <b>by the widget's theme</b>. Strings larger than
20795 * that value are going to be @b truncated.
20797 * @ingroup Flipselector
20799 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20802 * Prepend a (text) item to a flip selector widget
20804 * @param obj The flipselector object
20805 * @param label The (text) label of the new item
20806 * @param func Convenience callback function to take place when
20808 * @param data Data passed to @p func, above
20809 * @return A handle to the item added or @c NULL, on errors
20811 * The widget's list of labels to show will be prepended with the
20812 * given value. If the user wishes so, a callback function pointer
20813 * can be passed, which will get called when this same item is
20816 * @note The current selection @b won't be modified by prepending
20817 * an element to the list.
20819 * @note The maximum length of the text label is going to be
20820 * determined <b>by the widget's theme</b>. Strings larger than
20821 * that value are going to be @b truncated.
20823 * @ingroup Flipselector
20825 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20828 * Get the internal list of items in a given flip selector widget.
20830 * @param obj The flipselector object
20831 * @return The list of items (#Elm_Flipselector_Item as data) or
20832 * @c NULL on errors.
20834 * This list is @b not to be modified in any way and must not be
20835 * freed. Use the list members with functions like
20836 * elm_flipselector_item_label_set(),
20837 * elm_flipselector_item_label_get(),
20838 * elm_flipselector_item_del(),
20839 * elm_flipselector_item_selected_get(),
20840 * elm_flipselector_item_selected_set().
20842 * @warning This list is only valid until @p obj object's internal
20843 * items list is changed. It should be fetched again with another
20844 * call to this function when changes happen.
20846 * @ingroup Flipselector
20848 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20851 * Get the first item in the given flip selector widget's list of
20854 * @param obj The flipselector object
20855 * @return The first item or @c NULL, if it has no items (and on
20858 * @see elm_flipselector_item_append()
20859 * @see elm_flipselector_last_item_get()
20861 * @ingroup Flipselector
20863 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20866 * Get the last item in the given flip selector widget's list of
20869 * @param obj The flipselector object
20870 * @return The last item or @c NULL, if it has no items (and on
20873 * @see elm_flipselector_item_prepend()
20874 * @see elm_flipselector_first_item_get()
20876 * @ingroup Flipselector
20878 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20881 * Get the currently selected item in a flip selector widget.
20883 * @param obj The flipselector object
20884 * @return The selected item or @c NULL, if the widget has no items
20887 * @ingroup Flipselector
20889 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20892 * Set whether a given flip selector widget's item should be the
20893 * currently selected one.
20895 * @param item The flip selector item
20896 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
20898 * This sets whether @p item is or not the selected (thus, under
20899 * display) one. If @p item is different than one under display,
20900 * the latter will be unselected. If the @p item is set to be
20901 * unselected, on the other hand, the @b first item in the widget's
20902 * internal members list will be the new selected one.
20904 * @see elm_flipselector_item_selected_get()
20906 * @ingroup Flipselector
20908 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20911 * Get whether a given flip selector widget's item is the currently
20914 * @param item The flip selector item
20915 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
20918 * @see elm_flipselector_item_selected_set()
20920 * @ingroup Flipselector
20922 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20925 * Delete a given item from a flip selector widget.
20927 * @param item The item to delete
20929 * @ingroup Flipselector
20931 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20934 * Get the label of a given flip selector widget's item.
20936 * @param item The item to get label from
20937 * @return The text label of @p item or @c NULL, on errors
20939 * @see elm_flipselector_item_label_set()
20941 * @ingroup Flipselector
20943 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20946 * Set the label of a given flip selector widget's item.
20948 * @param item The item to set label on
20949 * @param label The text label string, in UTF-8 encoding
20951 * @see elm_flipselector_item_label_get()
20953 * @ingroup Flipselector
20955 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
20958 * Gets the item before @p item in a flip selector widget's
20959 * internal list of items.
20961 * @param item The item to fetch previous from
20962 * @return The item before the @p item, in its parent's list. If
20963 * there is no previous item for @p item or there's an
20964 * error, @c NULL is returned.
20966 * @see elm_flipselector_item_next_get()
20968 * @ingroup Flipselector
20970 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20973 * Gets the item after @p item in a flip selector widget's
20974 * internal list of items.
20976 * @param item The item to fetch next from
20977 * @return The item after the @p item, in its parent's list. If
20978 * there is no next item for @p item or there's an
20979 * error, @c NULL is returned.
20981 * @see elm_flipselector_item_next_get()
20983 * @ingroup Flipselector
20985 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20988 * Set the interval on time updates for an user mouse button hold
20989 * on a flip selector widget.
20991 * @param obj The flip selector object
20992 * @param interval The (first) interval value in seconds
20994 * This interval value is @b decreased while the user holds the
20995 * mouse pointer either flipping up or flipping doww a given flip
20998 * This helps the user to get to a given item distant from the
20999 * current one easier/faster, as it will start to flip quicker and
21000 * quicker on mouse button holds.
21002 * The calculation for the next flip interval value, starting from
21003 * the one set with this call, is the previous interval divided by
21004 * 1.05, so it decreases a little bit.
21006 * The default starting interval value for automatic flips is
21009 * @see elm_flipselector_interval_get()
21011 * @ingroup Flipselector
21013 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21016 * Get the interval on time updates for an user mouse button hold
21017 * on a flip selector widget.
21019 * @param obj The flip selector object
21020 * @return The (first) interval value, in seconds, set on it
21022 * @see elm_flipselector_interval_set() for more details
21024 * @ingroup Flipselector
21026 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21033 * @addtogroup Animator Animator
21034 * @ingroup Elementary
21036 * @brief Functions to ease creation of animations.
21038 * elm_animator is designed to provide an easy way to create animations.
21039 * Creating an animation with elm_animator is as simple as setting a
21040 * duration, an operating callback and telling it to run the animation.
21041 * However that is not the full extent of elm_animator's ability, animations
21042 * can be paused and resumed, reversed and the animation need not be linear.
21044 * To run an animation you must specify at least a duration and operation
21045 * callback, not setting any other properties will create a linear animation
21046 * that runs once and is not reversed.
21048 * @ref elm_animator_example_page_01 "This" example should make all of that
21051 * @warning elm_animator is @b not a widget.
21055 * @brief Type of curve desired for animation.
21057 * The speed in which an animation happens doesn't have to be linear, some
21058 * animations will look better if they're accelerating or decelerating, so
21059 * elm_animator provides four options in this regard:
21061 * @image html elm_animator_curve_style.png
21062 * @image latex elm_animator_curve_style.eps width=\textwidth
21063 * As can be seen in the image the speed of the animation will be:
21064 * @li ELM_ANIMATOR_CURVE_LINEAR constant
21065 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
21066 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
21067 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
21071 ELM_ANIMATOR_CURVE_LINEAR,
21072 ELM_ANIMATOR_CURVE_IN_OUT,
21073 ELM_ANIMATOR_CURVE_IN,
21074 ELM_ANIMATOR_CURVE_OUT
21075 } Elm_Animator_Curve_Style;
21076 typedef struct _Elm_Animator Elm_Animator;
21078 * Called back per loop of an elementary animators cycle
21079 * @param data user-data given to elm_animator_operation_callback_set()
21080 * @param animator the animator being run
21081 * @param double the position in the animation
21083 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
21085 * Called back when an elementary animator finishes
21086 * @param data user-data given to elm_animator_completion_callback_set()
21088 typedef void (*Elm_Animator_Completion_Cb) (void *data);
21091 * @brief Create a new animator.
21093 * @param[in] parent Parent object
21095 * The @a parent argument can be set to NULL for no parent. If a parent is set
21096 * there is no need to call elm_animator_del(), when the parent is deleted it
21097 * will delete the animator.
21098 * @deprecated Use @ref Transit instead.
21100 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
21102 * Deletes the animator freeing any resources it used. If the animator was
21103 * created with a NULL parent this must be called, otherwise it will be
21104 * automatically called when the parent is deleted.
21106 * @param[in] animator Animator object
21107 * @deprecated Use @ref Transit instead.
21109 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21111 * Set the duration of the animation.
21113 * @param[in] animator Animator object
21114 * @param[in] duration Duration in second
21115 * @deprecated Use @ref Transit instead.
21117 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
21119 * @brief Set the callback function for animator operation.
21121 * @param[in] animator Animator object
21122 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
21123 * @param[in] data Callback function user argument
21125 * The @p func callback will be called with a frame value in range [0, 1] which
21126 * indicates how far along the animation should be. It is the job of @p func to
21127 * actually change the state of any object(or objects) that are being animated.
21128 * @deprecated Use @ref Transit instead.
21130 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
21132 * Set the callback function for the when the animation ends.
21134 * @param[in] animator Animator object
21135 * @param[in] func Callback function pointe
21136 * @param[in] data Callback function user argument
21138 * @warning @a func will not be executed if elm_animator_stop() is called.
21139 * @deprecated Use @ref Transit instead.
21141 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
21143 * @brief Stop animator.
21145 * @param[in] animator Animator object
21147 * If called before elm_animator_animate() it does nothing. If there is an
21148 * animation in progress the animation will be stopped(the operation callback
21149 * will not be executed again) and it can't be restarted using
21150 * elm_animator_resume().
21151 * @deprecated Use @ref Transit instead.
21153 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21155 * Set the animator repeat count.
21157 * @param[in] animator Animator object
21158 * @param[in] repeat_cnt Repeat count
21159 * @deprecated Use @ref Transit instead.
21161 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
21163 * @brief Start animation.
21165 * @param[in] animator Animator object
21167 * This function starts the animation if the nescessary properties(duration
21168 * and operation callback) have been set. Once started the animation will
21169 * run until complete or elm_animator_stop() is called.
21170 * @deprecated Use @ref Transit instead.
21172 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21174 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21176 * @param[in] animator Animator object
21177 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21178 * @deprecated Use @ref Transit instead.
21180 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
21182 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21184 * @param[in] animator Animator object
21185 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21186 * @deprecated Use @ref Transit instead.
21188 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21190 * @brief Sets wether the animation should be automatically reversed.
21192 * @param[in] animator Animator object
21193 * @param[in] reverse Reverse or not
21195 * This controls wether the animation will be run on reverse imediately after
21196 * running forward. When this is set together with repetition the animation
21197 * will run in reverse once for each time it ran forward.@n
21198 * Runnin an animation in reverse is accomplished by calling the operation
21199 * callback with a frame value starting at 1 and diminshing until 0.
21200 * @deprecated Use @ref Transit instead.
21202 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
21204 * Gets wether the animation will automatically reversed
21206 * @param[in] animator Animator object
21207 * @deprecated Use @ref Transit instead.
21209 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21211 * Gets the status for the animator operation. The status of the animator @b
21212 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
21213 * only informs if the animation was started and has not ended(either normally
21214 * or through elm_animator_stop()).
21216 * @param[in] animator Animator object
21217 * @deprecated Use @ref Transit instead.
21219 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21221 * Gets how many times the animation will be repeated
21223 * @param[in] animator Animator object
21224 * @deprecated Use @ref Transit instead.
21226 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21228 * Pause the animator.
21230 * @param[in] animator Animator object
21232 * This causes the animation to be temporarily stopped(the operation callback
21233 * will not be called). If the animation is not yet running this is a no-op.
21234 * Once an animation has been paused with this function it can be resumed
21235 * using elm_animator_resume().
21236 * @deprecated Use @ref Transit instead.
21238 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21240 * @brief Resumes the animator.
21242 * @param[in] animator Animator object
21244 * Resumes an animation that was paused using elm_animator_pause(), after
21245 * calling this function calls to the operation callback will happen
21246 * normally. If an animation is stopped by means of elm_animator_stop it
21247 * @b can't be restarted with this function.@n
21249 * @warning When an animation is resumed it doesn't start from where it was paused, it
21250 * will go to where it would have been if it had not been paused. If an
21251 * animation with a duration of 3 seconds is paused after 1 second for 1 second
21252 * it will resume as if it had ben animating for 2 seconds, the operating
21253 * callback will be called with a frame value of aproximately 2/3.
21254 * @deprecated Use @ref Transit instead.
21256 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21262 * @defgroup Calendar Calendar
21263 * @ingroup Elementary
21265 * @image html img/widget/calendar/preview-00.png
21266 * @image latex img/widget/calendar/preview-00.eps
21268 * A calendar is a widget that displays a regular calendar, one
21269 * month at a time, to the user, and can allows the user to select a date.
21271 * It has support to adding check marks (holidays and checks are supported
21272 * by default theme).
21274 * Weekday names and the function used to format month and year to
21275 * be displayed can be set, giving more flexibility to this widget.
21277 * Smart callbacks one can register to:
21278 * - "changed" - emitted when the user selects a day or changes the
21279 * displayed month, what actually changes the selected day as well.
21281 * Available styles for it:
21284 * List of examples:
21285 * @li @ref calendar_example_01
21286 * @li @ref calendar_example_02
21287 * @li @ref calendar_example_03
21288 * @li @ref calendar_example_04
21289 * @li @ref calendar_example_05
21290 * @li @ref calendar_example_06
21294 * @addtogroup Calendar
21299 * @enum _Elm_Calendar_Mark_Repeat
21300 * @typedef Elm_Calendar_Mark_Repeat
21302 * Event periodicity, used to define if a mark should be repeated
21303 * @b beyond event's day. It's set when a mark is added.
21305 * So, for a mark added to 13th May with periodicity set to WEEKLY,
21306 * there will be marks every week after this date. Marks will be displayed
21307 * at 13th, 20th, 27th, 3rd June ...
21309 * Values don't work as bitmask, only one can be choosen.
21311 * @see elm_calendar_mark_add()
21313 * @ingroup Calendar
21315 typedef enum _Elm_Calendar_Mark_Repeat
21317 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
21318 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
21319 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
21320 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*/
21321 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. */
21322 } Elm_Calendar_Mark_Repeat;
21324 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(). */
21327 * Add a new calendar widget to the given parent Elementary
21328 * (container) object.
21330 * @param parent The parent object.
21331 * @return a new calendar widget handle or @c NULL, on errors.
21333 * This function inserts a new calendar widget on the canvas.
21335 * @ref calendar_example_01
21337 * @ingroup Calendar
21339 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21342 * Get weekdays names displayed by the calendar.
21344 * @param obj The calendar object.
21345 * @return Array of seven strings to be used as weekday names.
21347 * By default, weekdays abbreviations get from system are displayed:
21348 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21349 * The first string is related to Sunday, the second to Monday...
21351 * @see elm_calendar_weekdays_name_set()
21353 * @ref calendar_example_05
21355 * @ingroup Calendar
21357 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21360 * Set weekdays names to be displayed by the calendar.
21362 * @param obj The calendar object.
21363 * @param weekdays Array of seven strings to be used as weekday names.
21364 * @warning It must have 7 elements, or it will access invalid memory.
21365 * @warning The strings must be NULL terminated ('@\0').
21367 * By default, weekdays abbreviations get from system are displayed:
21368 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21370 * The first string should be related to Sunday, the second to Monday...
21372 * The usage should be like this:
21374 * const char *weekdays[] =
21376 * "Sunday", "Monday", "Tuesday", "Wednesday",
21377 * "Thursday", "Friday", "Saturday"
21379 * elm_calendar_weekdays_names_set(calendar, weekdays);
21382 * @see elm_calendar_weekdays_name_get()
21384 * @ref calendar_example_02
21386 * @ingroup Calendar
21388 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
21391 * Set the minimum and maximum values for the year
21393 * @param obj The calendar object
21394 * @param min The minimum year, greater than 1901;
21395 * @param max The maximum year;
21397 * Maximum must be greater than minimum, except if you don't wan't to set
21399 * Default values are 1902 and -1.
21401 * If the maximum year is a negative value, it will be limited depending
21402 * on the platform architecture (year 2037 for 32 bits);
21404 * @see elm_calendar_min_max_year_get()
21406 * @ref calendar_example_03
21408 * @ingroup Calendar
21410 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
21413 * Get the minimum and maximum values for the year
21415 * @param obj The calendar object.
21416 * @param min The minimum year.
21417 * @param max The maximum year.
21419 * Default values are 1902 and -1.
21421 * @see elm_calendar_min_max_year_get() for more details.
21423 * @ref calendar_example_05
21425 * @ingroup Calendar
21427 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
21430 * Enable or disable day selection
21432 * @param obj The calendar object.
21433 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
21436 * Enabled by default. If disabled, the user still can select months,
21437 * but not days. Selected days are highlighted on calendar.
21438 * It should be used if you won't need such selection for the widget usage.
21440 * When a day is selected, or month is changed, smart callbacks for
21441 * signal "changed" will be called.
21443 * @see elm_calendar_day_selection_enable_get()
21445 * @ref calendar_example_04
21447 * @ingroup Calendar
21449 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21452 * Get a value whether day selection is enabled or not.
21454 * @see elm_calendar_day_selection_enable_set() for details.
21456 * @param obj The calendar object.
21457 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
21458 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
21460 * @ref calendar_example_05
21462 * @ingroup Calendar
21464 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21468 * Set selected date to be highlighted on calendar.
21470 * @param obj The calendar object.
21471 * @param selected_time A @b tm struct to represent the selected date.
21473 * Set the selected date, changing the displayed month if needed.
21474 * Selected date changes when the user goes to next/previous month or
21475 * select a day pressing over it on calendar.
21477 * @see elm_calendar_selected_time_get()
21479 * @ref calendar_example_04
21481 * @ingroup Calendar
21483 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
21486 * Get selected date.
21488 * @param obj The calendar object
21489 * @param selected_time A @b tm struct to point to selected date
21490 * @return EINA_FALSE means an error ocurred and returned time shouldn't
21493 * Get date selected by the user or set by function
21494 * elm_calendar_selected_time_set().
21495 * Selected date changes when the user goes to next/previous month or
21496 * select a day pressing over it on calendar.
21498 * @see elm_calendar_selected_time_get()
21500 * @ref calendar_example_05
21502 * @ingroup Calendar
21504 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
21507 * Set a function to format the string that will be used to display
21510 * @param obj The calendar object
21511 * @param format_function Function to set the month-year string given
21512 * the selected date
21514 * By default it uses strftime with "%B %Y" format string.
21515 * It should allocate the memory that will be used by the string,
21516 * that will be freed by the widget after usage.
21517 * A pointer to the string and a pointer to the time struct will be provided.
21522 * _format_month_year(struct tm *selected_time)
21525 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
21526 * return strdup(buf);
21529 * elm_calendar_format_function_set(calendar, _format_month_year);
21532 * @ref calendar_example_02
21534 * @ingroup Calendar
21536 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
21539 * Add a new mark to the calendar
21541 * @param obj The calendar object
21542 * @param mark_type A string used to define the type of mark. It will be
21543 * emitted to the theme, that should display a related modification on these
21544 * days representation.
21545 * @param mark_time A time struct to represent the date of inclusion of the
21546 * mark. For marks that repeats it will just be displayed after the inclusion
21547 * date in the calendar.
21548 * @param repeat Repeat the event following this periodicity. Can be a unique
21549 * mark (that don't repeat), daily, weekly, monthly or annually.
21550 * @return The created mark or @p NULL upon failure.
21552 * Add a mark that will be drawn in the calendar respecting the insertion
21553 * time and periodicity. It will emit the type as signal to the widget theme.
21554 * Default theme supports "holiday" and "checked", but it can be extended.
21556 * It won't immediately update the calendar, drawing the marks.
21557 * For this, call elm_calendar_marks_draw(). However, when user selects
21558 * next or previous month calendar forces marks drawn.
21560 * Marks created with this method can be deleted with
21561 * elm_calendar_mark_del().
21565 * struct tm selected_time;
21566 * time_t current_time;
21568 * current_time = time(NULL) + 5 * 84600;
21569 * localtime_r(¤t_time, &selected_time);
21570 * elm_calendar_mark_add(cal, "holiday", selected_time,
21571 * ELM_CALENDAR_ANNUALLY);
21573 * current_time = time(NULL) + 1 * 84600;
21574 * localtime_r(¤t_time, &selected_time);
21575 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
21577 * elm_calendar_marks_draw(cal);
21580 * @see elm_calendar_marks_draw()
21581 * @see elm_calendar_mark_del()
21583 * @ref calendar_example_06
21585 * @ingroup Calendar
21587 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);
21590 * Delete mark from the calendar.
21592 * @param mark The mark to be deleted.
21594 * If deleting all calendar marks is required, elm_calendar_marks_clear()
21595 * should be used instead of getting marks list and deleting each one.
21597 * @see elm_calendar_mark_add()
21599 * @ref calendar_example_06
21601 * @ingroup Calendar
21603 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
21606 * Remove all calendar's marks
21608 * @param obj The calendar object.
21610 * @see elm_calendar_mark_add()
21611 * @see elm_calendar_mark_del()
21613 * @ingroup Calendar
21615 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21619 * Get a list of all the calendar marks.
21621 * @param obj The calendar object.
21622 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
21624 * @see elm_calendar_mark_add()
21625 * @see elm_calendar_mark_del()
21626 * @see elm_calendar_marks_clear()
21628 * @ingroup Calendar
21630 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21633 * Draw calendar marks.
21635 * @param obj The calendar object.
21637 * Should be used after adding, removing or clearing marks.
21638 * It will go through the entire marks list updating the calendar.
21639 * If lots of marks will be added, add all the marks and then call
21642 * When the month is changed, i.e. user selects next or previous month,
21643 * marks will be drawed.
21645 * @see elm_calendar_mark_add()
21646 * @see elm_calendar_mark_del()
21647 * @see elm_calendar_marks_clear()
21649 * @ref calendar_example_06
21651 * @ingroup Calendar
21653 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
21656 * Set a day text color to the same that represents Saturdays.
21658 * @param obj The calendar object.
21659 * @param pos The text position. Position is the cell counter, from left
21660 * to right, up to down. It starts on 0 and ends on 41.
21662 * @deprecated use elm_calendar_mark_add() instead like:
21665 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
21666 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21669 * @see elm_calendar_mark_add()
21671 * @ingroup Calendar
21673 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21676 * Set a day text color to the same that represents Sundays.
21678 * @param obj The calendar object.
21679 * @param pos The text position. Position is the cell counter, from left
21680 * to right, up to down. It starts on 0 and ends on 41.
21682 * @deprecated use elm_calendar_mark_add() instead like:
21685 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
21686 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21689 * @see elm_calendar_mark_add()
21691 * @ingroup Calendar
21693 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21696 * Set a day text color to the same that represents Weekdays.
21698 * @param obj The calendar object
21699 * @param pos The text position. Position is the cell counter, from left
21700 * to right, up to down. It starts on 0 and ends on 41.
21702 * @deprecated use elm_calendar_mark_add() instead like:
21705 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
21707 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
21708 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21709 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
21710 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21711 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
21712 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21713 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
21714 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21715 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
21718 * @see elm_calendar_mark_add()
21720 * @ingroup Calendar
21722 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21725 * Set the interval on time updates for an user mouse button hold
21726 * on calendar widgets' month selection.
21728 * @param obj The calendar object
21729 * @param interval The (first) interval value in seconds
21731 * This interval value is @b decreased while the user holds the
21732 * mouse pointer either selecting next or previous month.
21734 * This helps the user to get to a given month distant from the
21735 * current one easier/faster, as it will start to change quicker and
21736 * quicker on mouse button holds.
21738 * The calculation for the next change interval value, starting from
21739 * the one set with this call, is the previous interval divided by
21740 * 1.05, so it decreases a little bit.
21742 * The default starting interval value for automatic changes is
21745 * @see elm_calendar_interval_get()
21747 * @ingroup Calendar
21749 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21752 * Get the interval on time updates for an user mouse button hold
21753 * on calendar widgets' month selection.
21755 * @param obj The calendar object
21756 * @return The (first) interval value, in seconds, set on it
21758 * @see elm_calendar_interval_set() for more details
21760 * @ingroup Calendar
21762 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21769 * @defgroup Diskselector Diskselector
21770 * @ingroup Elementary
21772 * @image html img/widget/diskselector/preview-00.png
21773 * @image latex img/widget/diskselector/preview-00.eps
21775 * A diskselector is a kind of list widget. It scrolls horizontally,
21776 * and can contain label and icon objects. Three items are displayed
21777 * with the selected one in the middle.
21779 * It can act like a circular list with round mode and labels can be
21780 * reduced for a defined length for side items.
21782 * Smart callbacks one can listen to:
21783 * - "selected" - when item is selected, i.e. scroller stops.
21785 * Available styles for it:
21788 * List of examples:
21789 * @li @ref diskselector_example_01
21790 * @li @ref diskselector_example_02
21794 * @addtogroup Diskselector
21798 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(). */
21801 * Add a new diskselector widget to the given parent Elementary
21802 * (container) object.
21804 * @param parent The parent object.
21805 * @return a new diskselector widget handle or @c NULL, on errors.
21807 * This function inserts a new diskselector widget on the canvas.
21809 * @ingroup Diskselector
21811 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21814 * Enable or disable round mode.
21816 * @param obj The diskselector object.
21817 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
21820 * Disabled by default. If round mode is enabled the items list will
21821 * work like a circle list, so when the user reaches the last item,
21822 * the first one will popup.
21824 * @see elm_diskselector_round_get()
21826 * @ingroup Diskselector
21828 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
21831 * Get a value whether round mode is enabled or not.
21833 * @see elm_diskselector_round_set() for details.
21835 * @param obj The diskselector object.
21836 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
21837 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21839 * @ingroup Diskselector
21841 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21844 * Get the side labels max length.
21846 * @deprecated use elm_diskselector_side_label_length_get() instead:
21848 * @param obj The diskselector object.
21849 * @return The max length defined for side labels, or 0 if not a valid
21852 * @ingroup Diskselector
21854 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21857 * Set the side labels max length.
21859 * @deprecated use elm_diskselector_side_label_length_set() instead:
21861 * @param obj The diskselector object.
21862 * @param len The max length defined for side labels.
21864 * @ingroup Diskselector
21866 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21869 * Get the side labels max length.
21871 * @see elm_diskselector_side_label_length_set() for details.
21873 * @param obj The diskselector object.
21874 * @return The max length defined for side labels, or 0 if not a valid
21877 * @ingroup Diskselector
21879 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21882 * Set the side labels max length.
21884 * @param obj The diskselector object.
21885 * @param len The max length defined for side labels.
21887 * Length is the number of characters of items' label that will be
21888 * visible when it's set on side positions. It will just crop
21889 * the string after defined size. E.g.:
21891 * An item with label "January" would be displayed on side position as
21892 * "Jan" if max length is set to 3, or "Janu", if this property
21895 * When it's selected, the entire label will be displayed, except for
21896 * width restrictions. In this case label will be cropped and "..."
21897 * will be concatenated.
21899 * Default side label max length is 3.
21901 * This property will be applyed over all items, included before or
21902 * later this function call.
21904 * @ingroup Diskselector
21906 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21909 * Set the number of items to be displayed.
21911 * @param obj The diskselector object.
21912 * @param num The number of items the diskselector will display.
21914 * Default value is 3, and also it's the minimun. If @p num is less
21915 * than 3, it will be set to 3.
21917 * Also, it can be set on theme, using data item @c display_item_num
21918 * on group "elm/diskselector/item/X", where X is style set.
21921 * group { name: "elm/diskselector/item/X";
21923 * item: "display_item_num" "5";
21926 * @ingroup Diskselector
21928 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
21931 * Set bouncing behaviour when the scrolled content reaches an edge.
21933 * Tell the internal scroller object whether it should bounce or not
21934 * when it reaches the respective edges for each axis.
21936 * @param obj The diskselector object.
21937 * @param h_bounce Whether to bounce or not in the horizontal axis.
21938 * @param v_bounce Whether to bounce or not in the vertical axis.
21940 * @see elm_scroller_bounce_set()
21942 * @ingroup Diskselector
21944 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21947 * Get the bouncing behaviour of the internal scroller.
21949 * Get whether the internal scroller should bounce when the edge of each
21950 * axis is reached scrolling.
21952 * @param obj The diskselector object.
21953 * @param h_bounce Pointer where to store the bounce state of the horizontal
21955 * @param v_bounce Pointer where to store the bounce state of the vertical
21958 * @see elm_scroller_bounce_get()
21959 * @see elm_diskselector_bounce_set()
21961 * @ingroup Diskselector
21963 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21966 * Get the scrollbar policy.
21968 * @see elm_diskselector_scroller_policy_get() for details.
21970 * @param obj The diskselector object.
21971 * @param policy_h Pointer where to store horizontal scrollbar policy.
21972 * @param policy_v Pointer where to store vertical scrollbar policy.
21974 * @ingroup Diskselector
21976 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);
21979 * Set the scrollbar policy.
21981 * @param obj The diskselector object.
21982 * @param policy_h Horizontal scrollbar policy.
21983 * @param policy_v Vertical scrollbar policy.
21985 * This sets the scrollbar visibility policy for the given scroller.
21986 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
21987 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
21988 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
21989 * This applies respectively for the horizontal and vertical scrollbars.
21991 * The both are disabled by default, i.e., are set to
21992 * #ELM_SCROLLER_POLICY_OFF.
21994 * @ingroup Diskselector
21996 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
21999 * Remove all diskselector's items.
22001 * @param obj The diskselector object.
22003 * @see elm_diskselector_item_del()
22004 * @see elm_diskselector_item_append()
22006 * @ingroup Diskselector
22008 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22011 * Get a list of all the diskselector items.
22013 * @param obj The diskselector object.
22014 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
22015 * or @c NULL on failure.
22017 * @see elm_diskselector_item_append()
22018 * @see elm_diskselector_item_del()
22019 * @see elm_diskselector_clear()
22021 * @ingroup Diskselector
22023 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22026 * Appends a new item to the diskselector object.
22028 * @param obj The diskselector object.
22029 * @param label The label of the diskselector item.
22030 * @param icon The icon object to use at left side of the item. An
22031 * icon can be any Evas object, but usually it is an icon created
22032 * with elm_icon_add().
22033 * @param func The function to call when the item is selected.
22034 * @param data The data to associate with the item for related callbacks.
22036 * @return The created item or @c NULL upon failure.
22038 * A new item will be created and appended to the diskselector, i.e., will
22039 * be set as last item. Also, if there is no selected item, it will
22040 * be selected. This will always happens for the first appended item.
22042 * If no icon is set, label will be centered on item position, otherwise
22043 * the icon will be placed at left of the label, that will be shifted
22046 * Items created with this method can be deleted with
22047 * elm_diskselector_item_del().
22049 * Associated @p data can be properly freed when item is deleted if a
22050 * callback function is set with elm_diskselector_item_del_cb_set().
22052 * If a function is passed as argument, it will be called everytime this item
22053 * is selected, i.e., the user stops the diskselector with this
22054 * item on center position. If such function isn't needed, just passing
22055 * @c NULL as @p func is enough. The same should be done for @p data.
22057 * Simple example (with no function callback or data associated):
22059 * disk = elm_diskselector_add(win);
22060 * ic = elm_icon_add(win);
22061 * elm_icon_file_set(ic, "path/to/image", NULL);
22062 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
22063 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
22066 * @see elm_diskselector_item_del()
22067 * @see elm_diskselector_item_del_cb_set()
22068 * @see elm_diskselector_clear()
22069 * @see elm_icon_add()
22071 * @ingroup Diskselector
22073 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);
22077 * Delete them item from the diskselector.
22079 * @param it The item of diskselector to be deleted.
22081 * If deleting all diskselector items is required, elm_diskselector_clear()
22082 * should be used instead of getting items list and deleting each one.
22084 * @see elm_diskselector_clear()
22085 * @see elm_diskselector_item_append()
22086 * @see elm_diskselector_item_del_cb_set()
22088 * @ingroup Diskselector
22090 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22093 * Set the function called when a diskselector item is freed.
22095 * @param it The item to set the callback on
22096 * @param func The function called
22098 * If there is a @p func, then it will be called prior item's memory release.
22099 * That will be called with the following arguments:
22101 * @li item's Evas object;
22104 * This way, a data associated to a diskselector item could be properly
22107 * @ingroup Diskselector
22109 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22112 * Get the data associated to the item.
22114 * @param it The diskselector item
22115 * @return The data associated to @p it
22117 * The return value is a pointer to data associated to @p item when it was
22118 * created, with function elm_diskselector_item_append(). If no data
22119 * was passed as argument, it will return @c NULL.
22121 * @see elm_diskselector_item_append()
22123 * @ingroup Diskselector
22125 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22128 * Set the icon associated to the item.
22130 * @param it The diskselector item
22131 * @param icon The icon object to associate with @p it
22133 * The icon object to use at left side of the item. An
22134 * icon can be any Evas object, but usually it is an icon created
22135 * with elm_icon_add().
22137 * Once the icon object is set, a previously set one will be deleted.
22138 * @warning Setting the same icon for two items will cause the icon to
22139 * dissapear from the first item.
22141 * If an icon was passed as argument on item creation, with function
22142 * elm_diskselector_item_append(), it will be already
22143 * associated to the item.
22145 * @see elm_diskselector_item_append()
22146 * @see elm_diskselector_item_icon_get()
22148 * @ingroup Diskselector
22150 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22153 * Get the icon associated to the item.
22155 * @param it The diskselector item
22156 * @return The icon associated to @p it
22158 * The return value is a pointer to the icon associated to @p item when it was
22159 * created, with function elm_diskselector_item_append(), or later
22160 * with function elm_diskselector_item_icon_set. If no icon
22161 * was passed as argument, it will return @c NULL.
22163 * @see elm_diskselector_item_append()
22164 * @see elm_diskselector_item_icon_set()
22166 * @ingroup Diskselector
22168 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22171 * Set the label of item.
22173 * @param it The item of diskselector.
22174 * @param label The label of item.
22176 * The label to be displayed by the item.
22178 * If no icon is set, label will be centered on item position, otherwise
22179 * the icon will be placed at left of the label, that will be shifted
22182 * An item with label "January" would be displayed on side position as
22183 * "Jan" if max length is set to 3 with function
22184 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
22187 * When this @p item is selected, the entire label will be displayed,
22188 * except for width restrictions.
22189 * In this case label will be cropped and "..." will be concatenated,
22190 * but only for display purposes. It will keep the entire string, so
22191 * if diskselector is resized the remaining characters will be displayed.
22193 * If a label was passed as argument on item creation, with function
22194 * elm_diskselector_item_append(), it will be already
22195 * displayed by the item.
22197 * @see elm_diskselector_side_label_lenght_set()
22198 * @see elm_diskselector_item_label_get()
22199 * @see elm_diskselector_item_append()
22201 * @ingroup Diskselector
22203 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
22206 * Get the label of item.
22208 * @param it The item of diskselector.
22209 * @return The label of item.
22211 * The return value is a pointer to the label associated to @p item when it was
22212 * created, with function elm_diskselector_item_append(), or later
22213 * with function elm_diskselector_item_label_set. If no label
22214 * was passed as argument, it will return @c NULL.
22216 * @see elm_diskselector_item_label_set() for more details.
22217 * @see elm_diskselector_item_append()
22219 * @ingroup Diskselector
22221 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22224 * Get the selected item.
22226 * @param obj The diskselector object.
22227 * @return The selected diskselector item.
22229 * The selected item can be unselected with function
22230 * elm_diskselector_item_selected_set(), and the first item of
22231 * diskselector will be selected.
22233 * The selected item always will be centered on diskselector, with
22234 * full label displayed, i.e., max lenght set to side labels won't
22235 * apply on the selected item. More details on
22236 * elm_diskselector_side_label_length_set().
22238 * @ingroup Diskselector
22240 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22243 * Set the selected state of an item.
22245 * @param it The diskselector item
22246 * @param selected The selected state
22248 * This sets the selected state of the given item @p it.
22249 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22251 * If a new item is selected the previosly selected will be unselected.
22252 * Previoulsy selected item can be get with function
22253 * elm_diskselector_selected_item_get().
22255 * If the item @p it is unselected, the first item of diskselector will
22258 * Selected items will be visible on center position of diskselector.
22259 * So if it was on another position before selected, or was invisible,
22260 * diskselector will animate items until the selected item reaches center
22263 * @see elm_diskselector_item_selected_get()
22264 * @see elm_diskselector_selected_item_get()
22266 * @ingroup Diskselector
22268 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
22271 * Get whether the @p item is selected or not.
22273 * @param it The diskselector item.
22274 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
22275 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22277 * @see elm_diskselector_selected_item_set() for details.
22278 * @see elm_diskselector_item_selected_get()
22280 * @ingroup Diskselector
22282 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22285 * Get the first item of the diskselector.
22287 * @param obj The diskselector object.
22288 * @return The first item, or @c NULL if none.
22290 * The list of items follows append order. So it will return the first
22291 * item appended to the widget that wasn't deleted.
22293 * @see elm_diskselector_item_append()
22294 * @see elm_diskselector_items_get()
22296 * @ingroup Diskselector
22298 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22301 * Get the last item of the diskselector.
22303 * @param obj The diskselector object.
22304 * @return The last item, or @c NULL if none.
22306 * The list of items follows append order. So it will return last first
22307 * item appended to the widget that wasn't deleted.
22309 * @see elm_diskselector_item_append()
22310 * @see elm_diskselector_items_get()
22312 * @ingroup Diskselector
22314 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22317 * Get the item before @p item in diskselector.
22319 * @param it The diskselector item.
22320 * @return The item before @p item, or @c NULL if none or on failure.
22322 * The list of items follows append order. So it will return item appended
22323 * just before @p item and that wasn't deleted.
22325 * If it is the first item, @c NULL will be returned.
22326 * First item can be get by elm_diskselector_first_item_get().
22328 * @see elm_diskselector_item_append()
22329 * @see elm_diskselector_items_get()
22331 * @ingroup Diskselector
22333 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22336 * Get the item after @p item in diskselector.
22338 * @param it The diskselector item.
22339 * @return The item after @p item, or @c NULL if none or on failure.
22341 * The list of items follows append order. So it will return item appended
22342 * just after @p item and that wasn't deleted.
22344 * If it is the last item, @c NULL will be returned.
22345 * Last item can be get by elm_diskselector_last_item_get().
22347 * @see elm_diskselector_item_append()
22348 * @see elm_diskselector_items_get()
22350 * @ingroup Diskselector
22352 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22355 * Set the text to be shown in the diskselector item.
22357 * @param item Target item
22358 * @param text The text to set in the content
22360 * Setup the text as tooltip to object. The item can have only one tooltip,
22361 * so any previous tooltip data is removed.
22363 * @see elm_object_tooltip_text_set() for more details.
22365 * @ingroup Diskselector
22367 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
22370 * Set the content to be shown in the tooltip item.
22372 * Setup the tooltip to item. The item can have only one tooltip,
22373 * so any previous tooltip data is removed. @p func(with @p data) will
22374 * be called every time that need show the tooltip and it should
22375 * return a valid Evas_Object. This object is then managed fully by
22376 * tooltip system and is deleted when the tooltip is gone.
22378 * @param item the diskselector item being attached a tooltip.
22379 * @param func the function used to create the tooltip contents.
22380 * @param data what to provide to @a func as callback data/context.
22381 * @param del_cb called when data is not needed anymore, either when
22382 * another callback replaces @p func, the tooltip is unset with
22383 * elm_diskselector_item_tooltip_unset() or the owner @a item
22384 * dies. This callback receives as the first parameter the
22385 * given @a data, and @c event_info is the item.
22387 * @see elm_object_tooltip_content_cb_set() for more details.
22389 * @ingroup Diskselector
22391 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);
22394 * Unset tooltip from item.
22396 * @param item diskselector item to remove previously set tooltip.
22398 * Remove tooltip from item. The callback provided as del_cb to
22399 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
22400 * it is not used anymore.
22402 * @see elm_object_tooltip_unset() for more details.
22403 * @see elm_diskselector_item_tooltip_content_cb_set()
22405 * @ingroup Diskselector
22407 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22411 * Sets a different style for this item tooltip.
22413 * @note before you set a style you should define a tooltip with
22414 * elm_diskselector_item_tooltip_content_cb_set() or
22415 * elm_diskselector_item_tooltip_text_set()
22417 * @param item diskselector item with tooltip already set.
22418 * @param style the theme style to use (default, transparent, ...)
22420 * @see elm_object_tooltip_style_set() for more details.
22422 * @ingroup Diskselector
22424 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22427 * Get the style for this item tooltip.
22429 * @param item diskselector item with tooltip already set.
22430 * @return style the theme style in use, defaults to "default". If the
22431 * object does not have a tooltip set, then NULL is returned.
22433 * @see elm_object_tooltip_style_get() for more details.
22434 * @see elm_diskselector_item_tooltip_style_set()
22436 * @ingroup Diskselector
22438 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22441 * Set the cursor to be shown when mouse is over the diskselector item
22443 * @param item Target item
22444 * @param cursor the cursor name to be used.
22446 * @see elm_object_cursor_set() for more details.
22448 * @ingroup Diskselector
22450 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
22453 * Get the cursor to be shown when mouse is over the diskselector item
22455 * @param item diskselector item with cursor already set.
22456 * @return the cursor name.
22458 * @see elm_object_cursor_get() for more details.
22459 * @see elm_diskselector_cursor_set()
22461 * @ingroup Diskselector
22463 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22467 * Unset the cursor to be shown when mouse is over the diskselector item
22469 * @param item Target item
22471 * @see elm_object_cursor_unset() for more details.
22472 * @see elm_diskselector_cursor_set()
22474 * @ingroup Diskselector
22476 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22479 * Sets a different style for this item cursor.
22481 * @note before you set a style you should define a cursor with
22482 * elm_diskselector_item_cursor_set()
22484 * @param item diskselector item with cursor already set.
22485 * @param style the theme style to use (default, transparent, ...)
22487 * @see elm_object_cursor_style_set() for more details.
22489 * @ingroup Diskselector
22491 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22495 * Get the style for this item cursor.
22497 * @param item diskselector item with cursor already set.
22498 * @return style the theme style in use, defaults to "default". If the
22499 * object does not have a cursor set, then @c NULL is returned.
22501 * @see elm_object_cursor_style_get() for more details.
22502 * @see elm_diskselector_item_cursor_style_set()
22504 * @ingroup Diskselector
22506 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22510 * Set if the cursor set should be searched on the theme or should use
22511 * the provided by the engine, only.
22513 * @note before you set if should look on theme you should define a cursor
22514 * with elm_diskselector_item_cursor_set().
22515 * By default it will only look for cursors provided by the engine.
22517 * @param item widget item with cursor already set.
22518 * @param engine_only boolean to define if cursors set with
22519 * elm_diskselector_item_cursor_set() should be searched only
22520 * between cursors provided by the engine or searched on widget's
22523 * @see elm_object_cursor_engine_only_set() for more details.
22525 * @ingroup Diskselector
22527 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
22530 * Get the cursor engine only usage for this item cursor.
22532 * @param item widget item with cursor already set.
22533 * @return engine_only boolean to define it cursors should be looked only
22534 * between the provided by the engine or searched on widget's theme as well.
22535 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
22537 * @see elm_object_cursor_engine_only_get() for more details.
22538 * @see elm_diskselector_item_cursor_engine_only_set()
22540 * @ingroup Diskselector
22542 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22549 * @defgroup Colorselector Colorselector
22553 * @image html img/widget/colorselector/preview-00.png
22555 * @brief Widget for user to select a color.
22557 * Signals that you can add callbacks for are:
22558 * "changed" - When the color value changes(event_info is NULL).
22560 * See @ref tutorial_colorselector.
22563 * @brief Add a new colorselector to the parent
22565 * @param parent The parent object
22566 * @return The new object or NULL if it cannot be created
22568 * @ingroup Colorselector
22570 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22572 * Set a color for the colorselector
22574 * @param obj Colorselector object
22575 * @param r r-value of color
22576 * @param g g-value of color
22577 * @param b b-value of color
22578 * @param a a-value of color
22580 * @ingroup Colorselector
22582 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22584 * Get a color from the colorselector
22586 * @param obj Colorselector object
22587 * @param r integer pointer for r-value of color
22588 * @param g integer pointer for g-value of color
22589 * @param b integer pointer for b-value of color
22590 * @param a integer pointer for a-value of color
22592 * @ingroup Colorselector
22594 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22600 * @defgroup Ctxpopup Ctxpopup
22602 * @image html img/widget/ctxpopup/preview-00.png
22603 * @image latex img/widget/ctxpopup/preview-00.eps
22605 * @brief Context popup widet.
22607 * A ctxpopup is a widget that, when shown, pops up a list of items.
22608 * It automatically chooses an area inside its parent object's view
22609 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
22610 * optimally fit into it. In the default theme, it will also point an
22611 * arrow to it's top left position at the time one shows it. Ctxpopup
22612 * items have a label and/or an icon. It is intended for a small
22613 * number of items (hence the use of list, not genlist).
22615 * @note Ctxpopup is a especialization of @ref Hover.
22617 * Signals that you can add callbacks for are:
22618 * "dismissed" - the ctxpopup was dismissed
22620 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
22623 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
22625 typedef enum _Elm_Ctxpopup_Direction
22627 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
22629 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
22630 the clicked area */
22631 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
22632 the clicked area */
22633 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
22635 } Elm_Ctxpopup_Direction;
22638 * @brief Add a new Ctxpopup object to the parent.
22640 * @param parent Parent object
22641 * @return New object or @c NULL, if it cannot be created
22643 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22645 * @brief Set the Ctxpopup's parent
22647 * @param obj The ctxpopup object
22648 * @param area The parent to use
22650 * Set the parent object.
22652 * @note elm_ctxpopup_add() will automatically call this function
22653 * with its @c parent argument.
22655 * @see elm_ctxpopup_add()
22656 * @see elm_hover_parent_set()
22658 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
22660 * @brief Get the Ctxpopup's parent
22662 * @param obj The ctxpopup object
22664 * @see elm_ctxpopup_hover_parent_set() for more information
22666 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22668 * @brief Clear all items in the given ctxpopup object.
22670 * @param obj Ctxpopup object
22672 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22674 * @brief Change the ctxpopup's orientation to horizontal or vertical.
22676 * @param obj Ctxpopup object
22677 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
22679 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22681 * @brief Get the value of current ctxpopup object's orientation.
22683 * @param obj Ctxpopup object
22684 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
22686 * @see elm_ctxpopup_horizontal_set()
22688 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22690 * @brief Add a new item to a ctxpopup object.
22692 * @param obj Ctxpopup object
22693 * @param icon Icon to be set on new item
22694 * @param label The Label of the new item
22695 * @param func Convenience function called when item selected
22696 * @param data Data passed to @p func
22697 * @return A handle to the item added or @c NULL, on errors
22699 * @warning Ctxpopup can't hold both an item list and a content at the same
22700 * time. When an item is added, any previous content will be removed.
22702 * @see elm_ctxpopup_content_set()
22704 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);
22706 * @brief Delete the given item in a ctxpopup object.
22708 * @param item Ctxpopup item to be deleted
22710 * @see elm_ctxpopup_item_append()
22712 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
22714 * @brief Set the ctxpopup item's state as disabled or enabled.
22716 * @param item Ctxpopup item to be enabled/disabled
22717 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
22719 * When disabled the item is greyed out to indicate it's state.
22721 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22723 * @brief Get the ctxpopup item's disabled/enabled state.
22725 * @param item Ctxpopup item to be enabled/disabled
22726 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
22728 * @see elm_ctxpopup_item_disabled_set()
22730 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22732 * @brief Get the icon object for the given ctxpopup item.
22734 * @param item Ctxpopup item
22735 * @return icon object or @c NULL, if the item does not have icon or an error
22738 * @see elm_ctxpopup_item_append()
22739 * @see elm_ctxpopup_item_icon_set()
22741 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22743 * @brief Sets the side icon associated with the ctxpopup item
22745 * @param item Ctxpopup item
22746 * @param icon Icon object to be set
22748 * Once the icon object is set, a previously set one will be deleted.
22749 * @warning Setting the same icon for two items will cause the icon to
22750 * dissapear from the first item.
22752 * @see elm_ctxpopup_item_append()
22754 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22756 * @brief Get the label for the given ctxpopup item.
22758 * @param item Ctxpopup item
22759 * @return label string or @c NULL, if the item does not have label or an
22762 * @see elm_ctxpopup_item_append()
22763 * @see elm_ctxpopup_item_label_set()
22765 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22767 * @brief (Re)set the label on the given ctxpopup item.
22769 * @param item Ctxpopup item
22770 * @param label String to set as label
22772 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
22774 * @brief Set an elm widget as the content of the ctxpopup.
22776 * @param obj Ctxpopup object
22777 * @param content Content to be swallowed
22779 * If the content object is already set, a previous one will bedeleted. If
22780 * you want to keep that old content object, use the
22781 * elm_ctxpopup_content_unset() function.
22783 * @deprecated use elm_object_content_set()
22785 * @warning Ctxpopup can't hold both a item list and a content at the same
22786 * time. When a content is set, any previous items will be removed.
22788 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
22790 * @brief Unset the ctxpopup content
22792 * @param obj Ctxpopup object
22793 * @return The content that was being used
22795 * Unparent and return the content object which was set for this widget.
22797 * @deprecated use elm_object_content_unset()
22799 * @see elm_ctxpopup_content_set()
22801 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22803 * @brief Set the direction priority of a ctxpopup.
22805 * @param obj Ctxpopup object
22806 * @param first 1st priority of direction
22807 * @param second 2nd priority of direction
22808 * @param third 3th priority of direction
22809 * @param fourth 4th priority of direction
22811 * This functions gives a chance to user to set the priority of ctxpopup
22812 * showing direction. This doesn't guarantee the ctxpopup will appear in the
22813 * requested direction.
22815 * @see Elm_Ctxpopup_Direction
22817 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);
22819 * @brief Get the direction priority of a ctxpopup.
22821 * @param obj Ctxpopup object
22822 * @param first 1st priority of direction to be returned
22823 * @param second 2nd priority of direction to be returned
22824 * @param third 3th priority of direction to be returned
22825 * @param fourth 4th priority of direction to be returned
22827 * @see elm_ctxpopup_direction_priority_set() for more information.
22829 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);
22837 * @defgroup Transit Transit
22838 * @ingroup Elementary
22840 * Transit is designed to apply various animated transition effects to @c
22841 * Evas_Object, such like translation, rotation, etc. For using these
22842 * effects, create an @ref Elm_Transit and add the desired transition effects.
22844 * Once the effects are added into transit, they will be automatically
22845 * managed (their callback will be called until the duration is ended, and
22846 * they will be deleted on completion).
22850 * Elm_Transit *trans = elm_transit_add();
22851 * elm_transit_object_add(trans, obj);
22852 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
22853 * elm_transit_duration_set(transit, 1);
22854 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
22855 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22856 * elm_transit_repeat_times_set(transit, 3);
22859 * Some transition effects are used to change the properties of objects. They
22861 * @li @ref elm_transit_effect_translation_add
22862 * @li @ref elm_transit_effect_color_add
22863 * @li @ref elm_transit_effect_rotation_add
22864 * @li @ref elm_transit_effect_wipe_add
22865 * @li @ref elm_transit_effect_zoom_add
22866 * @li @ref elm_transit_effect_resizing_add
22868 * Other transition effects are used to make one object disappear and another
22869 * object appear on its old place. These effects are:
22871 * @li @ref elm_transit_effect_flip_add
22872 * @li @ref elm_transit_effect_resizable_flip_add
22873 * @li @ref elm_transit_effect_fade_add
22874 * @li @ref elm_transit_effect_blend_add
22876 * It's also possible to make a transition chain with @ref
22877 * elm_transit_chain_transit_add.
22879 * @warning We strongly recommend to use elm_transit just when edje can not do
22880 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
22881 * animations can be manipulated inside the theme.
22883 * List of examples:
22884 * @li @ref transit_example_01_explained
22885 * @li @ref transit_example_02_explained
22886 * @li @ref transit_example_03_c
22887 * @li @ref transit_example_04_c
22893 * @enum Elm_Transit_Tween_Mode
22895 * The type of acceleration used in the transition.
22899 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
22900 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
22901 over time, then decrease again
22903 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
22905 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
22907 } Elm_Transit_Tween_Mode;
22910 * @enum Elm_Transit_Effect_Flip_Axis
22912 * The axis where flip effect should be applied.
22916 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
22917 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
22918 } Elm_Transit_Effect_Flip_Axis;
22920 * @enum Elm_Transit_Effect_Wipe_Dir
22922 * The direction where the wipe effect should occur.
22926 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
22927 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
22928 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
22929 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
22930 } Elm_Transit_Effect_Wipe_Dir;
22931 /** @enum Elm_Transit_Effect_Wipe_Type
22933 * Whether the wipe effect should show or hide the object.
22937 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
22939 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
22941 } Elm_Transit_Effect_Wipe_Type;
22944 * @typedef Elm_Transit
22946 * The Transit created with elm_transit_add(). This type has the information
22947 * about the objects which the transition will be applied, and the
22948 * transition effects that will be used. It also contains info about
22949 * duration, number of repetitions, auto-reverse, etc.
22951 typedef struct _Elm_Transit Elm_Transit;
22952 typedef void Elm_Transit_Effect;
22954 * @typedef Elm_Transit_Effect_Transition_Cb
22956 * Transition callback called for this effect on each transition iteration.
22958 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
22960 * Elm_Transit_Effect_End_Cb
22962 * Transition callback called for this effect when the transition is over.
22964 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
22967 * Elm_Transit_Del_Cb
22969 * A callback called when the transit is deleted.
22971 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
22976 * @note Is not necessary to delete the transit object, it will be deleted at
22977 * the end of its operation.
22978 * @note The transit will start playing when the program enter in the main loop, is not
22979 * necessary to give a start to the transit.
22981 * @return The transit object.
22985 EAPI Elm_Transit *elm_transit_add(void);
22988 * Stops the animation and delete the @p transit object.
22990 * Call this function if you wants to stop the animation before the duration
22991 * time. Make sure the @p transit object is still alive with
22992 * elm_transit_del_cb_set() function.
22993 * All added effects will be deleted, calling its repective data_free_cb
22994 * functions. The function setted by elm_transit_del_cb_set() will be called.
22996 * @see elm_transit_del_cb_set()
22998 * @param transit The transit object to be deleted.
23001 * @warning Just call this function if you are sure the transit is alive.
23003 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23006 * Add a new effect to the transit.
23008 * @note The cb function and the data are the key to the effect. If you try to
23009 * add an already added effect, nothing is done.
23010 * @note After the first addition of an effect in @p transit, if its
23011 * effect list become empty again, the @p transit will be killed by
23012 * elm_transit_del(transit) function.
23016 * Elm_Transit *transit = elm_transit_add();
23017 * elm_transit_effect_add(transit,
23018 * elm_transit_effect_blend_op,
23019 * elm_transit_effect_blend_context_new(),
23020 * elm_transit_effect_blend_context_free);
23023 * @param transit The transit object.
23024 * @param transition_cb The operation function. It is called when the
23025 * animation begins, it is the function that actually performs the animation.
23026 * It is called with the @p data, @p transit and the time progression of the
23027 * animation (a double value between 0.0 and 1.0).
23028 * @param effect The context data of the effect.
23029 * @param end_cb The function to free the context data, it will be called
23030 * at the end of the effect, it must finalize the animation and free the
23034 * @warning The transit free the context data at the and of the transition with
23035 * the data_free_cb function, do not use the context data in another transit.
23037 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);
23040 * Delete an added effect.
23042 * This function will remove the effect from the @p transit, calling the
23043 * data_free_cb to free the @p data.
23045 * @see elm_transit_effect_add()
23047 * @note If the effect is not found, nothing is done.
23048 * @note If the effect list become empty, this function will call
23049 * elm_transit_del(transit), that is, it will kill the @p transit.
23051 * @param transit The transit object.
23052 * @param transition_cb The operation function.
23053 * @param effect The context data of the effect.
23057 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);
23060 * Add new object to apply the effects.
23062 * @note After the first addition of an object in @p transit, if its
23063 * object list become empty again, the @p transit will be killed by
23064 * elm_transit_del(transit) function.
23065 * @note If the @p obj belongs to another transit, the @p obj will be
23066 * removed from it and it will only belong to the @p transit. If the old
23067 * transit stays without objects, it will die.
23068 * @note When you add an object into the @p transit, its state from
23069 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23070 * transit ends, if you change this state whith evas_object_pass_events_set()
23071 * after add the object, this state will change again when @p transit stops to
23074 * @param transit The transit object.
23075 * @param obj Object to be animated.
23078 * @warning It is not allowed to add a new object after transit begins to go.
23080 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23083 * Removes an added object from the transit.
23085 * @note If the @p obj is not in the @p transit, nothing is done.
23086 * @note If the list become empty, this function will call
23087 * elm_transit_del(transit), that is, it will kill the @p transit.
23089 * @param transit The transit object.
23090 * @param obj Object to be removed from @p transit.
23093 * @warning It is not allowed to remove objects after transit begins to go.
23095 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23098 * Get the objects of the transit.
23100 * @param transit The transit object.
23101 * @return a Eina_List with the objects from the transit.
23105 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23108 * Enable/disable keeping up the objects states.
23109 * If it is not kept, the objects states will be reset when transition ends.
23111 * @note @p transit can not be NULL.
23112 * @note One state includes geometry, color, map data.
23114 * @param transit The transit object.
23115 * @param state_keep Keeping or Non Keeping.
23119 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
23122 * Get a value whether the objects states will be reset or not.
23124 * @note @p transit can not be NULL
23126 * @see elm_transit_objects_final_state_keep_set()
23128 * @param transit The transit object.
23129 * @return EINA_TRUE means the states of the objects will be reset.
23130 * If @p transit is NULL, EINA_FALSE is returned
23134 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23137 * Set the event enabled when transit is operating.
23139 * If @p enabled is EINA_TRUE, the objects of the transit will receives
23140 * events from mouse and keyboard during the animation.
23141 * @note When you add an object with elm_transit_object_add(), its state from
23142 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23143 * transit ends, if you change this state with evas_object_pass_events_set()
23144 * after adding the object, this state will change again when @p transit stops
23147 * @param transit The transit object.
23148 * @param enabled Events are received when enabled is @c EINA_TRUE, and
23149 * ignored otherwise.
23153 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23156 * Get the value of event enabled status.
23158 * @see elm_transit_event_enabled_set()
23160 * @param transit The Transit object
23161 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
23162 * EINA_FALSE is returned
23166 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23169 * Set the user-callback function when the transit is deleted.
23171 * @note Using this function twice will overwrite the first function setted.
23172 * @note the @p transit object will be deleted after call @p cb function.
23174 * @param transit The transit object.
23175 * @param cb Callback function pointer. This function will be called before
23176 * the deletion of the transit.
23177 * @param data Callback funtion user data. It is the @p op parameter.
23181 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
23184 * Set reverse effect automatically.
23186 * If auto reverse is setted, after running the effects with the progress
23187 * parameter from 0 to 1, it will call the effecs again with the progress
23188 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
23189 * where the duration was setted with the function elm_transit_add and
23190 * the repeat with the function elm_transit_repeat_times_set().
23192 * @param transit The transit object.
23193 * @param reverse EINA_TRUE means the auto_reverse is on.
23197 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
23200 * Get if the auto reverse is on.
23202 * @see elm_transit_auto_reverse_set()
23204 * @param transit The transit object.
23205 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
23206 * EINA_FALSE is returned
23210 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23213 * Set the transit repeat count. Effect will be repeated by repeat count.
23215 * This function sets the number of repetition the transit will run after
23216 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
23217 * If the @p repeat is a negative number, it will repeat infinite times.
23219 * @note If this function is called during the transit execution, the transit
23220 * will run @p repeat times, ignoring the times it already performed.
23222 * @param transit The transit object
23223 * @param repeat Repeat count
23227 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
23230 * Get the transit repeat count.
23232 * @see elm_transit_repeat_times_set()
23234 * @param transit The Transit object.
23235 * @return The repeat count. If @p transit is NULL
23240 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23243 * Set the transit animation acceleration type.
23245 * This function sets the tween mode of the transit that can be:
23246 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
23247 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
23248 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
23249 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
23251 * @param transit The transit object.
23252 * @param tween_mode The tween type.
23256 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
23259 * Get the transit animation acceleration type.
23261 * @note @p transit can not be NULL
23263 * @param transit The transit object.
23264 * @return The tween type. If @p transit is NULL
23265 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
23269 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23272 * Set the transit animation time
23274 * @note @p transit can not be NULL
23276 * @param transit The transit object.
23277 * @param duration The animation time.
23281 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
23284 * Get the transit animation time
23286 * @note @p transit can not be NULL
23288 * @param transit The transit object.
23290 * @return The transit animation time.
23294 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23297 * Starts the transition.
23298 * Once this API is called, the transit begins to measure the time.
23300 * @note @p transit can not be NULL
23302 * @param transit The transit object.
23306 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23309 * Pause/Resume the transition.
23311 * If you call elm_transit_go again, the transit will be started from the
23312 * beginning, and will be unpaused.
23314 * @note @p transit can not be NULL
23316 * @param transit The transit object.
23317 * @param paused Whether the transition should be paused or not.
23321 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
23324 * Get the value of paused status.
23326 * @see elm_transit_paused_set()
23328 * @note @p transit can not be NULL
23330 * @param transit The transit object.
23331 * @return EINA_TRUE means transition is paused. If @p transit is NULL
23332 * EINA_FALSE is returned
23336 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23339 * Get the time progression of the animation (a double value between 0.0 and 1.0).
23341 * The value returned is a fraction (current time / total time). It
23342 * represents the progression position relative to the total.
23344 * @note @p transit can not be NULL
23346 * @param transit The transit object.
23348 * @return The time progression value. If @p transit is NULL
23353 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23356 * Makes the chain relationship between two transits.
23358 * @note @p transit can not be NULL. Transit would have multiple chain transits.
23359 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
23361 * @param transit The transit object.
23362 * @param chain_transit The chain transit object. This transit will be operated
23363 * after transit is done.
23365 * This function adds @p chain_transit transition to a chain after the @p
23366 * transit, and will be started as soon as @p transit ends. See @ref
23367 * transit_example_02_explained for a full example.
23371 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
23374 * Cut off the chain relationship between two transits.
23376 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
23377 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
23379 * @param transit The transit object.
23380 * @param chain_transit The chain transit object.
23382 * This function remove the @p chain_transit transition from the @p transit.
23386 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
23389 * Get the current chain transit list.
23391 * @note @p transit can not be NULL.
23393 * @param transit The transit object.
23394 * @return chain transit list.
23398 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
23401 * Add the Resizing Effect to Elm_Transit.
23403 * @note This API is one of the facades. It creates resizing effect context
23404 * and add it's required APIs to elm_transit_effect_add.
23406 * @see elm_transit_effect_add()
23408 * @param transit Transit object.
23409 * @param from_w Object width size when effect begins.
23410 * @param from_h Object height size when effect begins.
23411 * @param to_w Object width size when effect ends.
23412 * @param to_h Object height size when effect ends.
23413 * @return Resizing effect context data.
23417 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);
23420 * Add the Translation Effect to Elm_Transit.
23422 * @note This API is one of the facades. It creates translation effect context
23423 * and add it's required APIs to elm_transit_effect_add.
23425 * @see elm_transit_effect_add()
23427 * @param transit Transit object.
23428 * @param from_dx X Position variation when effect begins.
23429 * @param from_dy Y Position variation when effect begins.
23430 * @param to_dx X Position variation when effect ends.
23431 * @param to_dy Y Position variation when effect ends.
23432 * @return Translation effect context data.
23435 * @warning It is highly recommended just create a transit with this effect when
23436 * the window that the objects of the transit belongs has already been created.
23437 * This is because this effect needs the geometry information about the objects,
23438 * and if the window was not created yet, it can get a wrong information.
23440 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);
23443 * Add the Zoom Effect to Elm_Transit.
23445 * @note This API is one of the facades. It creates zoom effect context
23446 * and add it's required APIs to elm_transit_effect_add.
23448 * @see elm_transit_effect_add()
23450 * @param transit Transit object.
23451 * @param from_rate Scale rate when effect begins (1 is current rate).
23452 * @param to_rate Scale rate when effect ends.
23453 * @return Zoom effect context data.
23456 * @warning It is highly recommended just create a transit with this effect when
23457 * the window that the objects of the transit belongs has already been created.
23458 * This is because this effect needs the geometry information about the objects,
23459 * and if the window was not created yet, it can get a wrong information.
23461 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
23464 * Add the Flip Effect to Elm_Transit.
23466 * @note This API is one of the facades. It creates flip effect context
23467 * and add it's required APIs to elm_transit_effect_add.
23468 * @note This effect is applied to each pair of objects in the order they are listed
23469 * in the transit list of objects. The first object in the pair will be the
23470 * "front" object and the second will be the "back" object.
23472 * @see elm_transit_effect_add()
23474 * @param transit Transit object.
23475 * @param axis Flipping Axis(X or Y).
23476 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23477 * @return Flip effect context data.
23480 * @warning It is highly recommended just create a transit with this effect when
23481 * the window that the objects of the transit belongs has already been created.
23482 * This is because this effect needs the geometry information about the objects,
23483 * and if the window was not created yet, it can get a wrong information.
23485 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23488 * Add the Resizable Flip Effect to Elm_Transit.
23490 * @note This API is one of the facades. It creates resizable flip effect context
23491 * and add it's required APIs to elm_transit_effect_add.
23492 * @note This effect is applied to each pair of objects in the order they are listed
23493 * in the transit list of objects. The first object in the pair will be the
23494 * "front" object and the second will be the "back" object.
23496 * @see elm_transit_effect_add()
23498 * @param transit Transit object.
23499 * @param axis Flipping Axis(X or Y).
23500 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23501 * @return Resizable flip effect context data.
23504 * @warning It is highly recommended just create a transit with this effect when
23505 * the window that the objects of the transit belongs has already been created.
23506 * This is because this effect needs the geometry information about the objects,
23507 * and if the window was not created yet, it can get a wrong information.
23509 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23512 * Add the Wipe Effect to Elm_Transit.
23514 * @note This API is one of the facades. It creates wipe effect context
23515 * and add it's required APIs to elm_transit_effect_add.
23517 * @see elm_transit_effect_add()
23519 * @param transit Transit object.
23520 * @param type Wipe type. Hide or show.
23521 * @param dir Wipe Direction.
23522 * @return Wipe effect context data.
23525 * @warning It is highly recommended just create a transit with this effect when
23526 * the window that the objects of the transit belongs has already been created.
23527 * This is because this effect needs the geometry information about the objects,
23528 * and if the window was not created yet, it can get a wrong information.
23530 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
23533 * Add the Color Effect to Elm_Transit.
23535 * @note This API is one of the facades. It creates color effect context
23536 * and add it's required APIs to elm_transit_effect_add.
23538 * @see elm_transit_effect_add()
23540 * @param transit Transit object.
23541 * @param from_r RGB R when effect begins.
23542 * @param from_g RGB G when effect begins.
23543 * @param from_b RGB B when effect begins.
23544 * @param from_a RGB A when effect begins.
23545 * @param to_r RGB R when effect ends.
23546 * @param to_g RGB G when effect ends.
23547 * @param to_b RGB B when effect ends.
23548 * @param to_a RGB A when effect ends.
23549 * @return Color effect context data.
23553 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);
23556 * Add the Fade Effect to Elm_Transit.
23558 * @note This API is one of the facades. It creates fade effect context
23559 * and add it's required APIs to elm_transit_effect_add.
23560 * @note This effect is applied to each pair of objects in the order they are listed
23561 * in the transit list of objects. The first object in the pair will be the
23562 * "before" object and the second will be the "after" object.
23564 * @see elm_transit_effect_add()
23566 * @param transit Transit object.
23567 * @return Fade effect context data.
23570 * @warning It is highly recommended just create a transit with this effect when
23571 * the window that the objects of the transit belongs has already been created.
23572 * This is because this effect needs the color information about the objects,
23573 * and if the window was not created yet, it can get a wrong information.
23575 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
23578 * Add the Blend Effect to Elm_Transit.
23580 * @note This API is one of the facades. It creates blend effect context
23581 * and add it's required APIs to elm_transit_effect_add.
23582 * @note This effect is applied to each pair of objects in the order they are listed
23583 * in the transit list of objects. The first object in the pair will be the
23584 * "before" object and the second will be the "after" object.
23586 * @see elm_transit_effect_add()
23588 * @param transit Transit object.
23589 * @return Blend effect context data.
23592 * @warning It is highly recommended just create a transit with this effect when
23593 * the window that the objects of the transit belongs has already been created.
23594 * This is because this effect needs the color information about the objects,
23595 * and if the window was not created yet, it can get a wrong information.
23597 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
23600 * Add the Rotation Effect to Elm_Transit.
23602 * @note This API is one of the facades. It creates rotation effect context
23603 * and add it's required APIs to elm_transit_effect_add.
23605 * @see elm_transit_effect_add()
23607 * @param transit Transit object.
23608 * @param from_degree Degree when effect begins.
23609 * @param to_degree Degree when effect is ends.
23610 * @return Rotation effect context data.
23613 * @warning It is highly recommended just create a transit with this effect when
23614 * the window that the objects of the transit belongs has already been created.
23615 * This is because this effect needs the geometry information about the objects,
23616 * and if the window was not created yet, it can get a wrong information.
23618 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
23621 * Add the ImageAnimation Effect to Elm_Transit.
23623 * @note This API is one of the facades. It creates image animation effect context
23624 * and add it's required APIs to elm_transit_effect_add.
23625 * The @p images parameter is a list images paths. This list and
23626 * its contents will be deleted at the end of the effect by
23627 * elm_transit_effect_image_animation_context_free() function.
23631 * char buf[PATH_MAX];
23632 * Eina_List *images = NULL;
23633 * Elm_Transit *transi = elm_transit_add();
23635 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
23636 * images = eina_list_append(images, eina_stringshare_add(buf));
23638 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
23639 * images = eina_list_append(images, eina_stringshare_add(buf));
23640 * elm_transit_effect_image_animation_add(transi, images);
23644 * @see elm_transit_effect_add()
23646 * @param transit Transit object.
23647 * @param images Eina_List of images file paths. This list and
23648 * its contents will be deleted at the end of the effect by
23649 * elm_transit_effect_image_animation_context_free() function.
23650 * @return Image Animation effect context data.
23654 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
23659 typedef struct _Elm_Store Elm_Store;
23660 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
23661 typedef struct _Elm_Store_Item Elm_Store_Item;
23662 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
23663 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
23664 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
23665 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
23666 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
23667 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
23668 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
23669 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
23671 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
23672 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
23673 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
23674 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
23678 ELM_STORE_ITEM_MAPPING_NONE = 0,
23679 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
23680 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
23681 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
23682 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
23683 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
23684 // can add more here as needed by common apps
23685 ELM_STORE_ITEM_MAPPING_LAST
23686 } Elm_Store_Item_Mapping_Type;
23688 struct _Elm_Store_Item_Mapping_Icon
23690 // FIXME: allow edje file icons
23692 Elm_Icon_Lookup_Order lookup_order;
23693 Eina_Bool standard_name : 1;
23694 Eina_Bool no_scale : 1;
23695 Eina_Bool smooth : 1;
23696 Eina_Bool scale_up : 1;
23697 Eina_Bool scale_down : 1;
23700 struct _Elm_Store_Item_Mapping_Empty
23705 struct _Elm_Store_Item_Mapping_Photo
23710 struct _Elm_Store_Item_Mapping_Custom
23712 Elm_Store_Item_Mapping_Cb func;
23715 struct _Elm_Store_Item_Mapping
23717 Elm_Store_Item_Mapping_Type type;
23722 Elm_Store_Item_Mapping_Empty empty;
23723 Elm_Store_Item_Mapping_Icon icon;
23724 Elm_Store_Item_Mapping_Photo photo;
23725 Elm_Store_Item_Mapping_Custom custom;
23726 // add more types here
23730 struct _Elm_Store_Item_Info
23732 Elm_Genlist_Item_Class *item_class;
23733 const Elm_Store_Item_Mapping *mapping;
23738 struct _Elm_Store_Item_Info_Filesystem
23740 Elm_Store_Item_Info base;
23744 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
23745 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
23747 EAPI void elm_store_free(Elm_Store *st);
23749 EAPI Elm_Store *elm_store_filesystem_new(void);
23750 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
23751 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23752 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23754 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
23756 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
23757 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23758 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23759 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23760 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
23761 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23763 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23764 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
23765 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23766 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
23767 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23768 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23769 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23772 * @defgroup SegmentControl SegmentControl
23773 * @ingroup Elementary
23775 * @image html img/widget/segment_control/preview-00.png
23776 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
23778 * @image html img/segment_control.png
23779 * @image latex img/segment_control.eps width=\textwidth
23781 * Segment control widget is a horizontal control made of multiple segment
23782 * items, each segment item functioning similar to discrete two state button.
23783 * A segment control groups the items together and provides compact
23784 * single button with multiple equal size segments.
23786 * Segment item size is determined by base widget
23787 * size and the number of items added.
23788 * Only one segment item can be at selected state. A segment item can display
23789 * combination of Text and any Evas_Object like Images or other widget.
23791 * Smart callbacks one can listen to:
23792 * - "changed" - When the user clicks on a segment item which is not
23793 * previously selected and get selected. The event_info parameter is the
23794 * segment item index.
23796 * Available styles for it:
23799 * Here is an example on its usage:
23800 * @li @ref segment_control_example
23804 * @addtogroup SegmentControl
23808 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
23811 * Add a new segment control widget to the given parent Elementary
23812 * (container) object.
23814 * @param parent The parent object.
23815 * @return a new segment control widget handle or @c NULL, on errors.
23817 * This function inserts a new segment control widget on the canvas.
23819 * @ingroup SegmentControl
23821 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23824 * Append a new item to the segment control object.
23826 * @param obj The segment control object.
23827 * @param icon The icon object to use for the left side of the item. An
23828 * icon can be any Evas object, but usually it is an icon created
23829 * with elm_icon_add().
23830 * @param label The label of the item.
23831 * Note that, NULL is different from empty string "".
23832 * @return The created item or @c NULL upon failure.
23834 * A new item will be created and appended to the segment control, i.e., will
23835 * be set as @b last item.
23837 * If it should be inserted at another position,
23838 * elm_segment_control_item_insert_at() should be used instead.
23840 * Items created with this function can be deleted with function
23841 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23843 * @note @p label set to @c NULL is different from empty string "".
23845 * only has icon, it will be displayed bigger and centered. If it has
23846 * icon and label, even that an empty string, icon will be smaller and
23847 * positioned at left.
23851 * sc = elm_segment_control_add(win);
23852 * ic = elm_icon_add(win);
23853 * elm_icon_file_set(ic, "path/to/image", NULL);
23854 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23855 * elm_segment_control_item_add(sc, ic, "label");
23856 * evas_object_show(sc);
23859 * @see elm_segment_control_item_insert_at()
23860 * @see elm_segment_control_item_del()
23862 * @ingroup SegmentControl
23864 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
23867 * Insert a new item to the segment control object at specified position.
23869 * @param obj The segment control object.
23870 * @param icon The icon object to use for the left side of the item. An
23871 * icon can be any Evas object, but usually it is an icon created
23872 * with elm_icon_add().
23873 * @param label The label of the item.
23874 * @param index Item position. Value should be between 0 and items count.
23875 * @return The created item or @c NULL upon failure.
23877 * Index values must be between @c 0, when item will be prepended to
23878 * segment control, and items count, that can be get with
23879 * elm_segment_control_item_count_get(), case when item will be appended
23880 * to segment control, just like elm_segment_control_item_add().
23882 * Items created with this function can be deleted with function
23883 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23885 * @note @p label set to @c NULL is different from empty string "".
23887 * only has icon, it will be displayed bigger and centered. If it has
23888 * icon and label, even that an empty string, icon will be smaller and
23889 * positioned at left.
23891 * @see elm_segment_control_item_add()
23892 * @see elm_segment_control_count_get()
23893 * @see elm_segment_control_item_del()
23895 * @ingroup SegmentControl
23897 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);
23900 * Remove a segment control item from its parent, deleting it.
23902 * @param it The item to be removed.
23904 * Items can be added with elm_segment_control_item_add() or
23905 * elm_segment_control_item_insert_at().
23907 * @ingroup SegmentControl
23909 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23912 * Remove a segment control item at given index from its parent,
23915 * @param obj The segment control object.
23916 * @param index The position of the segment control item to be deleted.
23918 * Items can be added with elm_segment_control_item_add() or
23919 * elm_segment_control_item_insert_at().
23921 * @ingroup SegmentControl
23923 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23926 * Get the Segment items count from segment control.
23928 * @param obj The segment control object.
23929 * @return Segment items count.
23931 * It will just return the number of items added to segment control @p obj.
23933 * @ingroup SegmentControl
23935 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23938 * Get the item placed at specified index.
23940 * @param obj The segment control object.
23941 * @param index The index of the segment item.
23942 * @return The segment control item or @c NULL on failure.
23944 * Index is the position of an item in segment control widget. Its
23945 * range is from @c 0 to <tt> count - 1 </tt>.
23946 * Count is the number of items, that can be get with
23947 * elm_segment_control_item_count_get().
23949 * @ingroup SegmentControl
23951 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23954 * Get the label of item.
23956 * @param obj The segment control object.
23957 * @param index The index of the segment item.
23958 * @return The label of the item at @p index.
23960 * The return value is a pointer to the label associated to the item when
23961 * it was created, with function elm_segment_control_item_add(), or later
23962 * with function elm_segment_control_item_label_set. If no label
23963 * was passed as argument, it will return @c NULL.
23965 * @see elm_segment_control_item_label_set() for more details.
23966 * @see elm_segment_control_item_add()
23968 * @ingroup SegmentControl
23970 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23973 * Set the label of item.
23975 * @param it The item of segment control.
23976 * @param text The label of item.
23978 * The label to be displayed by the item.
23979 * Label will be at right of the icon (if set).
23981 * If a label was passed as argument on item creation, with function
23982 * elm_control_segment_item_add(), it will be already
23983 * displayed by the item.
23985 * @see elm_segment_control_item_label_get()
23986 * @see elm_segment_control_item_add()
23988 * @ingroup SegmentControl
23990 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
23993 * Get the icon associated to the item.
23995 * @param obj The segment control object.
23996 * @param index The index of the segment item.
23997 * @return The left side icon associated to the item at @p index.
23999 * The return value is a pointer to the icon associated to the item when
24000 * it was created, with function elm_segment_control_item_add(), or later
24001 * with function elm_segment_control_item_icon_set(). If no icon
24002 * was passed as argument, it will return @c NULL.
24004 * @see elm_segment_control_item_add()
24005 * @see elm_segment_control_item_icon_set()
24007 * @ingroup SegmentControl
24009 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24012 * Set the icon associated to the item.
24014 * @param it The segment control item.
24015 * @param icon The icon object to associate with @p it.
24017 * The icon object to use at left side of the item. An
24018 * icon can be any Evas object, but usually it is an icon created
24019 * with elm_icon_add().
24021 * Once the icon object is set, a previously set one will be deleted.
24022 * @warning Setting the same icon for two items will cause the icon to
24023 * dissapear from the first item.
24025 * If an icon was passed as argument on item creation, with function
24026 * elm_segment_control_item_add(), it will be already
24027 * associated to the item.
24029 * @see elm_segment_control_item_add()
24030 * @see elm_segment_control_item_icon_get()
24032 * @ingroup SegmentControl
24034 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24037 * Get the index of an item.
24039 * @param it The segment control item.
24040 * @return The position of item in segment control widget.
24042 * Index is the position of an item in segment control widget. Its
24043 * range is from @c 0 to <tt> count - 1 </tt>.
24044 * Count is the number of items, that can be get with
24045 * elm_segment_control_item_count_get().
24047 * @ingroup SegmentControl
24049 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24052 * Get the base object of the item.
24054 * @param it The segment control item.
24055 * @return The base object associated with @p it.
24057 * Base object is the @c Evas_Object that represents that item.
24059 * @ingroup SegmentControl
24061 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24064 * Get the selected item.
24066 * @param obj The segment control object.
24067 * @return The selected item or @c NULL if none of segment items is
24070 * The selected item can be unselected with function
24071 * elm_segment_control_item_selected_set().
24073 * The selected item always will be highlighted on segment control.
24075 * @ingroup SegmentControl
24077 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24080 * Set the selected state of an item.
24082 * @param it The segment control item
24083 * @param select The selected state
24085 * This sets the selected state of the given item @p it.
24086 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24088 * If a new item is selected the previosly selected will be unselected.
24089 * Previoulsy selected item can be get with function
24090 * elm_segment_control_item_selected_get().
24092 * The selected item always will be highlighted on segment control.
24094 * @see elm_segment_control_item_selected_get()
24096 * @ingroup SegmentControl
24098 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
24105 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
24106 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
24107 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
24108 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
24109 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
24110 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
24111 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
24112 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
24114 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
24115 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
24117 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
24118 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
24119 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
24120 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
24121 EAPI void elm_video_play(Evas_Object *video);
24122 EAPI void elm_video_pause(Evas_Object *video);
24123 EAPI void elm_video_stop(Evas_Object *video);
24124 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
24125 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
24126 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
24127 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
24128 EAPI double elm_video_audio_level_get(Evas_Object *video);
24129 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
24130 EAPI double elm_video_play_position_get(Evas_Object *video);
24131 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
24132 EAPI double elm_video_play_length_get(Evas_Object *video);
24133 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
24134 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
24135 EAPI const char *elm_video_title_get(Evas_Object *video);
24137 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
24138 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
24143 ELM_NAVIFRAME_PREV_BUTTON,
24144 ELM_NAVIFRAME_NEXT_BUTTON
24145 } Elm_Naviframe_Button_Type;
24147 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24148 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);
24149 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
24150 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
24151 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24152 EAPI void elm_naviframe_item_content_set(Elm_Object_Item *item, Evas_Object *content) EINA_ARG_NONNULL(1);
24153 EAPI Evas_Object *elm_naviframe_item_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24154 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24155 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24156 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24157 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24158 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24159 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24160 EAPI void elm_naviframe_item_button_set(Elm_Object_Item *it, Evas_Object *btn, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
24161 EAPI Evas_Object *elm_naviframe_item_button_get(const Elm_Object_Item *it, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
24162 EAPI void elm_naviframe_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24163 EAPI Evas_Object *elm_naviframe_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24164 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
24165 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24166 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
24167 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);