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 License: LGPL v2 (see COPYING in the base of Elementary's source). This
26 applies to all files in the source here.
28 Acknowledgements: There is a lot that goes into making a widget set, and
29 they don't happen out of nothing. It's like trying to make everyone
30 everywhere happy, regardless of age, gender, race or nationality - and
31 that is really tough. So thanks to people and organisations behind this,
32 as listed in the @ref authors page.
41 @author Carsten Haitzler <raster@@rasterman.com>
42 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
43 @author Cedric Bail <cedric.bail@@free.fr>
44 @author Vincent Torri <vtorri@@univ-evry.fr>
45 @author Daniel Kolesa <quaker66@@gmail.com>
46 @author Jaime Thomas <avi.thomas@@gmail.com>
47 @author Swisscom - http://www.swisscom.ch/
48 @author Christopher Michael <devilhorns@@comcast.net>
49 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
50 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
51 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
52 @author Brian Wang <brian.wang.0721@@gmail.com>
53 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
54 @author Samsung Electronics <tbd>
55 @author Samsung SAIT <tbd>
56 @author Brett Nash <nash@@nash.id.au>
57 @author Bruno Dilly <bdilly@@profusion.mobi>
58 @author Rafael Fonseca <rfonseca@@profusion.mobi>
59 @author Chuneon Park <hermet@@hermet.pe.kr>
60 @author Woohyun Jung <wh0705.jung@@samsung.com>
61 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
62 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
63 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
64 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
65 @author Gustavo Lima Chaves <glima@@profusion.mobi>
66 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
67 @author Tiago Falcão <tiago@@profusion.mobi>
68 @author Otavio Pontes <otavio@@profusion.mobi>
69 @author Viktor Kojouharov <vkojouharov@@gmail.com>
70 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
71 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
72 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
73 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
74 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
75 @author Jihoon Kim <jihoon48.kim@@samsung.com>
76 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
77 @author Tom Hacohen <tom@@stosb.com>
78 @author Aharon Hillel <a.hillel@@partner.samsung.com>
79 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
80 @author Shinwoo Kim <kimcinoo@@gmail.com>
81 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
82 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
84 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
85 contact with the developers and maintainers.
93 * @brief Elementary's API
98 @ELM_UNIX_DEF@ ELM_UNIX
99 @ELM_WIN32_DEF@ ELM_WIN32
100 @ELM_WINCE_DEF@ ELM_WINCE
101 @ELM_EDBUS_DEF@ ELM_EDBUS
102 @ELM_EFREET_DEF@ ELM_EFREET
103 @ELM_ETHUMB_DEF@ ELM_ETHUMB
104 @ELM_EMAP_DEF@ ELM_EMAP
105 @ELM_DEBUG_DEF@ ELM_DEBUG
106 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
107 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
109 /* Standard headers for standard system calls etc. */
114 #include <sys/types.h>
115 #include <sys/stat.h>
116 #include <sys/time.h>
117 #include <sys/param.h>
130 # ifdef ELM_LIBINTL_H
131 # include <libintl.h>
142 #if defined (ELM_WIN32) || defined (ELM_WINCE)
145 # define alloca _alloca
156 #include <Ecore_Evas.h>
157 #include <Ecore_File.h>
158 #include <Ecore_IMF.h>
159 #include <Ecore_Con.h>
168 # include <Efreet_Mime.h>
169 # include <Efreet_Trash.h>
173 # include <Ethumb_Client.h>
185 # ifdef ELEMENTARY_BUILD
187 # define EAPI __declspec(dllexport)
190 # endif /* ! DLL_EXPORT */
192 # define EAPI __declspec(dllimport)
193 # endif /* ! EFL_EVAS_BUILD */
197 # define EAPI __attribute__ ((visibility("default")))
204 #endif /* ! _WIN32 */
207 /* allow usage from c++ */
212 #define ELM_VERSION_MAJOR @VMAJ@
213 #define ELM_VERSION_MINOR @VMIN@
215 typedef struct _Elm_Version
223 EAPI extern Elm_Version *elm_version;
226 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
227 #define ELM_PI 3.14159265358979323846
230 * @defgroup General General
232 * @brief General Elementary API. Functions that don't relate to
233 * Elementary objects specifically.
235 * Here are documented functions which init/shutdown the library,
236 * that apply to generic Elementary objects, that deal with
237 * configuration, et cetera.
239 * @ref general_functions_example_page "This" example contemplates
240 * some of these functions.
244 * @addtogroup General
249 * Defines couple of standard Evas_Object layers to be used
250 * with evas_object_layer_set().
252 * @note whenever extending with new values, try to keep some padding
253 * to siblings so there is room for further extensions.
255 typedef enum _Elm_Object_Layer
257 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
258 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
259 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
260 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
261 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
262 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
265 /**************************************************************************/
266 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
269 * Emitted when any Elementary's policy value is changed.
271 EAPI extern int ELM_EVENT_POLICY_CHANGED;
274 * @typedef Elm_Event_Policy_Changed
276 * Data on the event when an Elementary policy has changed
278 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
281 * @struct _Elm_Event_Policy_Changed
283 * Data on the event when an Elementary policy has changed
285 struct _Elm_Event_Policy_Changed
287 unsigned int policy; /**< the policy identifier */
288 int new_value; /**< value the policy had before the change */
289 int old_value; /**< new value the policy got */
293 * Policy identifiers.
295 typedef enum _Elm_Policy
297 ELM_POLICY_QUIT, /**< under which circunstances the application
298 * should quit automatically. @see
302 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
305 typedef enum _Elm_Policy_Quit
307 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
309 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
311 * window is closed */
312 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
314 typedef enum _Elm_Focus_Direction
318 } Elm_Focus_Direction;
320 typedef enum _Elm_Text_Format
322 ELM_TEXT_FORMAT_PLAIN_UTF8,
323 ELM_TEXT_FORMAT_MARKUP_UTF8
327 * Line wrapping types.
329 typedef enum _Elm_Wrap_Type
331 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
332 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
333 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
334 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
339 * @typedef Elm_Object_Item
340 * An Elementary Object item handle.
343 typedef struct _Elm_Widget_Item Elm_Object_Item;
346 * Called back when a widget's tooltip is activated and needs content.
347 * @param data user-data given to elm_object_tooltip_content_cb_set()
348 * @param obj owner widget.
349 * @param tooltip The tooltip object (affix content to this!)
351 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
354 * Called back when a widget's item tooltip is activated and needs content.
355 * @param data user-data given to elm_object_tooltip_content_cb_set()
356 * @param obj owner widget.
357 * @param tooltip The tooltip object (affix content to this!)
358 * @param item context dependent item. As an example, if tooltip was
359 * set on Elm_List_Item, then it is of this type.
361 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
363 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
365 #ifndef ELM_LIB_QUICKLAUNCH
366 #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 */
368 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
371 /**************************************************************************/
375 * Initialize Elementary
377 * @param[in] argc System's argument count value
378 * @param[in] argv System's pointer to array of argument strings
379 * @return The init counter value.
381 * This function initializes Elementary and increments a counter of
382 * the number of calls to it. It returs the new counter's value.
384 * @warning This call is exported only for use by the @c ELM_MAIN()
385 * macro. There is no need to use this if you use this macro (which
386 * is highly advisable). An elm_main() should contain the entry
387 * point code for your application, having the same prototype as
388 * elm_init(), and @b not being static (putting the @c EAPI symbol
389 * in front of its type declaration is advisable). The @c
390 * ELM_MAIN() call should be placed just after it.
393 * @dontinclude bg_example_01.c
397 * See the full @ref bg_example_01_c "example".
399 * @see elm_shutdown().
402 EAPI int elm_init(int argc, char **argv);
405 * Shut down Elementary
407 * @return The init counter value.
409 * This should be called at the end of your application, just
410 * before it ceases to do any more processing. This will clean up
411 * any permanent resources your application may have allocated via
412 * Elementary that would otherwise persist.
414 * @see elm_init() for an example
418 EAPI int elm_shutdown(void);
421 * Run Elementary's main loop
423 * This call should be issued just after all initialization is
424 * completed. This function will not return until elm_exit() is
425 * called. It will keep looping, running the main
426 * (event/processing) loop for Elementary.
428 * @see elm_init() for an example
432 EAPI void elm_run(void);
435 * Exit Elementary's main loop
437 * If this call is issued, it will flag the main loop to cease
438 * processing and return back to its parent function (usually your
439 * elm_main() function).
441 * @see elm_init() for an example. There, just after a request to
442 * close the window comes, the main loop will be left.
444 * @note By using the #ELM_POLICY_QUIT on your Elementary
445 * applications, you'll this function called automatically for you.
449 EAPI void elm_exit(void);
452 * Provide information in order to make Elementary determine the @b
453 * run time location of the software in question, so other data files
454 * such as images, sound files, executable utilities, libraries,
455 * modules and locale files can be found.
457 * @param mainfunc This is your application's main function name,
458 * whose binary's location is to be found. Providing @c NULL
459 * will make Elementary not to use it
460 * @param dom This will be used as the application's "domain", in the
461 * form of a prefix to any environment variables that may
462 * override prefix detection and the directory name, inside the
463 * standard share or data directories, where the software's
464 * data files will be looked for.
465 * @param checkfile This is an (optional) magic file's path to check
466 * for existence (and it must be located in the data directory,
467 * under the share directory provided above). Its presence will
468 * help determine the prefix found was correct. Pass @c NULL if
469 * the check is not to be done.
471 * This function allows one to re-locate the application somewhere
472 * else after compilation, if the developer wishes for easier
473 * distribution of pre-compiled binaries.
475 * The prefix system is designed to locate where the given software is
476 * installed (under a common path prefix) at run time and then report
477 * specific locations of this prefix and common directories inside
478 * this prefix like the binary, library, data and locale directories,
479 * through the @c elm_app_*_get() family of functions.
481 * Call elm_app_info_set() early on before you change working
482 * directory or anything about @c argv[0], so it gets accurate
485 * It will then try and trace back which file @p mainfunc comes from,
486 * if provided, to determine the application's prefix directory.
488 * The @p dom parameter provides a string prefix to prepend before
489 * environment variables, allowing a fallback to @b specific
490 * environment variables to locate the software. You would most
491 * probably provide a lowercase string there, because it will also
492 * serve as directory domain, explained next. For environment
493 * variables purposes, this string is made uppercase. For example if
494 * @c "myapp" is provided as the prefix, then the program would expect
495 * @c "MYAPP_PREFIX" as a master environment variable to specify the
496 * exact install prefix for the software, or more specific environment
497 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
498 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
499 * the user or scripts before launching. If not provided (@c NULL),
500 * environment variables will not be used to override compiled-in
501 * defaults or auto detections.
503 * The @p dom string also provides a subdirectory inside the system
504 * shared data directory for data files. For example, if the system
505 * directory is @c /usr/local/share, then this directory name is
506 * appended, creating @c /usr/local/share/myapp, if it @p was @c
507 * "myapp". It is expected the application installs data files in
510 * The @p checkfile is a file name or path of something inside the
511 * share or data directory to be used to test that the prefix
512 * detection worked. For example, your app will install a wallpaper
513 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
514 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
517 * @see elm_app_compile_bin_dir_set()
518 * @see elm_app_compile_lib_dir_set()
519 * @see elm_app_compile_data_dir_set()
520 * @see elm_app_compile_locale_set()
521 * @see elm_app_prefix_dir_get()
522 * @see elm_app_bin_dir_get()
523 * @see elm_app_lib_dir_get()
524 * @see elm_app_data_dir_get()
525 * @see elm_app_locale_dir_get()
527 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
530 * Provide information on the @b fallback application's binaries
531 * directory, on scenarios where they get overriden by
532 * elm_app_info_set().
534 * @param dir The path to the default binaries directory (compile time
537 * @note Elementary will as well use this path to determine actual
538 * names of binaries' directory paths, maybe changing it to be @c
539 * something/local/bin instead of @c something/bin, only, for
542 * @warning You should call this function @b before
543 * elm_app_info_set().
545 EAPI void elm_app_compile_bin_dir_set(const char *dir);
548 * Provide information on the @b fallback application's libraries
549 * directory, on scenarios where they get overriden by
550 * elm_app_info_set().
552 * @param dir The path to the default libraries directory (compile
555 * @note Elementary will as well use this path to determine actual
556 * names of libraries' directory paths, maybe changing it to be @c
557 * something/lib32 or @c something/lib64 instead of @c something/lib,
560 * @warning You should call this function @b before
561 * elm_app_info_set().
563 EAPI void elm_app_compile_lib_dir_set(const char *dir);
566 * Provide information on the @b fallback application's data
567 * directory, on scenarios where they get overriden by
568 * elm_app_info_set().
570 * @param dir The path to the default data directory (compile time
573 * @note Elementary will as well use this path to determine actual
574 * names of data directory paths, maybe changing it to be @c
575 * something/local/share instead of @c something/share, only, for
578 * @warning You should call this function @b before
579 * elm_app_info_set().
581 EAPI void elm_app_compile_data_dir_set(const char *dir);
584 * Provide information on the @b fallback application's locale
585 * directory, on scenarios where they get overriden by
586 * elm_app_info_set().
588 * @param dir The path to the default locale directory (compile time
591 * @warning You should call this function @b before
592 * elm_app_info_set().
594 EAPI void elm_app_compile_locale_set(const char *dir);
597 * Retrieve the application's run time prefix directory, as set by
598 * elm_app_info_set() and the way (environment) the application was
601 * @return The directory prefix the application is actually using
603 EAPI const char *elm_app_prefix_dir_get(void);
606 * Retrieve the application's run time binaries prefix directory, as
607 * set by elm_app_info_set() and the way (environment) the application
610 * @return The binaries directory prefix the application is actually
613 EAPI const char *elm_app_bin_dir_get(void);
616 * Retrieve the application's run time libraries prefix directory, as
617 * set by elm_app_info_set() and the way (environment) the application
620 * @return The libraries directory prefix the application is actually
623 EAPI const char *elm_app_lib_dir_get(void);
626 * Retrieve the application's run time data prefix directory, as
627 * set by elm_app_info_set() and the way (environment) the application
630 * @return The data directory prefix the application is actually
633 EAPI const char *elm_app_data_dir_get(void);
636 * Retrieve the application's run time locale prefix directory, as
637 * set by elm_app_info_set() and the way (environment) the application
640 * @return The locale directory prefix the application is actually
643 EAPI const char *elm_app_locale_dir_get(void);
645 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
646 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
647 EAPI int elm_quicklaunch_init(int argc, char **argv);
648 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
649 EAPI int elm_quicklaunch_sub_shutdown(void);
650 EAPI int elm_quicklaunch_shutdown(void);
651 EAPI void elm_quicklaunch_seed(void);
652 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
653 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
654 EAPI void elm_quicklaunch_cleanup(void);
655 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
656 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
658 EAPI Eina_Bool elm_need_efreet(void);
659 EAPI Eina_Bool elm_need_e_dbus(void);
660 EAPI Eina_Bool elm_need_ethumb(void);
663 * Set a new policy's value (for a given policy group/identifier).
665 * @param policy policy identifier, as in @ref Elm_Policy.
666 * @param value policy value, which depends on the identifier
668 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
670 * Elementary policies define applications' behavior,
671 * somehow. These behaviors are divided in policy groups (see
672 * #Elm_Policy enumeration). This call will emit the Ecore event
673 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
674 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
677 * @note Currently, we have only one policy identifier/group
678 * (#ELM_POLICY_QUIT), which has two possible values.
682 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
685 * Gets the policy value set for given policy identifier.
687 * @param policy policy identifier, as in #Elm_Policy.
688 * @return The currently set policy value, for that
689 * identifier. Will be @c 0 if @p policy passed is invalid.
693 EAPI int elm_policy_get(unsigned int policy);
696 * Set a label of an object
698 * @param obj The Elementary object
699 * @param part The text part name to set (NULL for the default label)
700 * @param label The new text of the label
702 * @note Elementary objects may have many labels (e.g. Action Slider)
706 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
708 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
711 * Get a label of an object
713 * @param obj The Elementary object
714 * @param part The text part name to get (NULL for the default label)
715 * @return text of the label or NULL for any error
717 * @note Elementary objects may have many labels (e.g. Action Slider)
721 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
723 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
726 * Set a content of an object
728 * @param obj The Elementary object
729 * @param part The content part name to set (NULL for the default content)
730 * @param content The new content of the object
732 * @note Elementary objects may have many contents
736 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
738 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
741 * Get a content of an object
743 * @param obj The Elementary object
744 * @param item The content part name to get (NULL for the default content)
745 * @return content of the object or NULL for any error
747 * @note Elementary objects may have many contents
751 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
753 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
756 * Unset a content of an object
758 * @param obj The Elementary object
759 * @param item The content part name to unset (NULL for the default content)
761 * @note Elementary objects may have many contents
765 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
767 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
770 * Set a content of an object item
772 * @param it The Elementary object item
773 * @param part The content part name to unset (NULL for the default content)
774 * @param content The new content of the object item
776 * @note Elementary object items may have many contents
780 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
782 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
785 * Get a content of an object item
787 * @param it The Elementary object item
788 * @param part The content part name to unset (NULL for the default content)
789 * @return content of the object item or NULL for any error
791 * @note Elementary object items may have many contents
795 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
797 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
800 * Unset a content of an object item
802 * @param it The Elementary object item
803 * @param part The content part name to unset (NULL for the default content)
805 * @note Elementary object items may have many contents
809 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
811 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
814 * Set a label of an objec itemt
816 * @param it The Elementary object item
817 * @param part The text part name to set (NULL for the default label)
818 * @param label The new text of the label
820 * @note Elementary object items may have many labels
824 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
826 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
829 * Get a label of an object
831 * @param it The Elementary object item
832 * @param part The text part name to get (NULL for the default label)
833 * @return text of the label or NULL for any error
835 * @note Elementary object items may have many labels
839 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
841 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
847 EAPI void elm_all_flush(void);
848 EAPI int elm_cache_flush_interval_get(void);
849 EAPI void elm_cache_flush_interval_set(int size);
850 EAPI void elm_cache_flush_interval_all_set(int size);
851 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
852 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
853 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
854 EAPI int elm_font_cache_get(void);
855 EAPI void elm_font_cache_set(int size);
856 EAPI void elm_font_cache_all_set(int size);
857 EAPI int elm_image_cache_get(void);
858 EAPI void elm_image_cache_set(int size);
859 EAPI void elm_image_cache_all_set(int size);
860 EAPI int elm_edje_file_cache_get(void);
861 EAPI void elm_edje_file_cache_set(int size);
862 EAPI void elm_edje_file_cache_all_set(int size);
863 EAPI int elm_edje_collection_cache_get(void);
864 EAPI void elm_edje_collection_cache_set(int size);
865 EAPI void elm_edje_collection_cache_all_set(int size);
868 * @defgroup Scaling Selective Widget Scaling
870 * Different widgets can be scaled independently. These functions
871 * allow you to manipulate this scaling on a per-widget basis. The
872 * object and all its children get their scaling factors multiplied
873 * by the scale factor set. This is multiplicative, in that if a
874 * child also has a scale size set it is in turn multiplied by its
875 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
876 * double size, @c 0.5 is half, etc.
878 * @ref general_functions_example_page "This" example contemplates
879 * some of these functions.
883 * Set the scaling factor for a given Elementary object
885 * @param obj The Elementary to operate on
886 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
891 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
894 * Get the scaling factor for a given Elementary object
896 * @param obj The object
897 * @return The scaling factor set by elm_object_scale_set()
901 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
902 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
903 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
904 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
905 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
907 * Set the style to use by a widget
909 * Sets the style name that will define the appearance of a widget. Styles
910 * vary from widget to widget and may also be defined by other themes
911 * by means of extensions and overlays.
913 * @param obj The Elementary widget to style
914 * @param style The style name to use
916 * @see elm_theme_extension_add()
917 * @see elm_theme_overlay_add()
921 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
923 * Get the style used by the widget
925 * This gets the style being used for that widget. Note that the string
926 * pointer is only valid as longas the object is valid and the style doesn't
929 * @param obj The Elementary widget to query for its style
930 * @return The style name used
932 * @see elm_object_style_set()
936 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
939 * @defgroup Styles Styles
941 * Widgets can have different styles of look. These generic API's
942 * set styles of widgets, if they support them (and if the theme(s)
945 * @ref general_functions_example_page "This" example contemplates
946 * some of these functions.
950 * Set the disabled state of an Elementary object.
952 * @param obj The Elementary object to operate on
953 * @param disabled The state to put in in: @c EINA_TRUE for
954 * disabled, @c EINA_FALSE for enabled
956 * Elementary objects can be @b disabled, in which state they won't
957 * receive input and, in general, will be themed differently from
958 * their normal state, usually greyed out. Useful for contexts
959 * where you don't want your users to interact with some of the
960 * parts of you interface.
962 * This sets the state for the widget, either disabling it or
967 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
970 * Get the disabled state of an Elementary object.
972 * @param obj The Elementary object to operate on
973 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
974 * if it's enabled (or on errors)
976 * This gets the state of the widget, which might be enabled or disabled.
980 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
983 * @defgroup WidgetNavigation Widget Tree Navigation.
985 * How to check if an Evas Object is an Elementary widget? How to
986 * get the first elementary widget that is parent of the given
987 * object? These are all covered in widget tree navigation.
989 * @ref general_functions_example_page "This" example contemplates
990 * some of these functions.
993 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
996 * Get the first parent of the given object that is an Elementary
999 * @param obj the Elementary object to query parent from.
1000 * @return the parent object that is an Elementary widget, or @c
1001 * NULL, if it was not found.
1003 * Use this to query for an object's parent widget.
1005 * @note Most of Elementary users wouldn't be mixing non-Elementary
1006 * smart objects in the objects tree of an application, as this is
1007 * an advanced usage of Elementary with Evas. So, except for the
1008 * application's window, which is the root of that tree, all other
1009 * objects would have valid Elementary widget parents.
1011 * @ingroup WidgetNavigation
1013 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1014 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1015 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1017 EAPI double elm_scale_get(void);
1018 EAPI void elm_scale_set(double scale);
1019 EAPI void elm_scale_all_set(double scale);
1021 EAPI Eina_Bool elm_mirrored_get(void);
1022 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1024 EAPI Eina_Bool elm_config_save(void);
1025 EAPI void elm_config_reload(void);
1027 EAPI const char *elm_profile_current_get(void);
1028 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1029 EAPI void elm_profile_dir_free(const char *p_dir);
1030 EAPI Eina_List *elm_profile_list_get(void);
1031 EAPI void elm_profile_list_free(Eina_List *l);
1032 EAPI void elm_profile_set(const char *profile);
1033 EAPI void elm_profile_all_set(const char *profile);
1035 EAPI const char *elm_engine_current_get(void);
1036 EAPI void elm_engine_set(const char *engine);
1038 typedef struct _Elm_Text_Class
1044 typedef struct _Elm_Font_Overlay
1046 const char *text_class;
1048 Evas_Font_Size size;
1051 typedef struct _Elm_Font_Properties
1055 } Elm_Font_Properties;
1057 EAPI const Eina_List *elm_text_classes_list_get(void);
1058 EAPI void elm_text_classes_list_free(const Eina_List *list);
1060 EAPI const Eina_List *elm_font_overlay_list_get(void);
1061 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1062 EAPI void elm_font_overlay_unset(const char *text_class);
1063 EAPI void elm_font_overlay_apply(void);
1064 EAPI void elm_font_overlay_all_apply(void);
1066 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1067 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1068 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1069 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1070 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1071 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1074 * @defgroup Fingers Fingers
1076 * Elementary is designed to be finger-friendly for touchscreens,
1077 * and so in addition to scaling for display resolution, it can
1078 * also scale based on finger "resolution" (or size). You can then
1079 * customize the granularity of the areas meant to receive clicks
1082 * Different profiles may have pre-set values for finger sizes.
1084 * @ref general_functions_example_page "This" example contemplates
1085 * some of these functions.
1089 * Get the configured "finger size"
1091 * @return The finger size
1093 * This gets the globally configured finger size, <b>in pixels</b>
1097 EAPI Evas_Coord elm_finger_size_get(void);
1098 EAPI void elm_finger_size_set(Evas_Coord size);
1099 EAPI void elm_finger_size_all_set(Evas_Coord size);
1102 * @defgroup Focus Focus
1104 * An Elementary application has, at all times, one (and only one)
1105 * @b focused object. This is what determines where the input
1106 * events go to within the application's window. Also, focused
1107 * objects can be decorated differently, in order to signal to the
1108 * user where the input is, at a given moment.
1110 * Elementary applications also have the concept of <b>focus
1111 * chain</b>: one can cycle through all the windows' focusable
1112 * objects by input (tab key) or programmatically. The default
1113 * focus chain for an application is the one define by the order in
1114 * which the widgets where added in code. One will cycle through
1115 * top level widgets, and, for each one containg sub-objects, cycle
1116 * through them all, before returning to the level
1117 * above. Elementary also allows one to set @b custom focus chains
1118 * for their applications.
1120 * Besides the focused decoration a widget may exhibit, when it
1121 * gets focus, Elementary has a @b global focus highlight object
1122 * that can be enabled for a window. If one chooses to do so, this
1123 * extra highlight effect will surround the current focused object,
1126 * @note Some Elementary widgets are @b unfocusable, after
1127 * creation, by their very nature: they are not meant to be
1128 * interacted with input events, but are there just for visual
1131 * @ref general_functions_example_page "This" example contemplates
1132 * some of these functions.
1135 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1136 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1137 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1138 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1141 * Get the whether an Elementary object has the focus or not.
1143 * @param obj The Elementary object to get the information from
1144 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1145 * not (and on errors).
1147 * @see elm_object_focus()
1151 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1154 * Set/unset focus to a given Elementary object.
1156 * @param obj The Elementary object to operate on.
1157 * @param enable @c EINA_TRUE Set focus to a given object,
1158 * @c EINA_FALSE Unset focus to a given object.
1160 * @note When you set focus to this object, if it can handle focus, will
1161 * take the focus away from the one who had it previously and will, for
1162 * now on, be the one receiving input events. Unsetting focus will remove
1163 * the focus from @p obj, passing it back to the previous element in the
1166 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
1170 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
1173 * Make a given Elementary object the focused one.
1175 * @param obj The Elementary object to make focused.
1177 * @note This object, if it can handle focus, will take the focus
1178 * away from the one who had it previously and will, for now on, be
1179 * the one receiving input events.
1181 * @see elm_object_focus_get()
1182 * @deprecated use elm_object_focus_set() instead.
1186 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1189 * Remove the focus from an Elementary object
1191 * @param obj The Elementary to take focus from
1193 * This removes the focus from @p obj, passing it back to the
1194 * previous element in the focus chain list.
1196 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1197 * @deprecated use elm_object_focus_set() instead.
1201 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1204 * Set the ability for an Element object to be focused
1206 * @param obj The Elementary object to operate on
1207 * @param enable @c EINA_TRUE if the object can be focused, @c
1208 * EINA_FALSE if not (and on errors)
1210 * This sets whether the object @p obj is able to take focus or
1211 * not. Unfocusable objects do nothing when programmatically
1212 * focused, being the nearest focusable parent object the one
1213 * really getting focus. Also, when they receive mouse input, they
1214 * will get the event, but not take away the focus from where it
1219 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1222 * Get whether an Elementary object is focusable or not
1224 * @param obj The Elementary object to operate on
1225 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1226 * EINA_FALSE if not (and on errors)
1228 * @note Objects which are meant to be interacted with by input
1229 * events are created able to be focused, by default. All the
1234 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1236 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1237 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1238 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1239 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1240 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1241 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1242 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1245 * Make the elementary object and its children to be unfocusable (or focusable).
1247 * @param obj The Elementary object to operate on
1248 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1249 * @c EINA_FALSE for focusable.
1251 * This sets whether the object @p obj and its children objects
1252 * are able to take focus or not. If the tree is set as unfocusable,
1253 * newest focused object which is not in this tree will get focus.
1254 * This API can be helpful for an object to be deleted.
1255 * When an object will be deleted soon, it and its children may not
1256 * want to get focus (by focus reverting or by other focus controls).
1257 * Then, just use this API before deleting.
1259 * @see elm_object_tree_unfocusable_get()
1263 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1266 * Get whether an Elementary object and its children are unfocusable or not.
1268 * @param obj The Elementary object to get the information from
1269 * @return @c EINA_TRUE, if the tree is unfocussable,
1270 * @c EINA_FALSE if not (and on errors).
1272 * @see elm_object_tree_unfocusable_set()
1276 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1278 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1279 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1280 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1281 EAPI double elm_scroll_bounce_friction_get(void);
1282 EAPI void elm_scroll_bounce_friction_set(double friction);
1283 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1284 EAPI double elm_scroll_page_scroll_friction_get(void);
1285 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1286 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1287 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1288 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1289 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1290 EAPI double elm_scroll_zoom_friction_get(void);
1291 EAPI void elm_scroll_zoom_friction_set(double friction);
1292 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1293 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1294 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1295 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1296 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1297 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1298 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1299 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1300 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1301 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1302 EAPI double elm_scroll_thumbscroll_friction_get(void);
1303 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1304 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1305 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1306 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1307 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1309 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1310 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1311 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1312 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1313 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1314 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1315 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1316 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1318 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1319 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);
1320 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);
1322 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1323 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1326 * Adjust size of an element for finger usage.
1328 * @param times_w How many fingers should fit horizontally
1329 * @param w Pointer to the width size to adjust
1330 * @param times_h How many fingers should fit vertically
1331 * @param h Pointer to the height size to adjust
1333 * This takes width and height sizes (in pixels) as input and a
1334 * size multiple (which is how many fingers you want to place
1335 * within the area, being "finger" the size set by
1336 * elm_finger_size_set()), and adjusts the size to be large enough
1337 * to accommodate the resulting size -- if it doesn't already
1338 * accommodate it. On return the @p w and @p h sizes pointed to by
1339 * these parameters will be modified, on those conditions.
1341 * @note This is kind of a low level Elementary call, most useful
1342 * on size evaluation times for widgets. An external user wouldn't
1343 * be calling, most of the time.
1347 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1349 EAPI double elm_longpress_timeout_get(void);
1350 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1353 * don't use it unless you are sure
1355 EAPI void elm_object_tree_dump(const Evas_Object *top);
1356 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1361 * @defgroup Theme Theme
1363 * Elementary uses Edje to theme its widgets, naturally. But for the most
1364 * part this is hidden behind a simpler interface that lets the user set
1365 * extensions and choose the style of widgets in a much easier way.
1367 * Instead of thinking in terms of paths to Edje files and their groups
1368 * each time you want to change the appearance of a widget, Elementary
1369 * works so you can add any theme file with extensions or replace the
1370 * main theme at one point in the application, and then just set the style
1371 * of widgets with elm_object_style_set() and related functions. Elementary
1372 * will then look in its list of themes for a matching group and apply it,
1373 * and when the theme changes midway through the application, all widgets
1374 * will be updated accordingly.
1376 * There are three concepts you need to know to understand how Elementary
1377 * theming works: default theme, extensions and overlays.
1379 * Default theme, obviously enough, is the one that provides the default
1380 * look of all widgets. End users can change the theme used by Elementary
1381 * by setting the @c ELM_THEME environment variable before running an
1382 * application, or globally for all programs using the @c elementary_config
1383 * utility. Applications can change the default theme using elm_theme_set(),
1384 * but this can go against the user wishes, so it's not an adviced practice.
1386 * Ideally, applications should find everything they need in the already
1387 * provided theme, but there may be occasions when that's not enough and
1388 * custom styles are required to correctly express the idea. For this
1389 * cases, Elementary has extensions.
1391 * Extensions allow the application developer to write styles of its own
1392 * to apply to some widgets. This requires knowledge of how each widget
1393 * is themed, as extensions will always replace the entire group used by
1394 * the widget, so important signals and parts need to be there for the
1395 * object to behave properly (see documentation of Edje for details).
1396 * Once the theme for the extension is done, the application needs to add
1397 * it to the list of themes Elementary will look into, using
1398 * elm_theme_extension_add(), and set the style of the desired widgets as
1399 * he would normally with elm_object_style_set().
1401 * Overlays, on the other hand, can replace the look of all widgets by
1402 * overriding the default style. Like extensions, it's up to the application
1403 * developer to write the theme for the widgets it wants, the difference
1404 * being that when looking for the theme, Elementary will check first the
1405 * list of overlays, then the set theme and lastly the list of extensions,
1406 * so with overlays it's possible to replace the default view and every
1407 * widget will be affected. This is very much alike to setting the whole
1408 * theme for the application and will probably clash with the end user
1409 * options, not to mention the risk of ending up with not matching styles
1410 * across the program. Unless there's a very special reason to use them,
1411 * overlays should be avoided for the resons exposed before.
1413 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1414 * keeps one default internally and every function that receives one of
1415 * these can be called with NULL to refer to this default (except for
1416 * elm_theme_free()). It's possible to create a new instance of a
1417 * ::Elm_Theme to set other theme for a specific widget (and all of its
1418 * children), but this is as discouraged, if not even more so, than using
1419 * overlays. Don't use this unless you really know what you are doing.
1421 * But to be less negative about things, you can look at the following
1423 * @li @ref theme_example_01 "Using extensions"
1424 * @li @ref theme_example_02 "Using overlays"
1429 * @typedef Elm_Theme
1431 * Opaque handler for the list of themes Elementary looks for when
1432 * rendering widgets.
1434 * Stay out of this unless you really know what you are doing. For most
1435 * cases, sticking to the default is all a developer needs.
1437 typedef struct _Elm_Theme Elm_Theme;
1440 * Create a new specific theme
1442 * This creates an empty specific theme that only uses the default theme. A
1443 * specific theme has its own private set of extensions and overlays too
1444 * (which are empty by default). Specific themes do not fall back to themes
1445 * of parent objects. They are not intended for this use. Use styles, overlays
1446 * and extensions when needed, but avoid specific themes unless there is no
1447 * other way (example: you want to have a preview of a new theme you are
1448 * selecting in a "theme selector" window. The preview is inside a scroller
1449 * and should display what the theme you selected will look like, but not
1450 * actually apply it yet. The child of the scroller will have a specific
1451 * theme set to show this preview before the user decides to apply it to all
1454 EAPI Elm_Theme *elm_theme_new(void);
1456 * Free a specific theme
1458 * @param th The theme to free
1460 * This frees a theme created with elm_theme_new().
1462 EAPI void elm_theme_free(Elm_Theme *th);
1464 * Copy the theme fom the source to the destination theme
1466 * @param th The source theme to copy from
1467 * @param thdst The destination theme to copy data to
1469 * This makes a one-time static copy of all the theme config, extensions
1470 * and overlays from @p th to @p thdst. If @p th references a theme, then
1471 * @p thdst is also set to reference it, with all the theme settings,
1472 * overlays and extensions that @p th had.
1474 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1476 * Tell the source theme to reference the ref theme
1478 * @param th The theme that will do the referencing
1479 * @param thref The theme that is the reference source
1481 * This clears @p th to be empty and then sets it to refer to @p thref
1482 * so @p th acts as an override to @p thref, but where its overrides
1483 * don't apply, it will fall through to @p thref for configuration.
1485 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1487 * Return the theme referred to
1489 * @param th The theme to get the reference from
1490 * @return The referenced theme handle
1492 * This gets the theme set as the reference theme by elm_theme_ref_set().
1493 * If no theme is set as a reference, NULL is returned.
1495 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1497 * Return the default theme
1499 * @return The default theme handle
1501 * This returns the internal default theme setup handle that all widgets
1502 * use implicitly unless a specific theme is set. This is also often use
1503 * as a shorthand of NULL.
1505 EAPI Elm_Theme *elm_theme_default_get(void);
1507 * Prepends a theme overlay to the list of overlays
1509 * @param th The theme to add to, or if NULL, the default theme
1510 * @param item The Edje file path to be used
1512 * Use this if your application needs to provide some custom overlay theme
1513 * (An Edje file that replaces some default styles of widgets) where adding
1514 * new styles, or changing system theme configuration is not possible. Do
1515 * NOT use this instead of a proper system theme configuration. Use proper
1516 * configuration files, profiles, environment variables etc. to set a theme
1517 * so that the theme can be altered by simple confiugration by a user. Using
1518 * this call to achieve that effect is abusing the API and will create lots
1521 * @see elm_theme_extension_add()
1523 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1525 * Delete a theme overlay from the list of overlays
1527 * @param th The theme to delete from, or if NULL, the default theme
1528 * @param item The name of the theme overlay
1530 * @see elm_theme_overlay_add()
1532 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1534 * Appends a theme extension to the list of extensions.
1536 * @param th The theme to add to, or if NULL, the default theme
1537 * @param item The Edje file path to be used
1539 * This is intended when an application needs more styles of widgets or new
1540 * widget themes that the default does not provide (or may not provide). The
1541 * application has "extended" usage by coming up with new custom style names
1542 * for widgets for specific uses, but as these are not "standard", they are
1543 * not guaranteed to be provided by a default theme. This means the
1544 * application is required to provide these extra elements itself in specific
1545 * Edje files. This call adds one of those Edje files to the theme search
1546 * path to be search after the default theme. The use of this call is
1547 * encouraged when default styles do not meet the needs of the application.
1548 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1550 * @see elm_object_style_set()
1552 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1554 * Deletes a theme extension from the list of extensions.
1556 * @param th The theme to delete from, or if NULL, the default theme
1557 * @param item The name of the theme extension
1559 * @see elm_theme_extension_add()
1561 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1563 * Set the theme search order for the given theme
1565 * @param th The theme to set the search order, or if NULL, the default theme
1566 * @param theme Theme search string
1568 * This sets the search string for the theme in path-notation from first
1569 * theme to search, to last, delimited by the : character. Example:
1571 * "shiny:/path/to/file.edj:default"
1573 * See the ELM_THEME environment variable for more information.
1575 * @see elm_theme_get()
1576 * @see elm_theme_list_get()
1578 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1580 * Return the theme search order
1582 * @param th The theme to get the search order, or if NULL, the default theme
1583 * @return The internal search order path
1585 * This function returns a colon separated string of theme elements as
1586 * returned by elm_theme_list_get().
1588 * @see elm_theme_set()
1589 * @see elm_theme_list_get()
1591 EAPI const char *elm_theme_get(Elm_Theme *th);
1593 * Return a list of theme elements to be used in a theme.
1595 * @param th Theme to get the list of theme elements from.
1596 * @return The internal list of theme elements
1598 * This returns the internal list of theme elements (will only be valid as
1599 * long as the theme is not modified by elm_theme_set() or theme is not
1600 * freed by elm_theme_free(). This is a list of strings which must not be
1601 * altered as they are also internal. If @p th is NULL, then the default
1602 * theme element list is returned.
1604 * A theme element can consist of a full or relative path to a .edj file,
1605 * or a name, without extension, for a theme to be searched in the known
1606 * theme paths for Elemementary.
1608 * @see elm_theme_set()
1609 * @see elm_theme_get()
1611 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1613 * Return the full patrh for a theme element
1615 * @param f The theme element name
1616 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1617 * @return The full path to the file found.
1619 * This returns a string you should free with free() on success, NULL on
1620 * failure. This will search for the given theme element, and if it is a
1621 * full or relative path element or a simple searchable name. The returned
1622 * path is the full path to the file, if searched, and the file exists, or it
1623 * is simply the full path given in the element or a resolved path if
1624 * relative to home. The @p in_search_path boolean pointed to is set to
1625 * EINA_TRUE if the file was a searchable file andis in the search path,
1626 * and EINA_FALSE otherwise.
1628 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1630 * Flush the current theme.
1632 * @param th Theme to flush
1634 * This flushes caches that let elementary know where to find theme elements
1635 * in the given theme. If @p th is NULL, then the default theme is flushed.
1636 * Call this function if source theme data has changed in such a way as to
1637 * make any caches Elementary kept invalid.
1639 EAPI void elm_theme_flush(Elm_Theme *th);
1641 * This flushes all themes (default and specific ones).
1643 * This will flush all themes in the current application context, by calling
1644 * elm_theme_flush() on each of them.
1646 EAPI void elm_theme_full_flush(void);
1648 * Set the theme for all elementary using applications on the current display
1650 * @param theme The name of the theme to use. Format same as the ELM_THEME
1651 * environment variable.
1653 EAPI void elm_theme_all_set(const char *theme);
1655 * Return a list of theme elements in the theme search path
1657 * @return A list of strings that are the theme element names.
1659 * This lists all available theme files in the standard Elementary search path
1660 * for theme elements, and returns them in alphabetical order as theme
1661 * element names in a list of strings. Free this with
1662 * elm_theme_name_available_list_free() when you are done with the list.
1664 EAPI Eina_List *elm_theme_name_available_list_new(void);
1666 * Free the list returned by elm_theme_name_available_list_new()
1668 * This frees the list of themes returned by
1669 * elm_theme_name_available_list_new(). Once freed the list should no longer
1670 * be used. a new list mys be created.
1672 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1674 * Set a specific theme to be used for this object and its children
1676 * @param obj The object to set the theme on
1677 * @param th The theme to set
1679 * This sets a specific theme that will be used for the given object and any
1680 * child objects it has. If @p th is NULL then the theme to be used is
1681 * cleared and the object will inherit its theme from its parent (which
1682 * ultimately will use the default theme if no specific themes are set).
1684 * Use special themes with great care as this will annoy users and make
1685 * configuration difficult. Avoid any custom themes at all if it can be
1688 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1690 * Get the specific theme to be used
1692 * @param obj The object to get the specific theme from
1693 * @return The specifc theme set.
1695 * This will return a specific theme set, or NULL if no specific theme is
1696 * set on that object. It will not return inherited themes from parents, only
1697 * the specific theme set for that specific object. See elm_object_theme_set()
1698 * for more information.
1700 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1706 /** @defgroup Win Win
1708 * @image html img/widget/win/preview-00.png
1709 * @image latex img/widget/win/preview-00.eps
1711 * The window class of Elementary. Contains functions to manipulate
1712 * windows. The Evas engine used to render the window contents is specified
1713 * in the system or user elementary config files (whichever is found last),
1714 * and can be overridden with the ELM_ENGINE environment variable for
1715 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
1716 * compilation setup and modules actually installed at runtime) are (listed
1717 * in order of best supported and most likely to be complete and work to
1720 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
1721 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
1723 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
1725 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
1727 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
1729 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
1730 * rendering using SDL as the buffer)
1731 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
1732 * GDI with software)
1733 * @li "dfb", "directfb" (Rendering to a DirectFB window)
1734 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
1735 * grayscale using dedicated 8bit software engine in X11)
1736 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
1737 * X11 using 16bit software engine)
1738 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
1739 * (Windows CE rendering via GDI with 16bit software renderer)
1740 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
1741 * buffer with 16bit software renderer)
1743 * All engines use a simple string to select the engine to render, EXCEPT
1744 * the "shot" engine. This actually encodes the output of the virtual
1745 * screenshot and how long to delay in the engine string. The engine string
1746 * is encoded in the following way:
1748 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
1750 * Where options are separated by a ":" char if more than one option is
1751 * given, with delay, if provided being the first option and file the last
1752 * (order is important). The delay specifies how long to wait after the
1753 * window is shown before doing the virtual "in memory" rendering and then
1754 * save the output to the file specified by the file option (and then exit).
1755 * If no delay is given, the default is 0.5 seconds. If no file is given the
1756 * default output file is "out.png". Repeat option is for continous
1757 * capturing screenshots. Repeat range is from 1 to 999 and filename is
1758 * fixed to "out001.png" Some examples of using the shot engine:
1760 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
1761 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
1762 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
1763 * ELM_ENGINE="shot:delay=2.0" elementary_test
1764 * ELM_ENGINE="shot:" elementary_test
1766 * Signals that you can add callbacks for are:
1768 * @li "delete,request": the user requested to close the window. See
1769 * elm_win_autodel_set().
1770 * @li "focus,in": window got focus
1771 * @li "focus,out": window lost focus
1772 * @li "moved": window that holds the canvas was moved
1775 * @li @ref win_example_01
1780 * Defines the types of window that can be created
1782 * These are hints set on the window so that a running Window Manager knows
1783 * how the window should be handled and/or what kind of decorations it
1786 * Currently, only the X11 backed engines use them.
1788 typedef enum _Elm_Win_Type
1790 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
1791 window. Almost every window will be created with this
1793 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
1794 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
1795 window holding desktop icons. */
1796 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
1797 be kept on top of any other window by the Window
1799 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
1801 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
1802 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
1804 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
1805 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
1806 entry in a menubar is clicked. Typically used
1807 with elm_win_override_set(). This hint exists
1808 for completion only, as the EFL way of
1809 implementing a menu would not normally use a
1810 separate window for its contents. */
1811 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
1812 triggered by right-clicking an object. */
1813 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
1814 explanatory text that typically appear after the
1815 mouse cursor hovers over an object for a while.
1816 Typically used with elm_win_override_set() and also
1817 not very commonly used in the EFL. */
1818 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
1819 battery life or a new E-Mail received. */
1820 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
1821 usually used in the EFL. */
1822 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
1823 object being dragged across different windows, or even
1824 applications. Typically used with
1825 elm_win_override_set(). */
1826 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
1827 buffer. No actual window is created for this
1828 type, instead the window and all of its
1829 contents will be rendered to an image buffer.
1830 This allows to have children window inside a
1831 parent one just like any other object would
1832 be, and do other things like applying @c
1833 Evas_Map effects to it. This is the only type
1834 of window that requires the @c parent
1835 parameter of elm_win_add() to be a valid @c
1840 * The differents layouts that can be requested for the virtual keyboard.
1842 * When the application window is being managed by Illume, it may request
1843 * any of the following layouts for the virtual keyboard.
1845 typedef enum _Elm_Win_Keyboard_Mode
1847 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
1848 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
1849 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
1850 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
1851 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
1852 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
1853 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
1854 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
1855 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
1856 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
1857 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
1858 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
1859 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
1860 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
1861 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
1862 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
1863 } Elm_Win_Keyboard_Mode;
1866 * Available commands that can be sent to the Illume manager.
1868 * When running under an Illume session, a window may send commands to the
1869 * Illume manager to perform different actions.
1871 typedef enum _Elm_Illume_Command
1873 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
1875 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
1877 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
1879 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
1880 } Elm_Illume_Command;
1883 * Adds a window object. If this is the first window created, pass NULL as
1886 * @param parent Parent object to add the window to, or NULL
1887 * @param name The name of the window
1888 * @param type The window type, one of #Elm_Win_Type.
1890 * The @p parent paramter can be @c NULL for every window @p type except
1891 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
1892 * which the image object will be created.
1894 * @return The created object, or NULL on failure
1896 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1898 * Add @p subobj as a resize object of window @p obj.
1901 * Setting an object as a resize object of the window means that the
1902 * @p subobj child's size and position will be controlled by the window
1903 * directly. That is, the object will be resized to match the window size
1904 * and should never be moved or resized manually by the developer.
1906 * In addition, resize objects of the window control what the minimum size
1907 * of it will be, as well as whether it can or not be resized by the user.
1909 * For the end user to be able to resize a window by dragging the handles
1910 * or borders provided by the Window Manager, or using any other similar
1911 * mechanism, all of the resize objects in the window should have their
1912 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
1914 * @param obj The window object
1915 * @param subobj The resize object to add
1917 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1919 * Delete @p subobj as a resize object of window @p obj.
1921 * This function removes the object @p subobj from the resize objects of
1922 * the window @p obj. It will not delete the object itself, which will be
1923 * left unmanaged and should be deleted by the developer, manually handled
1924 * or set as child of some other container.
1926 * @param obj The window object
1927 * @param subobj The resize object to add
1929 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1931 * Set the title of the window
1933 * @param obj The window object
1934 * @param title The title to set
1936 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1938 * Get the title of the window
1940 * The returned string is an internal one and should not be freed or
1941 * modified. It will also be rendered invalid if a new title is set or if
1942 * the window is destroyed.
1944 * @param obj The window object
1947 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1949 * Set the window's autodel state.
1951 * When closing the window in any way outside of the program control, like
1952 * pressing the X button in the titlebar or using a command from the
1953 * Window Manager, a "delete,request" signal is emitted to indicate that
1954 * this event occurred and the developer can take any action, which may
1955 * include, or not, destroying the window object.
1957 * When the @p autodel parameter is set, the window will be automatically
1958 * destroyed when this event occurs, after the signal is emitted.
1959 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
1960 * and is up to the program to do so when it's required.
1962 * @param obj The window object
1963 * @param autodel If true, the window will automatically delete itself when
1966 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1968 * Get the window's autodel state.
1970 * @param obj The window object
1971 * @return If the window will automatically delete itself when closed
1973 * @see elm_win_autodel_set()
1975 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1977 * Activate a window object.
1979 * This function sends a request to the Window Manager to activate the
1980 * window pointed by @p obj. If honored by the WM, the window will receive
1981 * the keyboard focus.
1983 * @note This is just a request that a Window Manager may ignore, so calling
1984 * this function does not ensure in any way that the window will be the
1985 * active one after it.
1987 * @param obj The window object
1989 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1991 * Lower a window object.
1993 * Places the window pointed by @p obj at the bottom of the stack, so that
1994 * no other window is covered by it.
1996 * If elm_win_override_set() is not set, the Window Manager may ignore this
1999 * @param obj The window object
2001 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
2003 * Raise a window object.
2005 * Places the window pointed by @p obj at the top of the stack, so that it's
2006 * not covered by any other window.
2008 * If elm_win_override_set() is not set, the Window Manager may ignore this
2011 * @param obj The window object
2013 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2015 * Set the borderless state of a window.
2017 * This function requests the Window Manager to not draw any decoration
2018 * around the window.
2020 * @param obj The window object
2021 * @param borderless If true, the window is borderless
2023 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2025 * Get the borderless state of a window.
2027 * @param obj The window object
2028 * @return If true, the window is borderless
2030 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2032 * Set the shaped state of a window.
2034 * Shaped windows, when supported, will render the parts of the window that
2035 * has no content, transparent.
2037 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
2038 * background object or cover the entire window in any other way, or the
2039 * parts of the canvas that have no data will show framebuffer artifacts.
2041 * @param obj The window object
2042 * @param shaped If true, the window is shaped
2044 * @see elm_win_alpha_set()
2046 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2048 * Get the shaped state of a window.
2050 * @param obj The window object
2051 * @return If true, the window is shaped
2053 * @see elm_win_shaped_set()
2055 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2057 * Set the alpha channel state of a window.
2059 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
2060 * possibly making parts of the window completely or partially transparent.
2061 * This is also subject to the underlying system supporting it, like for
2062 * example, running under a compositing manager. If no compositing is
2063 * available, enabling this option will instead fallback to using shaped
2064 * windows, with elm_win_shaped_set().
2066 * @param obj The window object
2067 * @param alpha If true, the window has an alpha channel
2069 * @see elm_win_alpha_set()
2071 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2073 * Get the transparency state of a window.
2075 * @param obj The window object
2076 * @return If true, the window is transparent
2078 * @see elm_win_transparent_set()
2080 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2082 * Set the transparency state of a window.
2084 * Use elm_win_alpha_set() instead.
2086 * @param obj The window object
2087 * @param transparent If true, the window is transparent
2089 * @see elm_win_alpha_set()
2091 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2093 * Get the alpha channel state of a window.
2095 * @param obj The window object
2096 * @return If true, the window has an alpha channel
2098 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2100 * Set the override state of a window.
2102 * A window with @p override set to EINA_TRUE will not be managed by the
2103 * Window Manager. This means that no decorations of any kind will be shown
2104 * for it, moving and resizing must be handled by the application, as well
2105 * as the window visibility.
2107 * This should not be used for normal windows, and even for not so normal
2108 * ones, it should only be used when there's a good reason and with a lot
2109 * of care. Mishandling override windows may result situations that
2110 * disrupt the normal workflow of the end user.
2112 * @param obj The window object
2113 * @param override If true, the window is overridden
2115 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2117 * Get the override state of a window.
2119 * @param obj The window object
2120 * @return If true, the window is overridden
2122 * @see elm_win_override_set()
2124 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2126 * Set the fullscreen state of a window.
2128 * @param obj The window object
2129 * @param fullscreen If true, the window is fullscreen
2131 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2133 * Get the fullscreen state of a window.
2135 * @param obj The window object
2136 * @return If true, the window is fullscreen
2138 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2140 * Set the maximized state of a window.
2142 * @param obj The window object
2143 * @param maximized If true, the window is maximized
2145 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2147 * Get the maximized state of a window.
2149 * @param obj The window object
2150 * @return If true, the window is maximized
2152 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2154 * Set the iconified state of a window.
2156 * @param obj The window object
2157 * @param iconified If true, the window is iconified
2159 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2161 * Get the iconified state of a window.
2163 * @param obj The window object
2164 * @return If true, the window is iconified
2166 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2168 * Set the layer of the window.
2170 * What this means exactly will depend on the underlying engine used.
2172 * In the case of X11 backed engines, the value in @p layer has the
2173 * following meanings:
2174 * @li < 3: The window will be placed below all others.
2175 * @li > 5: The window will be placed above all others.
2176 * @li other: The window will be placed in the default layer.
2178 * @param obj The window object
2179 * @param layer The layer of the window
2181 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2183 * Get the layer of the window.
2185 * @param obj The window object
2186 * @return The layer of the window
2188 * @see elm_win_layer_set()
2190 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2192 * Set the rotation of the window.
2194 * Most engines only work with multiples of 90.
2196 * This function is used to set the orientation of the window @p obj to
2197 * match that of the screen. The window itself will be resized to adjust
2198 * to the new geometry of its contents. If you want to keep the window size,
2199 * see elm_win_rotation_with_resize_set().
2201 * @param obj The window object
2202 * @param rotation The rotation of the window, in degrees (0-360),
2203 * counter-clockwise.
2205 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2207 * Rotates the window and resizes it.
2209 * Like elm_win_rotation_set(), but it also resizes the window's contents so
2210 * that they fit inside the current window geometry.
2212 * @param obj The window object
2213 * @param layer The rotation of the window in degrees (0-360),
2214 * counter-clockwise.
2216 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2218 * Get the rotation of the window.
2220 * @param obj The window object
2221 * @return The rotation of the window in degrees (0-360)
2223 * @see elm_win_rotation_set()
2224 * @see elm_win_rotation_with_resize_set()
2226 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2228 * Set the sticky state of the window.
2230 * Hints the Window Manager that the window in @p obj should be left fixed
2231 * at its position even when the virtual desktop it's on moves or changes.
2233 * @param obj The window object
2234 * @param sticky If true, the window's sticky state is enabled
2236 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2238 * Get the sticky state of the window.
2240 * @param obj The window object
2241 * @return If true, the window's sticky state is enabled
2243 * @see elm_win_sticky_set()
2245 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2247 * Set if this window is an illume conformant window
2249 * @param obj The window object
2250 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
2252 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2254 * Get if this window is an illume conformant window
2256 * @param obj The window object
2257 * @return A boolean if this window is illume conformant or not
2259 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2261 * Set a window to be an illume quickpanel window
2263 * By default window objects are not quickpanel windows.
2265 * @param obj The window object
2266 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
2268 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2270 * Get if this window is a quickpanel or not
2272 * @param obj The window object
2273 * @return A boolean if this window is a quickpanel or not
2275 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2277 * Set the major priority of a quickpanel window
2279 * @param obj The window object
2280 * @param priority The major priority for this quickpanel
2282 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2284 * Get the major priority of a quickpanel window
2286 * @param obj The window object
2287 * @return The major priority of this quickpanel
2289 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2291 * Set the minor priority of a quickpanel window
2293 * @param obj The window object
2294 * @param priority The minor priority for this quickpanel
2296 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2298 * Get the minor priority of a quickpanel window
2300 * @param obj The window object
2301 * @return The minor priority of this quickpanel
2303 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2305 * Set which zone this quickpanel should appear in
2307 * @param obj The window object
2308 * @param zone The requested zone for this quickpanel
2310 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2312 * Get which zone this quickpanel should appear in
2314 * @param obj The window object
2315 * @return The requested zone for this quickpanel
2317 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2319 * Set the window to be skipped by keyboard focus
2321 * This sets the window to be skipped by normal keyboard input. This means
2322 * a window manager will be asked to not focus this window as well as omit
2323 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
2325 * Call this and enable it on a window BEFORE you show it for the first time,
2326 * otherwise it may have no effect.
2328 * Use this for windows that have only output information or might only be
2329 * interacted with by the mouse or fingers, and never for typing input.
2330 * Be careful that this may have side-effects like making the window
2331 * non-accessible in some cases unless the window is specially handled. Use
2334 * @param obj The window object
2335 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
2337 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2339 * Send a command to the windowing environment
2341 * This is intended to work in touchscreen or small screen device
2342 * environments where there is a more simplistic window management policy in
2343 * place. This uses the window object indicated to select which part of the
2344 * environment to control (the part that this window lives in), and provides
2345 * a command and an optional parameter structure (use NULL for this if not
2348 * @param obj The window object that lives in the environment to control
2349 * @param command The command to send
2350 * @param params Optional parameters for the command
2352 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2354 * Get the inlined image object handle
2356 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
2357 * then the window is in fact an evas image object inlined in the parent
2358 * canvas. You can get this object (be careful to not manipulate it as it
2359 * is under control of elementary), and use it to do things like get pixel
2360 * data, save the image to a file, etc.
2362 * @param obj The window object to get the inlined image from
2363 * @return The inlined image object, or NULL if none exists
2365 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2367 * Set the enabled status for the focus highlight in a window
2369 * This function will enable or disable the focus highlight only for the
2370 * given window, regardless of the global setting for it
2372 * @param obj The window where to enable the highlight
2373 * @param enabled The enabled value for the highlight
2375 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2377 * Get the enabled value of the focus highlight for this window
2379 * @param obj The window in which to check if the focus highlight is enabled
2381 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
2383 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2385 * Set the style for the focus highlight on this window
2387 * Sets the style to use for theming the highlight of focused objects on
2388 * the given window. If @p style is NULL, the default will be used.
2390 * @param obj The window where to set the style
2391 * @param style The style to set
2393 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2395 * Get the style set for the focus highlight object
2397 * Gets the style set for this windows highilght object, or NULL if none
2400 * @param obj The window to retrieve the highlights style from
2402 * @return The style set or NULL if none was. Default is used in that case.
2404 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2406 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2407 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2408 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2409 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2410 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2411 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2412 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2414 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2415 * (blank mouse, private mouse obj, defaultmouse)
2419 * Sets the keyboard mode of the window.
2421 * @param obj The window object
2422 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
2424 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2426 * Gets the keyboard mode of the window.
2428 * @param obj The window object
2429 * @return The mode, one of #Elm_Win_Keyboard_Mode
2431 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2433 * Sets whether the window is a keyboard.
2435 * @param obj The window object
2436 * @param is_keyboard If true, the window is a virtual keyboard
2438 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2440 * Gets whether the window is a keyboard.
2442 * @param obj The window object
2443 * @return If the window is a virtual keyboard
2445 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2448 * Get the screen position of a window.
2450 * @param obj The window object
2451 * @param x The int to store the x coordinate to
2452 * @param y The int to store the y coordinate to
2454 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2460 * @defgroup Inwin Inwin
2462 * @image html img/widget/inwin/preview-00.png
2463 * @image latex img/widget/inwin/preview-00.eps
2464 * @image html img/widget/inwin/preview-01.png
2465 * @image latex img/widget/inwin/preview-01.eps
2466 * @image html img/widget/inwin/preview-02.png
2467 * @image latex img/widget/inwin/preview-02.eps
2469 * An inwin is a window inside a window that is useful for a quick popup.
2470 * It does not hover.
2472 * It works by creating an object that will occupy the entire window, so it
2473 * must be created using an @ref Win "elm_win" as parent only. The inwin
2474 * object can be hidden or restacked below every other object if it's
2475 * needed to show what's behind it without destroying it. If this is done,
2476 * the elm_win_inwin_activate() function can be used to bring it back to
2477 * full visibility again.
2479 * There are three styles available in the default theme. These are:
2480 * @li default: The inwin is sized to take over most of the window it's
2482 * @li minimal: The size of the inwin will be the minimum necessary to show
2484 * @li minimal_vertical: Horizontally, the inwin takes as much space as
2485 * possible, but it's sized vertically the most it needs to fit its\
2488 * Some examples of Inwin can be found in the following:
2489 * @li @ref inwin_example_01
2494 * Adds an inwin to the current window
2496 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
2497 * Never call this function with anything other than the top-most window
2498 * as its parameter, unless you are fond of undefined behavior.
2500 * After creating the object, the widget will set itself as resize object
2501 * for the window with elm_win_resize_object_add(), so when shown it will
2502 * appear to cover almost the entire window (how much of it depends on its
2503 * content and the style used). It must not be added into other container
2504 * objects and it needs not be moved or resized manually.
2506 * @param parent The parent object
2507 * @return The new object or NULL if it cannot be created
2509 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2511 * Activates an inwin object, ensuring its visibility
2513 * This function will make sure that the inwin @p obj is completely visible
2514 * by calling evas_object_show() and evas_object_raise() on it, to bring it
2515 * to the front. It also sets the keyboard focus to it, which will be passed
2518 * The object's theme will also receive the signal "elm,action,show" with
2521 * @param obj The inwin to activate
2523 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2525 * Set the content of an inwin object.
2527 * Once the content object is set, a previously set one will be deleted.
2528 * If you want to keep that old content object, use the
2529 * elm_win_inwin_content_unset() function.
2531 * @param obj The inwin object
2532 * @param content The object to set as content
2534 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2536 * Get the content of an inwin object.
2538 * Return the content object which is set for this widget.
2540 * The returned object is valid as long as the inwin is still alive and no
2541 * other content is set on it. Deleting the object will notify the inwin
2542 * about it and this one will be left empty.
2544 * If you need to remove an inwin's content to be reused somewhere else,
2545 * see elm_win_inwin_content_unset().
2547 * @param obj The inwin object
2548 * @return The content that is being used
2550 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2552 * Unset the content of an inwin object.
2554 * Unparent and return the content object which was set for this widget.
2556 * @param obj The inwin object
2557 * @return The content that was being used
2559 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2563 /* X specific calls - won't work on non-x engines (return 0) */
2564 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2565 /* smart callbacks called:
2566 * "delete,request" - the user requested to delete the window
2567 * "focus,in" - window got focus
2568 * "focus,out" - window lost focus
2569 * "moved" - window that holds the canvas was moved
2575 * @image html img/widget/bg/preview-00.png
2576 * @image latex img/widget/bg/preview-00.eps
2578 * @brief Background object, used for setting a solid color, image or Edje
2579 * group as background to a window or any container object.
2581 * The bg object is used for setting a solid background to a window or
2582 * packing into any container object. It works just like an image, but has
2583 * some properties useful to a background, like setting it to tiled,
2584 * centered, scaled or stretched.
2586 * Here is some sample code using it:
2587 * @li @ref bg_01_example_page
2588 * @li @ref bg_02_example_page
2589 * @li @ref bg_03_example_page
2593 typedef enum _Elm_Bg_Option
2595 ELM_BG_OPTION_CENTER, /**< center the background */
2596 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2597 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2598 ELM_BG_OPTION_TILE /**< tile background at its original size */
2602 * Add a new background to the parent
2604 * @param parent The parent object
2605 * @return The new object or NULL if it cannot be created
2609 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2612 * Set the file (image or edje) used for the background
2614 * @param obj The bg object
2615 * @param file The file path
2616 * @param group Optional key (group in Edje) within the file
2618 * This sets the image file used in the background object. The image (or edje)
2619 * will be stretched (retaining aspect if its an image file) to completely fill
2620 * the bg object. This may mean some parts are not visible.
2622 * @note Once the image of @p obj is set, a previously set one will be deleted,
2623 * even if @p file is NULL.
2627 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2630 * Get the file (image or edje) used for the background
2632 * @param obj The bg object
2633 * @param file The file path
2634 * @param group Optional key (group in Edje) within the file
2638 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2641 * Set the option used for the background image
2643 * @param obj The bg object
2644 * @param option The desired background option (TILE, SCALE)
2646 * This sets the option used for manipulating the display of the background
2647 * image. The image can be tiled or scaled.
2651 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2654 * Get the option used for the background image
2656 * @param obj The bg object
2657 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2661 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2663 * Set the option used for the background color
2665 * @param obj The bg object
2670 * This sets the color used for the background rectangle. Its range goes
2675 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2677 * Get the option used for the background color
2679 * @param obj The bg object
2686 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2689 * Set the overlay object used for the background object.
2691 * @param obj The bg object
2692 * @param overlay The overlay object
2694 * This provides a way for elm_bg to have an 'overlay' that will be on top
2695 * of the bg. Once the over object is set, a previously set one will be
2696 * deleted, even if you set the new one to NULL. If you want to keep that
2697 * old content object, use the elm_bg_overlay_unset() function.
2702 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2705 * Get the overlay object used for the background object.
2707 * @param obj The bg object
2708 * @return The content that is being used
2710 * Return the content object which is set for this widget
2714 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2717 * Get the overlay object used for the background object.
2719 * @param obj The bg object
2720 * @return The content that was being used
2722 * Unparent and return the overlay object which was set for this widget
2726 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2729 * Set the size of the pixmap representation of the image.
2731 * This option just makes sense if an image is going to be set in the bg.
2733 * @param obj The bg object
2734 * @param w The new width of the image pixmap representation.
2735 * @param h The new height of the image pixmap representation.
2737 * This function sets a new size for pixmap representation of the given bg
2738 * image. It allows the image to be loaded already in the specified size,
2739 * reducing the memory usage and load time when loading a big image with load
2740 * size set to a smaller size.
2742 * NOTE: this is just a hint, the real size of the pixmap may differ
2743 * depending on the type of image being loaded, being bigger than requested.
2747 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2748 /* smart callbacks called:
2752 * @defgroup Icon Icon
2754 * @image html img/widget/icon/preview-00.png
2755 * @image latex img/widget/icon/preview-00.eps
2757 * An object that provides standard icon images (delete, edit, arrows, etc.)
2758 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
2760 * The icon image requested can be in the elementary theme, or in the
2761 * freedesktop.org paths. It's possible to set the order of preference from
2762 * where the image will be used.
2764 * This API is very similar to @ref Image, but with ready to use images.
2766 * Default images provided by the theme are described below.
2768 * The first list contains icons that were first intended to be used in
2769 * toolbars, but can be used in many other places too:
2785 * Now some icons that were designed to be used in menus (but again, you can
2786 * use them anywhere else):
2791 * @li menu/arrow_down
2792 * @li menu/arrow_left
2793 * @li menu/arrow_right
2802 * And here we have some media player specific icons:
2803 * @li media_player/forward
2804 * @li media_player/info
2805 * @li media_player/next
2806 * @li media_player/pause
2807 * @li media_player/play
2808 * @li media_player/prev
2809 * @li media_player/rewind
2810 * @li media_player/stop
2812 * Signals that you can add callbacks for are:
2814 * "clicked" - This is called when a user has clicked the icon
2816 * An example of usage for this API follows:
2817 * @li @ref tutorial_icon
2825 typedef enum _Elm_Icon_Type
2832 * @enum _Elm_Icon_Lookup_Order
2833 * @typedef Elm_Icon_Lookup_Order
2835 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
2836 * theme, FDO paths, or both?
2840 typedef enum _Elm_Icon_Lookup_Order
2842 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2843 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2844 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
2845 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
2846 } Elm_Icon_Lookup_Order;
2849 * Add a new icon object to the parent.
2851 * @param parent The parent object
2852 * @return The new object or NULL if it cannot be created
2854 * @see elm_icon_file_set()
2858 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2860 * Set the file that will be used as icon.
2862 * @param obj The icon object
2863 * @param file The path to file that will be used as icon image
2864 * @param group The group that the icon belongs to in edje file
2866 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2868 * @note The icon image set by this function can be changed by
2869 * elm_icon_standard_set().
2871 * @see elm_icon_file_get()
2875 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2877 * Set a location in memory to be used as an icon
2879 * @param obj The icon object
2880 * @param img The binary data that will be used as an image
2881 * @param size The size of binary data @p img
2882 * @param format Optional format of @p img to pass to the image loader
2883 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
2885 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2887 * @note The icon image set by this function can be changed by
2888 * elm_icon_standard_set().
2892 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);
2894 * Get the file that will be used as icon.
2896 * @param obj The icon object
2897 * @param file The path to file that will be used as icon icon image
2898 * @param group The group that the icon belongs to in edje file
2900 * @see elm_icon_file_set()
2904 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2905 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2907 * Set the icon by icon standards names.
2909 * @param obj The icon object
2910 * @param name The icon name
2912 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2914 * For example, freedesktop.org defines standard icon names such as "home",
2915 * "network", etc. There can be different icon sets to match those icon
2916 * keys. The @p name given as parameter is one of these "keys", and will be
2917 * used to look in the freedesktop.org paths and elementary theme. One can
2918 * change the lookup order with elm_icon_order_lookup_set().
2920 * If name is not found in any of the expected locations and it is the
2921 * absolute path of an image file, this image will be used.
2923 * @note The icon image set by this function can be changed by
2924 * elm_icon_file_set().
2926 * @see elm_icon_standard_get()
2927 * @see elm_icon_file_set()
2931 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2933 * Get the icon name set by icon standard names.
2935 * @param obj The icon object
2936 * @return The icon name
2938 * If the icon image was set using elm_icon_file_set() instead of
2939 * elm_icon_standard_set(), then this function will return @c NULL.
2941 * @see elm_icon_standard_set()
2945 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2947 * Set the smooth effect for an icon object.
2949 * @param obj The icon object
2950 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2951 * otherwise. Default is @c EINA_TRUE.
2953 * Set the scaling algorithm to be used when scaling the icon image. Smooth
2954 * scaling provides a better resulting image, but is slower.
2956 * The smooth scaling should be disabled when making animations that change
2957 * the icon size, since they will be faster. Animations that don't require
2958 * resizing of the icon can keep the smooth scaling enabled (even if the icon
2959 * is already scaled, since the scaled icon image will be cached).
2961 * @see elm_icon_smooth_get()
2965 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2967 * Get the smooth effect for an icon object.
2969 * @param obj The icon object
2970 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2972 * @see elm_icon_smooth_set()
2976 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2978 * Disable scaling of this object.
2980 * @param obj The icon object.
2981 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2982 * otherwise. Default is @c EINA_FALSE.
2984 * This function disables scaling of the icon object through the function
2985 * elm_object_scale_set(). However, this does not affect the object
2986 * size/resize in any way. For that effect, take a look at
2987 * elm_icon_scale_set().
2989 * @see elm_icon_no_scale_get()
2990 * @see elm_icon_scale_set()
2991 * @see elm_object_scale_set()
2995 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2997 * Get whether scaling is disabled on the object.
2999 * @param obj The icon object
3000 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3002 * @see elm_icon_no_scale_set()
3006 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3008 * Set if the object is (up/down) resizeable.
3010 * @param obj The icon object
3011 * @param scale_up A bool to set if the object is resizeable up. Default is
3013 * @param scale_down A bool to set if the object is resizeable down. Default
3016 * This function limits the icon object resize ability. If @p scale_up is set to
3017 * @c EINA_FALSE, the object can't have its height or width resized to a value
3018 * higher than the original icon size. Same is valid for @p scale_down.
3020 * @see elm_icon_scale_get()
3024 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3026 * Get if the object is (up/down) resizeable.
3028 * @param obj The icon object
3029 * @param scale_up A bool to set if the object is resizeable up
3030 * @param scale_down A bool to set if the object is resizeable down
3032 * @see elm_icon_scale_set()
3036 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3038 * Get the object's image size
3040 * @param obj The icon object
3041 * @param w A pointer to store the width in
3042 * @param h A pointer to store the height in
3046 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3048 * Set if the icon fill the entire object area.
3050 * @param obj The icon object
3051 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3052 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3054 * When the icon object is resized to a different aspect ratio from the
3055 * original icon image, the icon image will still keep its aspect. This flag
3056 * tells how the image should fill the object's area. They are: keep the
3057 * entire icon inside the limits of height and width of the object (@p
3058 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
3059 * of the object, and the icon will fill the entire object (@p fill_outside
3062 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
3063 * retain property to false. Thus, the icon image will always keep its
3064 * original aspect ratio.
3066 * @see elm_icon_fill_outside_get()
3067 * @see elm_image_fill_outside_set()
3071 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3073 * Get if the object is filled outside.
3075 * @param obj The icon object
3076 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3078 * @see elm_icon_fill_outside_set()
3082 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3084 * Set the prescale size for the icon.
3086 * @param obj The icon object
3087 * @param size The prescale size. This value is used for both width and
3090 * This function sets a new size for pixmap representation of the given
3091 * icon. It allows the icon to be loaded already in the specified size,
3092 * reducing the memory usage and load time when loading a big icon with load
3093 * size set to a smaller size.
3095 * It's equivalent to the elm_bg_load_size_set() function for bg.
3097 * @note this is just a hint, the real size of the pixmap may differ
3098 * depending on the type of icon being loaded, being bigger than requested.
3100 * @see elm_icon_prescale_get()
3101 * @see elm_bg_load_size_set()
3105 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3107 * Get the prescale size for the icon.
3109 * @param obj The icon object
3110 * @return The prescale size
3112 * @see elm_icon_prescale_set()
3116 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3118 * Sets the icon lookup order used by elm_icon_standard_set().
3120 * @param obj The icon object
3121 * @param order The icon lookup order (can be one of
3122 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
3123 * or ELM_ICON_LOOKUP_THEME)
3125 * @see elm_icon_order_lookup_get()
3126 * @see Elm_Icon_Lookup_Order
3130 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3132 * Gets the icon lookup order.
3134 * @param obj The icon object
3135 * @return The icon lookup order
3137 * @see elm_icon_order_lookup_set()
3138 * @see Elm_Icon_Lookup_Order
3142 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3149 * @defgroup Image Image
3151 * @image html img/widget/image/preview-00.png
3152 * @image latex img/widget/image/preview-00.eps
3154 * An object that allows one to load an image file to it. It can be used
3155 * anywhere like any other elementary widget.
3157 * This widget provides most of the functionality provided from @ref Bg or @ref
3158 * Icon, but with a slightly different API (use the one that fits better your
3161 * The features not provided by those two other image widgets are:
3162 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
3163 * @li change the object orientation with elm_image_orient_set();
3164 * @li and turning the image editable with elm_image_editable_set().
3166 * Signals that you can add callbacks for are:
3168 * @li @c "clicked" - This is called when a user has clicked the image
3170 * An example of usage for this API follows:
3171 * @li @ref tutorial_image
3180 * @enum _Elm_Image_Orient
3181 * @typedef Elm_Image_Orient
3183 * Possible orientation options for elm_image_orient_set().
3185 * @image html elm_image_orient_set.png
3186 * @image latex elm_image_orient_set.eps width=\textwidth
3190 typedef enum _Elm_Image_Orient
3192 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
3193 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
3194 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
3195 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
3196 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
3197 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
3198 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
3199 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
3203 * Add a new image to the parent.
3205 * @param parent The parent object
3206 * @return The new object or NULL if it cannot be created
3208 * @see elm_image_file_set()
3212 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3214 * Set the file that will be used as image.
3216 * @param obj The image object
3217 * @param file The path to file that will be used as image
3218 * @param group The group that the image belongs in edje file (if it's an
3221 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3223 * @see elm_image_file_get()
3227 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3229 * Get the file that will be used as image.
3231 * @param obj The image object
3232 * @param file The path to file
3233 * @param group The group that the image belongs in edje file
3235 * @see elm_image_file_set()
3239 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3241 * Set the smooth effect for an image.
3243 * @param obj The image object
3244 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3245 * otherwise. Default is @c EINA_TRUE.
3247 * Set the scaling algorithm to be used when scaling the image. Smooth
3248 * scaling provides a better resulting image, but is slower.
3250 * The smooth scaling should be disabled when making animations that change
3251 * the image size, since it will be faster. Animations that don't require
3252 * resizing of the image can keep the smooth scaling enabled (even if the
3253 * image is already scaled, since the scaled image will be cached).
3255 * @see elm_image_smooth_get()
3259 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3261 * Get the smooth effect for an image.
3263 * @param obj The image object
3264 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3266 * @see elm_image_smooth_get()
3270 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3272 * Gets the current size of the image.
3274 * @param obj The image object.
3275 * @param w Pointer to store width, or NULL.
3276 * @param h Pointer to store height, or NULL.
3278 * This is the real size of the image, not the size of the object.
3280 * On error, neither w or h will be written.
3284 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3286 * Disable scaling of this object.
3288 * @param obj The image object.
3289 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3290 * otherwise. Default is @c EINA_FALSE.
3292 * This function disables scaling of the elm_image widget through the
3293 * function elm_object_scale_set(). However, this does not affect the widget
3294 * size/resize in any way. For that effect, take a look at
3295 * elm_image_scale_set().
3297 * @see elm_image_no_scale_get()
3298 * @see elm_image_scale_set()
3299 * @see elm_object_scale_set()
3303 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3305 * Get whether scaling is disabled on the object.
3307 * @param obj The image object
3308 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3310 * @see elm_image_no_scale_set()
3314 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3316 * Set if the object is (up/down) resizeable.
3318 * @param obj The image object
3319 * @param scale_up A bool to set if the object is resizeable up. Default is
3321 * @param scale_down A bool to set if the object is resizeable down. Default
3324 * This function limits the image resize ability. If @p scale_up is set to
3325 * @c EINA_FALSE, the object can't have its height or width resized to a value
3326 * higher than the original image size. Same is valid for @p scale_down.
3328 * @see elm_image_scale_get()
3332 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3334 * Get if the object is (up/down) resizeable.
3336 * @param obj The image object
3337 * @param scale_up A bool to set if the object is resizeable up
3338 * @param scale_down A bool to set if the object is resizeable down
3340 * @see elm_image_scale_set()
3344 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3346 * Set if the image fill the entire object area when keeping the aspect ratio.
3348 * @param obj The image object
3349 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3350 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3352 * When the image should keep its aspect ratio even if resized to another
3353 * aspect ratio, there are two possibilities to resize it: keep the entire
3354 * image inside the limits of height and width of the object (@p fill_outside
3355 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
3356 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
3358 * @note This option will have no effect if
3359 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
3361 * @see elm_image_fill_outside_get()
3362 * @see elm_image_aspect_ratio_retained_set()
3366 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3368 * Get if the object is filled outside
3370 * @param obj The image object
3371 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3373 * @see elm_image_fill_outside_set()
3377 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3379 * Set the prescale size for the image
3381 * @param obj The image object
3382 * @param size The prescale size. This value is used for both width and
3385 * This function sets a new size for pixmap representation of the given
3386 * image. It allows the image to be loaded already in the specified size,
3387 * reducing the memory usage and load time when loading a big image with load
3388 * size set to a smaller size.
3390 * It's equivalent to the elm_bg_load_size_set() function for bg.
3392 * @note this is just a hint, the real size of the pixmap may differ
3393 * depending on the type of image being loaded, being bigger than requested.
3395 * @see elm_image_prescale_get()
3396 * @see elm_bg_load_size_set()
3400 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3402 * Get the prescale size for the image
3404 * @param obj The image object
3405 * @return The prescale size
3407 * @see elm_image_prescale_set()
3411 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3413 * Set the image orientation.
3415 * @param obj The image object
3416 * @param orient The image orientation
3417 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3418 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3419 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3420 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
3421 * Default is #ELM_IMAGE_ORIENT_NONE.
3423 * This function allows to rotate or flip the given image.
3425 * @see elm_image_orient_get()
3426 * @see @ref Elm_Image_Orient
3430 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
3432 * Get the image orientation.
3434 * @param obj The image object
3435 * @return The image orientation
3436 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3437 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3438 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3439 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
3441 * @see elm_image_orient_set()
3442 * @see @ref Elm_Image_Orient
3446 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3448 * Make the image 'editable'.
3450 * @param obj Image object.
3451 * @param set Turn on or off editability. Default is @c EINA_FALSE.
3453 * This means the image is a valid drag target for drag and drop, and can be
3454 * cut or pasted too.
3458 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3460 * Make the image 'editable'.
3462 * @param obj Image object.
3463 * @return Editability.
3465 * This means the image is a valid drag target for drag and drop, and can be
3466 * cut or pasted too.
3470 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3472 * Get the basic Evas_Image object from this object (widget).
3474 * @param obj The image object to get the inlined image from
3475 * @return The inlined image object, or NULL if none exists
3477 * This function allows one to get the underlying @c Evas_Object of type
3478 * Image from this elementary widget. It can be useful to do things like get
3479 * the pixel data, save the image to a file, etc.
3481 * @note Be careful to not manipulate it, as it is under control of
3486 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3488 * Set whether the original aspect ratio of the image should be kept on resize.
3490 * @param obj The image object.
3491 * @param retained @c EINA_TRUE if the image should retain the aspect,
3492 * @c EINA_FALSE otherwise.
3494 * The original aspect ratio (width / height) of the image is usually
3495 * distorted to match the object's size. Enabling this option will retain
3496 * this original aspect, and the way that the image is fit into the object's
3497 * area depends on the option set by elm_image_fill_outside_set().
3499 * @see elm_image_aspect_ratio_retained_get()
3500 * @see elm_image_fill_outside_set()
3504 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
3506 * Get if the object retains the original aspect ratio.
3508 * @param obj The image object.
3509 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
3514 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3516 /* smart callbacks called:
3517 * "clicked" - the user clicked the image
3525 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
3527 typedef enum _Elm_GLView_Mode
3529 ELM_GLVIEW_ALPHA = 1,
3530 ELM_GLVIEW_DEPTH = 2,
3531 ELM_GLVIEW_STENCIL = 4
3535 * Defines a policy for the glview resizing.
3537 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
3539 typedef enum _Elm_GLView_Resize_Policy
3541 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
3542 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
3543 } Elm_GLView_Resize_Policy;
3545 typedef enum _Elm_GLView_Render_Policy
3547 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
3548 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
3549 } Elm_GLView_Render_Policy;
3552 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3553 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3554 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3555 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3556 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
3557 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
3558 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
3559 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3560 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3561 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3562 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3563 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3569 * @image html img/widget/box/preview-00.png
3570 * @image latex img/widget/box/preview-00.eps width=\textwidth
3572 * @image html img/box.png
3573 * @image latex img/box.eps width=\textwidth
3575 * A box arranges objects in a linear fashion, governed by a layout function
3576 * that defines the details of this arrangement.
3578 * By default, the box will use an internal function to set the layout to
3579 * a single row, either vertical or horizontal. This layout is affected
3580 * by a number of parameters, such as the homogeneous flag set by
3581 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
3582 * elm_box_align_set() and the hints set to each object in the box.
3584 * For this default layout, it's possible to change the orientation with
3585 * elm_box_horizontal_set(). The box will start in the vertical orientation,
3586 * placing its elements ordered from top to bottom. When horizontal is set,
3587 * the order will go from left to right. If the box is set to be
3588 * homogeneous, every object in it will be assigned the same space, that
3589 * of the largest object. Padding can be used to set some spacing between
3590 * the cell given to each object. The alignment of the box, set with
3591 * elm_box_align_set(), determines how the bounding box of all the elements
3592 * will be placed within the space given to the box widget itself.
3594 * The size hints of each object also affect how they are placed and sized
3595 * within the box. evas_object_size_hint_min_set() will give the minimum
3596 * size the object can have, and the box will use it as the basis for all
3597 * latter calculations. Elementary widgets set their own minimum size as
3598 * needed, so there's rarely any need to use it manually.
3600 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
3601 * used to tell whether the object will be allocated the minimum size it
3602 * needs or if the space given to it should be expanded. It's important
3603 * to realize that expanding the size given to the object is not the same
3604 * thing as resizing the object. It could very well end being a small
3605 * widget floating in a much larger empty space. If not set, the weight
3606 * for objects will normally be 0.0 for both axis, meaning the widget will
3607 * not be expanded. To take as much space possible, set the weight to
3608 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
3610 * Besides how much space each object is allocated, it's possible to control
3611 * how the widget will be placed within that space using
3612 * evas_object_size_hint_align_set(). By default, this value will be 0.5
3613 * for both axis, meaning the object will be centered, but any value from
3614 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
3615 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
3616 * is -1.0, means the object will be resized to fill the entire space it
3619 * In addition, customized functions to define the layout can be set, which
3620 * allow the application developer to organize the objects within the box
3621 * in any number of ways.
3623 * The special elm_box_layout_transition() function can be used
3624 * to switch from one layout to another, animating the motion of the
3625 * children of the box.
3627 * @note Objects should not be added to box objects using _add() calls.
3629 * Some examples on how to use boxes follow:
3630 * @li @ref box_example_01
3631 * @li @ref box_example_02
3636 * @typedef Elm_Box_Transition
3638 * Opaque handler containing the parameters to perform an animated
3639 * transition of the layout the box uses.
3641 * @see elm_box_transition_new()
3642 * @see elm_box_layout_set()
3643 * @see elm_box_layout_transition()
3645 typedef struct _Elm_Box_Transition Elm_Box_Transition;
3648 * Add a new box to the parent
3650 * By default, the box will be in vertical mode and non-homogeneous.
3652 * @param parent The parent object
3653 * @return The new object or NULL if it cannot be created
3655 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3657 * Set the horizontal orientation
3659 * By default, box object arranges their contents vertically from top to
3661 * By calling this function with @p horizontal as EINA_TRUE, the box will
3662 * become horizontal, arranging contents from left to right.
3664 * @note This flag is ignored if a custom layout function is set.
3666 * @param obj The box object
3667 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
3668 * EINA_FALSE = vertical)
3670 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3672 * Get the horizontal orientation
3674 * @param obj The box object
3675 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
3677 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3679 * Set the box to arrange its children homogeneously
3681 * If enabled, homogeneous layout makes all items the same size, according
3682 * to the size of the largest of its children.
3684 * @note This flag is ignored if a custom layout function is set.
3686 * @param obj The box object
3687 * @param homogeneous The homogeneous flag
3689 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3691 * Get whether the box is using homogeneous mode or not
3693 * @param obj The box object
3694 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
3696 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3697 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3698 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3700 * Add an object to the beginning of the pack list
3702 * Pack @p subobj into the box @p obj, placing it first in the list of
3703 * children objects. The actual position the object will get on screen
3704 * depends on the layout used. If no custom layout is set, it will be at
3705 * the top or left, depending if the box is vertical or horizontal,
3708 * @param obj The box object
3709 * @param subobj The object to add to the box
3711 * @see elm_box_pack_end()
3712 * @see elm_box_pack_before()
3713 * @see elm_box_pack_after()
3714 * @see elm_box_unpack()
3715 * @see elm_box_unpack_all()
3716 * @see elm_box_clear()
3718 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3720 * Add an object at the end of the pack list
3722 * Pack @p subobj into the box @p obj, placing it last in the list of
3723 * children objects. The actual position the object will get on screen
3724 * depends on the layout used. If no custom layout is set, it will be at
3725 * the bottom or right, depending if the box is vertical or horizontal,
3728 * @param obj The box object
3729 * @param subobj The object to add to the box
3731 * @see elm_box_pack_start()
3732 * @see elm_box_pack_before()
3733 * @see elm_box_pack_after()
3734 * @see elm_box_unpack()
3735 * @see elm_box_unpack_all()
3736 * @see elm_box_clear()
3738 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3740 * Adds an object to the box before the indicated object
3742 * This will add the @p subobj to the box indicated before the object
3743 * indicated with @p before. If @p before is not already in the box, results
3744 * are undefined. Before means either to the left of the indicated object or
3745 * above it depending on orientation.
3747 * @param obj The box object
3748 * @param subobj The object to add to the box
3749 * @param before The object before which to add it
3751 * @see elm_box_pack_start()
3752 * @see elm_box_pack_end()
3753 * @see elm_box_pack_after()
3754 * @see elm_box_unpack()
3755 * @see elm_box_unpack_all()
3756 * @see elm_box_clear()
3758 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
3760 * Adds an object to the box after the indicated object
3762 * This will add the @p subobj to the box indicated after the object
3763 * indicated with @p after. If @p after is not already in the box, results
3764 * are undefined. After means either to the right of the indicated object or
3765 * below it depending on orientation.
3767 * @param obj The box object
3768 * @param subobj The object to add to the box
3769 * @param after The object after which to add it
3771 * @see elm_box_pack_start()
3772 * @see elm_box_pack_end()
3773 * @see elm_box_pack_before()
3774 * @see elm_box_unpack()
3775 * @see elm_box_unpack_all()
3776 * @see elm_box_clear()
3778 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
3780 * Clear the box of all children
3782 * Remove all the elements contained by the box, deleting the respective
3785 * @param obj The box object
3787 * @see elm_box_unpack()
3788 * @see elm_box_unpack_all()
3790 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3794 * Remove the object given by @p subobj from the box @p obj without
3797 * @param obj The box object
3799 * @see elm_box_unpack_all()
3800 * @see elm_box_clear()
3802 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3804 * Remove all items from the box, without deleting them
3806 * Clear the box from all children, but don't delete the respective objects.
3807 * If no other references of the box children exist, the objects will never
3808 * be deleted, and thus the application will leak the memory. Make sure
3809 * when using this function that you hold a reference to all the objects
3810 * in the box @p obj.
3812 * @param obj The box object
3814 * @see elm_box_clear()
3815 * @see elm_box_unpack()
3817 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3819 * Retrieve a list of the objects packed into the box
3821 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
3822 * The order of the list corresponds to the packing order the box uses.
3824 * You must free this list with eina_list_free() once you are done with it.
3826 * @param obj The box object
3828 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3830 * Set the space (padding) between the box's elements.
3832 * Extra space in pixels that will be added between a box child and its
3833 * neighbors after its containing cell has been calculated. This padding
3834 * is set for all elements in the box, besides any possible padding that
3835 * individual elements may have through their size hints.
3837 * @param obj The box object
3838 * @param horizontal The horizontal space between elements
3839 * @param vertical The vertical space between elements
3841 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3843 * Get the space (padding) between the box's elements.
3845 * @param obj The box object
3846 * @param horizontal The horizontal space between elements
3847 * @param vertical The vertical space between elements
3849 * @see elm_box_padding_set()
3851 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3853 * Set the alignment of the whole bouding box of contents.
3855 * Sets how the bounding box containing all the elements of the box, after
3856 * their sizes and position has been calculated, will be aligned within
3857 * the space given for the whole box widget.
3859 * @param obj The box object
3860 * @param horizontal The horizontal alignment of elements
3861 * @param vertical The vertical alignment of elements
3863 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
3865 * Get the alignment of the whole bouding box of contents.
3867 * @param obj The box object
3868 * @param horizontal The horizontal alignment of elements
3869 * @param vertical The vertical alignment of elements
3871 * @see elm_box_align_set()
3873 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
3876 * Set the layout defining function to be used by the box
3878 * Whenever anything changes that requires the box in @p obj to recalculate
3879 * the size and position of its elements, the function @p cb will be called
3880 * to determine what the layout of the children will be.
3882 * Once a custom function is set, everything about the children layout
3883 * is defined by it. The flags set by elm_box_horizontal_set() and
3884 * elm_box_homogeneous_set() no longer have any meaning, and the values
3885 * given by elm_box_padding_set() and elm_box_align_set() are up to this
3886 * layout function to decide if they are used and how. These last two
3887 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
3888 * passed to @p cb. The @c Evas_Object the function receives is not the
3889 * Elementary widget, but the internal Evas Box it uses, so none of the
3890 * functions described here can be used on it.
3892 * Any of the layout functions in @c Evas can be used here, as well as the
3893 * special elm_box_layout_transition().
3895 * The final @p data argument received by @p cb is the same @p data passed
3896 * here, and the @p free_data function will be called to free it
3897 * whenever the box is destroyed or another layout function is set.
3899 * Setting @p cb to NULL will revert back to the default layout function.
3901 * @param obj The box object
3902 * @param cb The callback function used for layout
3903 * @param data Data that will be passed to layout function
3904 * @param free_data Function called to free @p data
3906 * @see elm_box_layout_transition()
3908 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);
3910 * Special layout function that animates the transition from one layout to another
3912 * Normally, when switching the layout function for a box, this will be
3913 * reflected immediately on screen on the next render, but it's also
3914 * possible to do this through an animated transition.
3916 * This is done by creating an ::Elm_Box_Transition and setting the box
3917 * layout to this function.
3921 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
3922 * evas_object_box_layout_vertical, // start
3923 * NULL, // data for initial layout
3924 * NULL, // free function for initial data
3925 * evas_object_box_layout_horizontal, // end
3926 * NULL, // data for final layout
3927 * NULL, // free function for final data
3928 * anim_end, // will be called when animation ends
3929 * NULL); // data for anim_end function\
3930 * elm_box_layout_set(box, elm_box_layout_transition, t,
3931 * elm_box_transition_free);
3934 * @note This function can only be used with elm_box_layout_set(). Calling
3935 * it directly will not have the expected results.
3937 * @see elm_box_transition_new
3938 * @see elm_box_transition_free
3939 * @see elm_box_layout_set
3941 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
3943 * Create a new ::Elm_Box_Transition to animate the switch of layouts
3945 * If you want to animate the change from one layout to another, you need
3946 * to set the layout function of the box to elm_box_layout_transition(),
3947 * passing as user data to it an instance of ::Elm_Box_Transition with the
3948 * necessary information to perform this animation. The free function to
3949 * set for the layout is elm_box_transition_free().
3951 * The parameters to create an ::Elm_Box_Transition sum up to how long
3952 * will it be, in seconds, a layout function to describe the initial point,
3953 * another for the final position of the children and one function to be
3954 * called when the whole animation ends. This last function is useful to
3955 * set the definitive layout for the box, usually the same as the end
3956 * layout for the animation, but could be used to start another transition.
3958 * @param start_layout The layout function that will be used to start the animation
3959 * @param start_layout_data The data to be passed the @p start_layout function
3960 * @param start_layout_free_data Function to free @p start_layout_data
3961 * @param end_layout The layout function that will be used to end the animation
3962 * @param end_layout_free_data The data to be passed the @p end_layout function
3963 * @param end_layout_free_data Function to free @p end_layout_data
3964 * @param transition_end_cb Callback function called when animation ends
3965 * @param transition_end_data Data to be passed to @p transition_end_cb
3966 * @return An instance of ::Elm_Box_Transition
3968 * @see elm_box_transition_new
3969 * @see elm_box_layout_transition
3971 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);
3973 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3975 * This function is mostly useful as the @c free_data parameter in
3976 * elm_box_layout_set() when elm_box_layout_transition().
3978 * @param data The Elm_Box_Transition instance to be freed.
3980 * @see elm_box_transition_new
3981 * @see elm_box_layout_transition
3983 EAPI void elm_box_transition_free(void *data);
3990 * @defgroup Button Button
3992 * @image html img/widget/button/preview-00.png
3993 * @image html img/widget/button/preview-01.png
3994 * @image html img/widget/button/preview-02.png
3996 * This is a push-button. Press it and run some function. It can contain
3997 * a simple label and icon object and it also has an autorepeat feature.
3999 * This widgets emits the following signals:
4000 * @li "clicked": the user clicked the button (press/release).
4001 * @li "repeated": the user pressed the button without releasing it.
4002 * @li "pressed": button was pressed.
4003 * @li "unpressed": button was released after being pressed.
4004 * In all three cases, the @c event parameter of the callback will be
4007 * Also, defined in the default theme, the button has the following styles
4009 * @li default: a normal button.
4010 * @li anchor: Like default, but the button fades away when the mouse is not
4011 * over it, leaving only the text or icon.
4012 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4013 * continuous look across its options.
4014 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4016 * Follow through a complete example @ref button_example_01 "here".
4020 * Add a new button to the parent's canvas
4022 * @param parent The parent object
4023 * @return The new object or NULL if it cannot be created
4025 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4027 * Set the label used in the button
4029 * The passed @p label can be NULL to clean any existing text in it and
4030 * leave the button as an icon only object.
4032 * @param obj The button object
4033 * @param label The text will be written on the button
4034 * @deprecated use elm_object_text_set() instead.
4036 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4038 * Get the label set for the button
4040 * The string returned is an internal pointer and should not be freed or
4041 * altered. It will also become invalid when the button is destroyed.
4042 * The string returned, if not NULL, is a stringshare, so if you need to
4043 * keep it around even after the button is destroyed, you can use
4044 * eina_stringshare_ref().
4046 * @param obj The button object
4047 * @return The text set to the label, or NULL if nothing is set
4048 * @deprecated use elm_object_text_set() instead.
4050 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4052 * Set the icon used for the button
4054 * Setting a new icon will delete any other that was previously set, making
4055 * any reference to them invalid. If you need to maintain the previous
4056 * object alive, unset it first with elm_button_icon_unset().
4058 * @param obj The button object
4059 * @param icon The icon object for the button
4061 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4063 * Get the icon used for the button
4065 * Return the icon object which is set for this widget. If the button is
4066 * destroyed or another icon is set, the returned object will be deleted
4067 * and any reference to it will be invalid.
4069 * @param obj The button object
4070 * @return The icon object that is being used
4072 * @see elm_button_icon_unset()
4074 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4076 * Remove the icon set without deleting it and return the object
4078 * This function drops the reference the button holds of the icon object
4079 * and returns this last object. It is used in case you want to remove any
4080 * icon, or set another one, without deleting the actual object. The button
4081 * will be left without an icon set.
4083 * @param obj The button object
4084 * @return The icon object that was being used
4086 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4088 * Turn on/off the autorepeat event generated when the button is kept pressed
4090 * When off, no autorepeat is performed and buttons emit a normal @c clicked
4091 * signal when they are clicked.
4093 * When on, keeping a button pressed will continuously emit a @c repeated
4094 * signal until the button is released. The time it takes until it starts
4095 * emitting the signal is given by
4096 * elm_button_autorepeat_initial_timeout_set(), and the time between each
4097 * new emission by elm_button_autorepeat_gap_timeout_set().
4099 * @param obj The button object
4100 * @param on A bool to turn on/off the event
4102 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4104 * Get whether the autorepeat feature is enabled
4106 * @param obj The button object
4107 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4109 * @see elm_button_autorepeat_set()
4111 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4113 * Set the initial timeout before the autorepeat event is generated
4115 * Sets the timeout, in seconds, since the button is pressed until the
4116 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4117 * won't be any delay and the even will be fired the moment the button is
4120 * @param obj The button object
4121 * @param t Timeout in seconds
4123 * @see elm_button_autorepeat_set()
4124 * @see elm_button_autorepeat_gap_timeout_set()
4126 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4128 * Get the initial timeout before the autorepeat event is generated
4130 * @param obj The button object
4131 * @return Timeout in seconds
4133 * @see elm_button_autorepeat_initial_timeout_set()
4135 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4137 * Set the interval between each generated autorepeat event
4139 * After the first @c repeated event is fired, all subsequent ones will
4140 * follow after a delay of @p t seconds for each.
4142 * @param obj The button object
4143 * @param t Interval in seconds
4145 * @see elm_button_autorepeat_initial_timeout_set()
4147 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4149 * Get the interval between each generated autorepeat event
4151 * @param obj The button object
4152 * @return Interval in seconds
4154 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4160 * @defgroup File_Selector_Button File Selector Button
4162 * @image html img/widget/fileselector_button/preview-00.png
4163 * @image html img/widget/fileselector_button/preview-01.png
4164 * @image html img/widget/fileselector_button/preview-02.png
4166 * This is a button that, when clicked, creates an Elementary
4167 * window (or inner window) <b> with a @ref Fileselector "file
4168 * selector widget" within</b>. When a file is chosen, the (inner)
4169 * window is closed and the button emits a signal having the
4170 * selected file as it's @c event_info.
4172 * This widget encapsulates operations on its internal file
4173 * selector on its own API. There is less control over its file
4174 * selector than that one would have instatiating one directly.
4176 * The following styles are available for this button:
4179 * @li @c "hoversel_vertical"
4180 * @li @c "hoversel_vertical_entry"
4182 * Smart callbacks one can register to:
4183 * - @c "file,chosen" - the user has selected a path, whose string
4184 * pointer comes as the @c event_info data (a stringshared
4187 * Here is an example on its usage:
4188 * @li @ref fileselector_button_example
4190 * @see @ref File_Selector_Entry for a similar widget.
4195 * Add a new file selector button widget to the given parent
4196 * Elementary (container) object
4198 * @param parent The parent object
4199 * @return a new file selector button widget handle or @c NULL, on
4202 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4205 * Set the label for a given file selector button widget
4207 * @param obj The file selector button widget
4208 * @param label The text label to be displayed on @p obj
4210 * @deprecated use elm_object_text_set() instead.
4212 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4215 * Get the label set for a given file selector button widget
4217 * @param obj The file selector button widget
4218 * @return The button label
4220 * @deprecated use elm_object_text_set() instead.
4222 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4225 * Set the icon on a given file selector button widget
4227 * @param obj The file selector button widget
4228 * @param icon The icon object for the button
4230 * Once the icon object is set, a previously set one will be
4231 * deleted. If you want to keep the latter, use the
4232 * elm_fileselector_button_icon_unset() function.
4234 * @see elm_fileselector_button_icon_get()
4236 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4239 * Get the icon set for a given file selector button widget
4241 * @param obj The file selector button widget
4242 * @return The icon object currently set on @p obj or @c NULL, if
4245 * @see elm_fileselector_button_icon_set()
4247 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4250 * Unset the icon used in a given file selector button widget
4252 * @param obj The file selector button widget
4253 * @return The icon object that was being used on @p obj or @c
4256 * Unparent and return the icon object which was set for this
4259 * @see elm_fileselector_button_icon_set()
4261 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4264 * Set the title for a given file selector button widget's window
4266 * @param obj The file selector button widget
4267 * @param title The title string
4269 * This will change the window's title, when the file selector pops
4270 * out after a click on the button. Those windows have the default
4271 * (unlocalized) value of @c "Select a file" as titles.
4273 * @note It will only take any effect if the file selector
4274 * button widget is @b not under "inwin mode".
4276 * @see elm_fileselector_button_window_title_get()
4278 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4281 * Get the title set for a given file selector button widget's
4284 * @param obj The file selector button widget
4285 * @return Title of the file selector button's window
4287 * @see elm_fileselector_button_window_title_get() for more details
4289 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4292 * Set the size of a given file selector button widget's window,
4293 * holding the file selector itself.
4295 * @param obj The file selector button widget
4296 * @param width The window's width
4297 * @param height The window's height
4299 * @note it will only take any effect if the file selector button
4300 * widget is @b not under "inwin mode". The default size for the
4301 * window (when applicable) is 400x400 pixels.
4303 * @see elm_fileselector_button_window_size_get()
4305 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4308 * Get the size of a given file selector button widget's window,
4309 * holding the file selector itself.
4311 * @param obj The file selector button widget
4312 * @param width Pointer into which to store the width value
4313 * @param height Pointer into which to store the height value
4315 * @note Use @c NULL pointers on the size values you're not
4316 * interested in: they'll be ignored by the function.
4318 * @see elm_fileselector_button_window_size_set(), for more details
4320 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4323 * Set the initial file system path for a given file selector
4326 * @param obj The file selector button widget
4327 * @param path The path string
4329 * It must be a <b>directory</b> path, which will have the contents
4330 * displayed initially in the file selector's view, when invoked
4331 * from @p obj. The default initial path is the @c "HOME"
4332 * environment variable's value.
4334 * @see elm_fileselector_button_path_get()
4336 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4339 * Get the initial file system path set for a given file selector
4342 * @param obj The file selector button widget
4343 * @return path The path string
4345 * @see elm_fileselector_button_path_set() for more details
4347 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4350 * Enable/disable a tree view in the given file selector button
4351 * widget's internal file selector
4353 * @param obj The file selector button widget
4354 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4357 * This has the same effect as elm_fileselector_expandable_set(),
4358 * but now applied to a file selector button's internal file
4361 * @note There's no way to put a file selector button's internal
4362 * file selector in "grid mode", as one may do with "pure" file
4365 * @see elm_fileselector_expandable_get()
4367 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4370 * Get whether tree view is enabled for the given file selector
4371 * button widget's internal file selector
4373 * @param obj The file selector button widget
4374 * @return @c EINA_TRUE if @p obj widget's internal file selector
4375 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4377 * @see elm_fileselector_expandable_set() for more details
4379 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4382 * Set whether a given file selector button widget's internal file
4383 * selector is to display folders only or the directory contents,
4386 * @param obj The file selector button widget
4387 * @param only @c EINA_TRUE to make @p obj widget's internal file
4388 * selector only display directories, @c EINA_FALSE to make files
4389 * to be displayed in it too
4391 * This has the same effect as elm_fileselector_folder_only_set(),
4392 * but now applied to a file selector button's internal file
4395 * @see elm_fileselector_folder_only_get()
4397 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4400 * Get whether a given file selector button widget's internal file
4401 * selector is displaying folders only or the directory contents,
4404 * @param obj The file selector button widget
4405 * @return @c EINA_TRUE if @p obj widget's internal file
4406 * selector is only displaying directories, @c EINA_FALSE if files
4407 * are being displayed in it too (and on errors)
4409 * @see elm_fileselector_button_folder_only_set() for more details
4411 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4414 * Enable/disable the file name entry box where the user can type
4415 * in a name for a file, in a given file selector button widget's
4416 * internal file selector.
4418 * @param obj The file selector button widget
4419 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4420 * file selector a "saving dialog", @c EINA_FALSE otherwise
4422 * This has the same effect as elm_fileselector_is_save_set(),
4423 * but now applied to a file selector button's internal file
4426 * @see elm_fileselector_is_save_get()
4428 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4431 * Get whether the given file selector button widget's internal
4432 * file selector is in "saving dialog" mode
4434 * @param obj The file selector button widget
4435 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4436 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4439 * @see elm_fileselector_button_is_save_set() for more details
4441 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4444 * Set whether a given file selector button widget's internal file
4445 * selector will raise an Elementary "inner window", instead of a
4446 * dedicated Elementary window. By default, it won't.
4448 * @param obj The file selector button widget
4449 * @param value @c EINA_TRUE to make it use an inner window, @c
4450 * EINA_TRUE to make it use a dedicated window
4452 * @see elm_win_inwin_add() for more information on inner windows
4453 * @see elm_fileselector_button_inwin_mode_get()
4455 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4458 * Get whether a given file selector button widget's internal file
4459 * selector will raise an Elementary "inner window", instead of a
4460 * dedicated Elementary window.
4462 * @param obj The file selector button widget
4463 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4464 * if it will use a dedicated window
4466 * @see elm_fileselector_button_inwin_mode_set() for more details
4468 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4475 * @defgroup File_Selector_Entry File Selector Entry
4477 * @image html img/widget/fileselector_entry/preview-00.png
4478 * @image latex img/widget/fileselector_entry/preview-00.eps
4480 * This is an entry made to be filled with or display a <b>file
4481 * system path string</b>. Besides the entry itself, the widget has
4482 * a @ref File_Selector_Button "file selector button" on its side,
4483 * which will raise an internal @ref Fileselector "file selector widget",
4484 * when clicked, for path selection aided by file system
4487 * This file selector may appear in an Elementary window or in an
4488 * inner window. When a file is chosen from it, the (inner) window
4489 * is closed and the selected file's path string is exposed both as
4490 * an smart event and as the new text on the entry.
4492 * This widget encapsulates operations on its internal file
4493 * selector on its own API. There is less control over its file
4494 * selector than that one would have instatiating one directly.
4496 * Smart callbacks one can register to:
4497 * - @c "changed" - The text within the entry was changed
4498 * - @c "activated" - The entry has had editing finished and
4499 * changes are to be "committed"
4500 * - @c "press" - The entry has been clicked
4501 * - @c "longpressed" - The entry has been clicked (and held) for a
4503 * - @c "clicked" - The entry has been clicked
4504 * - @c "clicked,double" - The entry has been double clicked
4505 * - @c "focused" - The entry has received focus
4506 * - @c "unfocused" - The entry has lost focus
4507 * - @c "selection,paste" - A paste action has occurred on the
4509 * - @c "selection,copy" - A copy action has occurred on the entry
4510 * - @c "selection,cut" - A cut action has occurred on the entry
4511 * - @c "unpressed" - The file selector entry's button was released
4512 * after being pressed.
4513 * - @c "file,chosen" - The user has selected a path via the file
4514 * selector entry's internal file selector, whose string pointer
4515 * comes as the @c event_info data (a stringshared string)
4517 * Here is an example on its usage:
4518 * @li @ref fileselector_entry_example
4520 * @see @ref File_Selector_Button for a similar widget.
4525 * Add a new file selector entry widget to the given parent
4526 * Elementary (container) object
4528 * @param parent The parent object
4529 * @return a new file selector entry widget handle or @c NULL, on
4532 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4535 * Set the label for a given file selector entry widget's button
4537 * @param obj The file selector entry widget
4538 * @param label The text label to be displayed on @p obj widget's
4541 * @deprecated use elm_object_text_set() instead.
4543 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4546 * Get the label set for a given file selector entry widget's button
4548 * @param obj The file selector entry widget
4549 * @return The widget button's label
4551 * @deprecated use elm_object_text_set() instead.
4553 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4556 * Set the icon on a given file selector entry widget's button
4558 * @param obj The file selector entry widget
4559 * @param icon The icon object for the entry's button
4561 * Once the icon object is set, a previously set one will be
4562 * deleted. If you want to keep the latter, use the
4563 * elm_fileselector_entry_button_icon_unset() function.
4565 * @see elm_fileselector_entry_button_icon_get()
4567 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4570 * Get the icon set for a given file selector entry widget's button
4572 * @param obj The file selector entry widget
4573 * @return The icon object currently set on @p obj widget's button
4574 * or @c NULL, if none is
4576 * @see elm_fileselector_entry_button_icon_set()
4578 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4581 * Unset the icon used in a given file selector entry widget's
4584 * @param obj The file selector entry widget
4585 * @return The icon object that was being used on @p obj widget's
4586 * button or @c NULL, on errors
4588 * Unparent and return the icon object which was set for this
4591 * @see elm_fileselector_entry_button_icon_set()
4593 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4596 * Set the title for a given file selector entry widget's window
4598 * @param obj The file selector entry widget
4599 * @param title The title string
4601 * This will change the window's title, when the file selector pops
4602 * out after a click on the entry's button. Those windows have the
4603 * default (unlocalized) value of @c "Select a file" as titles.
4605 * @note It will only take any effect if the file selector
4606 * entry widget is @b not under "inwin mode".
4608 * @see elm_fileselector_entry_window_title_get()
4610 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4613 * Get the title set for a given file selector entry widget's
4616 * @param obj The file selector entry widget
4617 * @return Title of the file selector entry's window
4619 * @see elm_fileselector_entry_window_title_get() for more details
4621 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4624 * Set the size of a given file selector entry widget's window,
4625 * holding the file selector itself.
4627 * @param obj The file selector entry widget
4628 * @param width The window's width
4629 * @param height The window's height
4631 * @note it will only take any effect if the file selector entry
4632 * widget is @b not under "inwin mode". The default size for the
4633 * window (when applicable) is 400x400 pixels.
4635 * @see elm_fileselector_entry_window_size_get()
4637 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4640 * Get the size of a given file selector entry widget's window,
4641 * holding the file selector itself.
4643 * @param obj The file selector entry widget
4644 * @param width Pointer into which to store the width value
4645 * @param height Pointer into which to store the height value
4647 * @note Use @c NULL pointers on the size values you're not
4648 * interested in: they'll be ignored by the function.
4650 * @see elm_fileselector_entry_window_size_set(), for more details
4652 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4655 * Set the initial file system path and the entry's path string for
4656 * a given file selector entry widget
4658 * @param obj The file selector entry widget
4659 * @param path The path string
4661 * It must be a <b>directory</b> path, which will have the contents
4662 * displayed initially in the file selector's view, when invoked
4663 * from @p obj. The default initial path is the @c "HOME"
4664 * environment variable's value.
4666 * @see elm_fileselector_entry_path_get()
4668 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4671 * Get the entry's path string for a given file selector entry
4674 * @param obj The file selector entry widget
4675 * @return path The path string
4677 * @see elm_fileselector_entry_path_set() for more details
4679 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4682 * Enable/disable a tree view in the given file selector entry
4683 * widget's internal file selector
4685 * @param obj The file selector entry widget
4686 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4689 * This has the same effect as elm_fileselector_expandable_set(),
4690 * but now applied to a file selector entry's internal file
4693 * @note There's no way to put a file selector entry's internal
4694 * file selector in "grid mode", as one may do with "pure" file
4697 * @see elm_fileselector_expandable_get()
4699 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4702 * Get whether tree view is enabled for the given file selector
4703 * entry widget's internal file selector
4705 * @param obj The file selector entry widget
4706 * @return @c EINA_TRUE if @p obj widget's internal file selector
4707 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4709 * @see elm_fileselector_expandable_set() for more details
4711 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4714 * Set whether a given file selector entry widget's internal file
4715 * selector is to display folders only or the directory contents,
4718 * @param obj The file selector entry widget
4719 * @param only @c EINA_TRUE to make @p obj widget's internal file
4720 * selector only display directories, @c EINA_FALSE to make files
4721 * to be displayed in it too
4723 * This has the same effect as elm_fileselector_folder_only_set(),
4724 * but now applied to a file selector entry's internal file
4727 * @see elm_fileselector_folder_only_get()
4729 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4732 * Get whether a given file selector entry widget's internal file
4733 * selector is displaying folders only or the directory contents,
4736 * @param obj The file selector entry widget
4737 * @return @c EINA_TRUE if @p obj widget's internal file
4738 * selector is only displaying directories, @c EINA_FALSE if files
4739 * are being displayed in it too (and on errors)
4741 * @see elm_fileselector_entry_folder_only_set() for more details
4743 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4746 * Enable/disable the file name entry box where the user can type
4747 * in a name for a file, in a given file selector entry widget's
4748 * internal file selector.
4750 * @param obj The file selector entry widget
4751 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4752 * file selector a "saving dialog", @c EINA_FALSE otherwise
4754 * This has the same effect as elm_fileselector_is_save_set(),
4755 * but now applied to a file selector entry's internal file
4758 * @see elm_fileselector_is_save_get()
4760 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4763 * Get whether the given file selector entry widget's internal
4764 * file selector is in "saving dialog" mode
4766 * @param obj The file selector entry widget
4767 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4768 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4771 * @see elm_fileselector_entry_is_save_set() for more details
4773 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4776 * Set whether a given file selector entry widget's internal file
4777 * selector will raise an Elementary "inner window", instead of a
4778 * dedicated Elementary window. By default, it won't.
4780 * @param obj The file selector entry widget
4781 * @param value @c EINA_TRUE to make it use an inner window, @c
4782 * EINA_TRUE to make it use a dedicated window
4784 * @see elm_win_inwin_add() for more information on inner windows
4785 * @see elm_fileselector_entry_inwin_mode_get()
4787 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4790 * Get whether a given file selector entry widget's internal file
4791 * selector will raise an Elementary "inner window", instead of a
4792 * dedicated Elementary window.
4794 * @param obj The file selector entry widget
4795 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4796 * if it will use a dedicated window
4798 * @see elm_fileselector_entry_inwin_mode_set() for more details
4800 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4803 * Set the initial file system path for a given file selector entry
4806 * @param obj The file selector entry widget
4807 * @param path The path string
4809 * It must be a <b>directory</b> path, which will have the contents
4810 * displayed initially in the file selector's view, when invoked
4811 * from @p obj. The default initial path is the @c "HOME"
4812 * environment variable's value.
4814 * @see elm_fileselector_entry_path_get()
4816 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4819 * Get the parent directory's path to the latest file selection on
4820 * a given filer selector entry widget
4822 * @param obj The file selector object
4823 * @return The (full) path of the directory of the last selection
4824 * on @p obj widget, a @b stringshared string
4826 * @see elm_fileselector_entry_path_set()
4828 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4835 * @defgroup Scroller Scroller
4837 * A scroller holds a single object and "scrolls it around". This means that
4838 * it allows the user to use a scrollbar (or a finger) to drag the viewable
4839 * region around, allowing to move through a much larger object that is
4840 * contained in the scroller. The scroiller will always have a small minimum
4841 * size by default as it won't be limited by the contents of the scroller.
4843 * Signals that you can add callbacks for are:
4844 * @li "edge,left" - the left edge of the content has been reached
4845 * @li "edge,right" - the right edge of the content has been reached
4846 * @li "edge,top" - the top edge of the content has been reached
4847 * @li "edge,bottom" - the bottom edge of the content has been reached
4848 * @li "scroll" - the content has been scrolled (moved)
4849 * @li "scroll,anim,start" - scrolling animation has started
4850 * @li "scroll,anim,stop" - scrolling animation has stopped
4851 * @li "scroll,drag,start" - dragging the contents around has started
4852 * @li "scroll,drag,stop" - dragging the contents around has stopped
4853 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
4856 * @note When Elemementary is in embedded mode the scrollbars will not be
4857 * dragable, they appear merely as indicators of how much has been scrolled.
4858 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
4859 * fingerscroll) won't work.
4861 * In @ref tutorial_scroller you'll find an example of how to use most of
4866 * @brief Type that controls when scrollbars should appear.
4868 * @see elm_scroller_policy_set()
4870 typedef enum _Elm_Scroller_Policy
4872 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
4873 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
4874 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
4875 ELM_SCROLLER_POLICY_LAST
4876 } Elm_Scroller_Policy;
4878 * @brief Add a new scroller to the parent
4880 * @param parent The parent object
4881 * @return The new object or NULL if it cannot be created
4883 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4885 * @brief Set the content of the scroller widget (the object to be scrolled around).
4887 * @param obj The scroller object
4888 * @param content The new content object
4890 * Once the content object is set, a previously set one will be deleted.
4891 * If you want to keep that old content object, use the
4892 * elm_scroller_content_unset() function.
4894 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
4896 * @brief Get the content of the scroller widget
4898 * @param obj The slider object
4899 * @return The content that is being used
4901 * Return the content object which is set for this widget
4903 * @see elm_scroller_content_set()
4905 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4907 * @brief Unset the content of the scroller widget
4909 * @param obj The slider object
4910 * @return The content that was being used
4912 * Unparent and return the content object which was set for this widget
4914 * @see elm_scroller_content_set()
4916 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4918 * @brief Set custom theme elements for the scroller
4920 * @param obj The scroller object
4921 * @param widget The widget name to use (default is "scroller")
4922 * @param base The base name to use (default is "base")
4924 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
4926 * @brief Make the scroller minimum size limited to the minimum size of the content
4928 * @param obj The scroller object
4929 * @param w Enable limiting minimum size horizontally
4930 * @param h Enable limiting minimum size vertically
4932 * By default the scroller will be as small as its design allows,
4933 * irrespective of its content. This will make the scroller minimum size the
4934 * right size horizontally and/or vertically to perfectly fit its content in
4937 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
4939 * @brief Show a specific virtual region within the scroller content object
4941 * @param obj The scroller object
4942 * @param x X coordinate of the region
4943 * @param y Y coordinate of the region
4944 * @param w Width of the region
4945 * @param h Height of the region
4947 * This will ensure all (or part if it does not fit) of the designated
4948 * region in the virtual content object (0, 0 starting at the top-left of the
4949 * virtual content object) is shown within the scroller.
4951 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);
4953 * @brief Set the scrollbar visibility policy
4955 * @param obj The scroller object
4956 * @param policy_h Horizontal scrollbar policy
4957 * @param policy_v Vertical scrollbar policy
4959 * This sets the scrollbar visibility policy for the given scroller.
4960 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
4961 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
4962 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
4963 * respectively for the horizontal and vertical scrollbars.
4965 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4967 * @brief Gets scrollbar visibility policy
4969 * @param obj The scroller object
4970 * @param policy_h Horizontal scrollbar policy
4971 * @param policy_v Vertical scrollbar policy
4973 * @see elm_scroller_policy_set()
4975 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
4977 * @brief Get the currently visible content region
4979 * @param obj The scroller object
4980 * @param x X coordinate of the region
4981 * @param y Y coordinate of the region
4982 * @param w Width of the region
4983 * @param h Height of the region
4985 * This gets the current region in the content object that is visible through
4986 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
4987 * w, @p h values pointed to.
4989 * @note All coordinates are relative to the content.
4991 * @see elm_scroller_region_show()
4993 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);
4995 * @brief Get the size of the content object
4997 * @param obj The scroller object
4998 * @param w Width return
4999 * @param h Height return
5001 * This gets the size of the content object of the scroller.
5003 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5005 * @brief Set bouncing behavior
5007 * @param obj The scroller object
5008 * @param h_bounce Will the scroller bounce horizontally or not
5009 * @param v_bounce Will the scroller bounce vertically or not
5011 * When scrolling, the scroller may "bounce" when reaching an edge of the
5012 * content object. This is a visual way to indicate the end has been reached.
5013 * This is enabled by default for both axis. This will set if it is enabled
5014 * for that axis with the boolean parameters for each axis.
5016 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5018 * @brief Get the bounce mode
5020 * @param obj The Scroller object
5021 * @param h_bounce Allow bounce horizontally
5022 * @param v_bounce Allow bounce vertically
5024 * @see elm_scroller_bounce_set()
5026 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5028 * @brief Set scroll page size relative to viewport size.
5030 * @param obj The scroller object
5031 * @param h_pagerel The horizontal page relative size
5032 * @param v_pagerel The vertical page relative size
5034 * The scroller is capable of limiting scrolling by the user to "pages". That
5035 * is to jump by and only show a "whole page" at a time as if the continuous
5036 * area of the scroller content is split into page sized pieces. This sets
5037 * the size of a page relative to the viewport of the scroller. 1.0 is "1
5038 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5039 * axis. This is mutually exclusive with page size
5040 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
5041 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5042 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5045 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5047 * @brief Set scroll page size.
5049 * @param obj The scroller object
5050 * @param h_pagesize The horizontal page size
5051 * @param v_pagesize The vertical page size
5053 * This sets the page size to an absolute fixed value, with 0 turning it off
5056 * @see elm_scroller_page_relative_set()
5058 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5060 * @brief Show a specific virtual region within the scroller content object.
5062 * @param obj The scroller object
5063 * @param x X coordinate of the region
5064 * @param y Y coordinate of the region
5065 * @param w Width of the region
5066 * @param h Height of the region
5068 * This will ensure all (or part if it does not fit) of the designated
5069 * region in the virtual content object (0, 0 starting at the top-left of the
5070 * virtual content object) is shown within the scroller. Unlike
5071 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5072 * to this location (if configuration in general calls for transitions). It
5073 * may not jump immediately to the new location and make take a while and
5074 * show other content along the way.
5076 * @see elm_scroller_region_show()
5078 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);
5080 * @brief Set event propagation on a scroller
5082 * @param obj The scroller object
5083 * @param propagation If propagation is enabled or not
5085 * This enables or disabled event propagation from the scroller content to
5086 * the scroller and its parent. By default event propagation is disabled.
5088 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5090 * @brief Get event propagation for a scroller
5092 * @param obj The scroller object
5093 * @return The propagation state
5095 * This gets the event propagation for a scroller.
5097 * @see elm_scroller_propagate_events_set()
5099 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
5105 * @defgroup Label Label
5107 * @image html img/widget/label/preview-00.png
5108 * @image latex img/widget/label/preview-00.eps
5110 * @brief Widget to display text, with simple html-like markup.
5112 * The Label widget @b doesn't allow text to overflow its boundaries, if the
5113 * text doesn't fit the geometry of the label it will be ellipsized or be
5114 * cut. Elementary provides several themes for this widget:
5115 * @li default - No animation
5116 * @li marker - Centers the text in the label and make it bold by default
5117 * @li slide_long - The entire text appears from the right of the screen and
5118 * slides until it disappears in the left of the screen(reappering on the
5120 * @li slide_short - The text appears in the left of the label and slides to
5121 * the right to show the overflow. When all of the text has been shown the
5122 * position is reset.
5123 * @li slide_bounce - The text appears in the left of the label and slides to
5124 * the right to show the overflow. When all of the text has been shown the
5125 * animation reverses, moving the text to the left.
5127 * Custom themes can of course invent new markup tags and style them any way
5130 * See @ref tutorial_label for a demonstration of how to use a label widget.
5134 * @brief Add a new label to the parent
5136 * @param parent The parent object
5137 * @return The new object or NULL if it cannot be created
5139 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5141 * @brief Set the label on the label object
5143 * @param obj The label object
5144 * @param label The label will be used on the label object
5145 * @deprecated See elm_object_text_set()
5147 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 */
5149 * @brief Get the label used on the label object
5151 * @param obj The label object
5152 * @return The string inside the label
5153 * @deprecated See elm_object_text_get()
5155 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5157 * @brief Set the wrapping behavior of the label
5159 * @param obj The label object
5160 * @param wrap To wrap text or not
5162 * By default no wrapping is done. Possible values for @p wrap are:
5163 * @li ELM_WRAP_NONE - No wrapping
5164 * @li ELM_WRAP_CHAR - wrap between characters
5165 * @li ELM_WRAP_WORD - wrap between words
5166 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5168 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5170 * @brief Get the wrapping behavior of the label
5172 * @param obj The label object
5175 * @see elm_label_line_wrap_set()
5177 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5179 * @brief Set wrap width of the label
5181 * @param obj The label object
5182 * @param w The wrap width in pixels at a minimum where words need to wrap
5184 * This function sets the maximum width size hint of the label.
5186 * @warning This is only relevant if the label is inside a container.
5188 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5190 * @brief Get wrap width of the label
5192 * @param obj The label object
5193 * @return The wrap width in pixels at a minimum where words need to wrap
5195 * @see elm_label_wrap_width_set()
5197 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5199 * @brief Set wrap height of the label
5201 * @param obj The label object
5202 * @param h The wrap height in pixels at a minimum where words need to wrap
5204 * This function sets the maximum height size hint of the label.
5206 * @warning This is only relevant if the label is inside a container.
5208 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5210 * @brief get wrap width of the label
5212 * @param obj The label object
5213 * @return The wrap height in pixels at a minimum where words need to wrap
5215 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5217 * @brief Set the font size on the label object.
5219 * @param obj The label object
5220 * @param size font size
5222 * @warning NEVER use this. It is for hyper-special cases only. use styles
5223 * instead. e.g. "big", "medium", "small" - or better name them by use:
5224 * "title", "footnote", "quote" etc.
5226 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5228 * @brief Set the text color on the label object
5230 * @param obj The label object
5231 * @param r Red property background color of The label object
5232 * @param g Green property background color of The label object
5233 * @param b Blue property background color of The label object
5234 * @param a Alpha property background color of The label object
5236 * @warning NEVER use this. It is for hyper-special cases only. use styles
5237 * instead. e.g. "big", "medium", "small" - or better name them by use:
5238 * "title", "footnote", "quote" etc.
5240 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);
5242 * @brief Set the text align on the label object
5244 * @param obj The label object
5245 * @param align align mode ("left", "center", "right")
5247 * @warning NEVER use this. It is for hyper-special cases only. use styles
5248 * instead. e.g. "big", "medium", "small" - or better name them by use:
5249 * "title", "footnote", "quote" etc.
5251 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5253 * @brief Set background color of the label
5255 * @param obj The label object
5256 * @param r Red property background color of The label object
5257 * @param g Green property background color of The label object
5258 * @param b Blue property background color of The label object
5259 * @param a Alpha property background alpha of The label object
5261 * @warning NEVER use this. It is for hyper-special cases only. use styles
5262 * instead. e.g. "big", "medium", "small" - or better name them by use:
5263 * "title", "footnote", "quote" etc.
5265 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);
5267 * @brief Set the ellipsis behavior of the label
5269 * @param obj The label object
5270 * @param ellipsis To ellipsis text or not
5272 * If set to true and the text doesn't fit in the label an ellipsis("...")
5273 * will be shown at the end of the widget.
5275 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5276 * choosen wrap method was ELM_WRAP_WORD.
5278 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5280 * @brief Set the text slide of the label
5282 * @param obj The label object
5283 * @param slide To start slide or stop
5285 * If set to true the text of the label will slide throught the length of
5288 * @warning This only work with the themes "slide_short", "slide_long" and
5291 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5293 * @brief Get the text slide mode of the label
5295 * @param obj The label object
5296 * @return slide slide mode value
5298 * @see elm_label_slide_set()
5300 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5302 * @brief Set the slide duration(speed) of the label
5304 * @param obj The label object
5305 * @return The duration in seconds in moving text from slide begin position
5306 * to slide end position
5308 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5310 * @brief Get the slide duration(speed) of the label
5312 * @param obj The label object
5313 * @return The duration time in moving text from slide begin position to slide end position
5315 * @see elm_label_slide_duration_set()
5317 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5323 * @defgroup Toggle Toggle
5325 * @image html img/widget/toggle/preview-00.png
5326 * @image latex img/widget/toggle/preview-00.eps
5328 * @brief A toggle is a slider which can be used to toggle between
5329 * two values. It has two states: on and off.
5331 * Signals that you can add callbacks for are:
5332 * @li "changed" - Whenever the toggle value has been changed. Is not called
5333 * until the toggle is released by the cursor (assuming it
5334 * has been triggered by the cursor in the first place).
5336 * @ref tutorial_toggle show how to use a toggle.
5340 * @brief Add a toggle to @p parent.
5342 * @param parent The parent object
5344 * @return The toggle object
5346 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5348 * @brief Sets the label to be displayed with the toggle.
5350 * @param obj The toggle object
5351 * @param label The label to be displayed
5353 * @deprecated use elm_object_text_set() instead.
5355 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5357 * @brief Gets the label of the toggle
5359 * @param obj toggle object
5360 * @return The label of the toggle
5362 * @deprecated use elm_object_text_get() instead.
5364 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5366 * @brief Set the icon used for the toggle
5368 * @param obj The toggle object
5369 * @param icon The icon object for the button
5371 * Once the icon object is set, a previously set one will be deleted
5372 * If you want to keep that old content object, use the
5373 * elm_toggle_icon_unset() function.
5375 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5377 * @brief Get the icon used for the toggle
5379 * @param obj The toggle object
5380 * @return The icon object that is being used
5382 * Return the icon object which is set for this widget.
5384 * @see elm_toggle_icon_set()
5386 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5388 * @brief Unset the icon used for the toggle
5390 * @param obj The toggle object
5391 * @return The icon object that was being used
5393 * Unparent and return the icon object which was set for this widget.
5395 * @see elm_toggle_icon_set()
5397 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5399 * @brief Sets the labels to be associated with the on and off states of the toggle.
5401 * @param obj The toggle object
5402 * @param onlabel The label displayed when the toggle is in the "on" state
5403 * @param offlabel The label displayed when the toggle is in the "off" state
5405 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5407 * @brief Gets the labels associated with the on and off states of the toggle.
5409 * @param obj The toggle object
5410 * @param onlabel A char** to place the onlabel of @p obj into
5411 * @param offlabel A char** to place the offlabel of @p obj into
5413 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5415 * @brief Sets the state of the toggle to @p state.
5417 * @param obj The toggle object
5418 * @param state The state of @p obj
5420 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5422 * @brief Gets the state of the toggle to @p state.
5424 * @param obj The toggle object
5425 * @return The state of @p obj
5427 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5429 * @brief Sets the state pointer of the toggle to @p statep.
5431 * @param obj The toggle object
5432 * @param statep The state pointer of @p obj
5434 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5440 * @defgroup Frame Frame
5442 * @image html img/widget/frame/preview-00.png
5443 * @image latex img/widget/frame/preview-00.eps
5445 * @brief Frame is a widget that holds some content and has a title.
5447 * The default look is a frame with a title, but Frame supports multple
5455 * @li outdent_bottom
5457 * Of all this styles only default shows the title. Frame emits no signals.
5459 * For a detailed example see the @ref tutorial_frame.
5464 * @brief Add a new frame to the parent
5466 * @param parent The parent object
5467 * @return The new object or NULL if it cannot be created
5469 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5471 * @brief Set the frame label
5473 * @param obj The frame object
5474 * @param label The label of this frame object
5476 * @deprecated use elm_object_text_set() instead.
5478 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5480 * @brief Get the frame label
5482 * @param obj The frame object
5484 * @return The label of this frame objet or NULL if unable to get frame
5486 * @deprecated use elm_object_text_get() instead.
5488 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5490 * @brief Set the content of the frame widget
5492 * Once the content object is set, a previously set one will be deleted.
5493 * If you want to keep that old content object, use the
5494 * elm_frame_content_unset() function.
5496 * @param obj The frame object
5497 * @param content The content will be filled in this frame object
5499 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5501 * @brief Get the content of the frame widget
5503 * Return the content object which is set for this widget
5505 * @param obj The frame object
5506 * @return The content that is being used
5508 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5510 * @brief Unset the content of the frame widget
5512 * Unparent and return the content object which was set for this widget
5514 * @param obj The frame object
5515 * @return The content that was being used
5517 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5523 * @defgroup Table Table
5525 * A container widget to arrange other widgets in a table where items can
5526 * also span multiple columns or rows - even overlap (and then be raised or
5527 * lowered accordingly to adjust stacking if they do overlap).
5529 * The followin are examples of how to use a table:
5530 * @li @ref tutorial_table_01
5531 * @li @ref tutorial_table_02
5536 * @brief Add a new table to the parent
5538 * @param parent The parent object
5539 * @return The new object or NULL if it cannot be created
5541 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5543 * @brief Set the homogeneous layout in the table
5545 * @param obj The layout object
5546 * @param homogeneous A boolean to set if the layout is homogeneous in the
5547 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5549 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5551 * @brief Get the current table homogeneous mode.
5553 * @param obj The table object
5554 * @return A boolean to indicating if the layout is homogeneous in the table
5555 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5557 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5559 * @warning <b>Use elm_table_homogeneous_set() instead</b>
5561 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5563 * @warning <b>Use elm_table_homogeneous_get() instead</b>
5565 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5567 * @brief Set padding between cells.
5569 * @param obj The layout object.
5570 * @param horizontal set the horizontal padding.
5571 * @param vertical set the vertical padding.
5573 * Default value is 0.
5575 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5577 * @brief Get padding between cells.
5579 * @param obj The layout object.
5580 * @param horizontal set the horizontal padding.
5581 * @param vertical set the vertical padding.
5583 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5585 * @brief Add a subobject on the table with the coordinates passed
5587 * @param obj The table object
5588 * @param subobj The subobject to be added to the table
5589 * @param x Row number
5590 * @param y Column number
5594 * @note All positioning inside the table is relative to rows and columns, so
5595 * a value of 0 for x and y, means the top left cell of the table, and a
5596 * value of 1 for w and h means @p subobj only takes that 1 cell.
5598 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5600 * @brief Remove child from table.
5602 * @param obj The table object
5603 * @param subobj The subobject
5605 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5607 * @brief Faster way to remove all child objects from a table object.
5609 * @param obj The table object
5610 * @param clear If true, will delete children, else just remove from table.
5612 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5614 * @brief Set the packing location of an existing child of the table
5616 * @param subobj The subobject to be modified in the table
5617 * @param x Row number
5618 * @param y Column number
5622 * Modifies the position of an object already in the table.
5624 * @note All positioning inside the table is relative to rows and columns, so
5625 * a value of 0 for x and y, means the top left cell of the table, and a
5626 * value of 1 for w and h means @p subobj only takes that 1 cell.
5628 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5630 * @brief Get the packing location of an existing child of the table
5632 * @param subobj The subobject to be modified in the table
5633 * @param x Row number
5634 * @param y Column number
5638 * @see elm_table_pack_set()
5640 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5646 * @defgroup Gengrid Gengrid (Generic grid)
5648 * This widget aims to position objects in a grid layout while
5649 * actually creating and rendering only the visible ones, using the
5650 * same idea as the @ref Genlist "genlist": the user defines a @b
5651 * class for each item, specifying functions that will be called at
5652 * object creation, deletion, etc. When those items are selected by
5653 * the user, a callback function is issued. Users may interact with
5654 * a gengrid via the mouse (by clicking on items to select them and
5655 * clicking on the grid's viewport and swiping to pan the whole
5656 * view) or via the keyboard, navigating through item with the
5659 * @section Gengrid_Layouts Gengrid layouts
5661 * Gengrids may layout its items in one of two possible layouts:
5665 * When in "horizontal mode", items will be placed in @b columns,
5666 * from top to bottom and, when the space for a column is filled,
5667 * another one is started on the right, thus expanding the grid
5668 * horizontally, making for horizontal scrolling. When in "vertical
5669 * mode" , though, items will be placed in @b rows, from left to
5670 * right and, when the space for a row is filled, another one is
5671 * started below, thus expanding the grid vertically (and making
5672 * for vertical scrolling).
5674 * @section Gengrid_Items Gengrid items
5676 * An item in a gengrid can have 0 or more text labels (they can be
5677 * regular text or textblock Evas objects - that's up to the style
5678 * to determine), 0 or more icons (which are simply objects
5679 * swallowed into the gengrid item's theming Edje object) and 0 or
5680 * more <b>boolean states</b>, which have the behavior left to the
5681 * user to define. The Edje part names for each of these properties
5682 * will be looked up, in the theme file for the gengrid, under the
5683 * Edje (string) data items named @c "labels", @c "icons" and @c
5684 * "states", respectively. For each of those properties, if more
5685 * than one part is provided, they must have names listed separated
5686 * by spaces in the data fields. For the default gengrid item
5687 * theme, we have @b one label part (@c "elm.text"), @b two icon
5688 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5691 * A gengrid item may be at one of several styles. Elementary
5692 * provides one by default - "default", but this can be extended by
5693 * system or application custom themes/overlays/extensions (see
5694 * @ref Theme "themes" for more details).
5696 * @section Gengrid_Item_Class Gengrid item classes
5698 * In order to have the ability to add and delete items on the fly,
5699 * gengrid implements a class (callback) system where the
5700 * application provides a structure with information about that
5701 * type of item (gengrid may contain multiple different items with
5702 * different classes, states and styles). Gengrid will call the
5703 * functions in this struct (methods) when an item is "realized"
5704 * (i.e., created dynamically, while the user is scrolling the
5705 * grid). All objects will simply be deleted when no longer needed
5706 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5707 * contains the following members:
5708 * - @c item_style - This is a constant string and simply defines
5709 * the name of the item style. It @b must be specified and the
5710 * default should be @c "default".
5711 * - @c func.label_get - This function is called when an item
5712 * object is actually created. The @c data parameter will point to
5713 * the same data passed to elm_gengrid_item_append() and related
5714 * item creation functions. The @c obj parameter is the gengrid
5715 * object itself, while the @c part one is the name string of one
5716 * of the existing text parts in the Edje group implementing the
5717 * item's theme. This function @b must return a strdup'()ed string,
5718 * as the caller will free() it when done. See
5719 * #GridItemLabelGetFunc.
5720 * - @c func.icon_get - This function is called when an item object
5721 * is actually created. The @c data parameter will point to the
5722 * same data passed to elm_gengrid_item_append() and related item
5723 * creation functions. The @c obj parameter is the gengrid object
5724 * itself, while the @c part one is the name string of one of the
5725 * existing (icon) swallow parts in the Edje group implementing the
5726 * item's theme. It must return @c NULL, when no icon is desired,
5727 * or a valid object handle, otherwise. The object will be deleted
5728 * by the gengrid on its deletion or when the item is "unrealized".
5729 * See #GridItemIconGetFunc.
5730 * - @c func.state_get - This function is called when an item
5731 * object is actually created. The @c data parameter will point to
5732 * the same data passed to elm_gengrid_item_append() and related
5733 * item creation functions. The @c obj parameter is the gengrid
5734 * object itself, while the @c part one is the name string of one
5735 * of the state parts in the Edje group implementing the item's
5736 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5737 * true/on. Gengrids will emit a signal to its theming Edje object
5738 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5739 * "source" arguments, respectively, when the state is true (the
5740 * default is false), where @c XXX is the name of the (state) part.
5741 * See #GridItemStateGetFunc.
5742 * - @c func.del - This is called when elm_gengrid_item_del() is
5743 * called on an item or elm_gengrid_clear() is called on the
5744 * gengrid. This is intended for use when gengrid items are
5745 * deleted, so any data attached to the item (e.g. its data
5746 * parameter on creation) can be deleted. See #GridItemDelFunc.
5748 * @section Gengrid_Usage_Hints Usage hints
5750 * If the user wants to have multiple items selected at the same
5751 * time, elm_gengrid_multi_select_set() will permit it. If the
5752 * gengrid is single-selection only (the default), then
5753 * elm_gengrid_select_item_get() will return the selected item or
5754 * @c NULL, if none is selected. If the gengrid is under
5755 * multi-selection, then elm_gengrid_selected_items_get() will
5756 * return a list (that is only valid as long as no items are
5757 * modified (added, deleted, selected or unselected) of child items
5760 * If an item changes (internal (boolean) state, label or icon
5761 * changes), then use elm_gengrid_item_update() to have gengrid
5762 * update the item with the new state. A gengrid will re-"realize"
5763 * the item, thus calling the functions in the
5764 * #Elm_Gengrid_Item_Class set for that item.
5766 * To programmatically (un)select an item, use
5767 * elm_gengrid_item_selected_set(). To get its selected state use
5768 * elm_gengrid_item_selected_get(). To make an item disabled
5769 * (unable to be selected and appear differently) use
5770 * elm_gengrid_item_disabled_set() to set this and
5771 * elm_gengrid_item_disabled_get() to get the disabled state.
5773 * Grid cells will only have their selection smart callbacks called
5774 * when firstly getting selected. Any further clicks will do
5775 * nothing, unless you enable the "always select mode", with
5776 * elm_gengrid_always_select_mode_set(), thus making every click to
5777 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
5778 * turn off the ability to select items entirely in the widget and
5779 * they will neither appear selected nor call the selection smart
5782 * Remember that you can create new styles and add your own theme
5783 * augmentation per application with elm_theme_extension_add(). If
5784 * you absolutely must have a specific style that overrides any
5785 * theme the user or system sets up you can use
5786 * elm_theme_overlay_add() to add such a file.
5788 * @section Gengrid_Smart_Events Gengrid smart events
5790 * Smart events that you can add callbacks for are:
5791 * - @c "activated" - The user has double-clicked or pressed
5792 * (enter|return|spacebar) on an item. The @c event_info parameter
5793 * is the gengrid item that was activated.
5794 * - @c "clicked,double" - The user has double-clicked an item.
5795 * The @c event_info parameter is the gengrid item that was double-clicked.
5796 * - @c "selected" - The user has made an item selected. The
5797 * @c event_info parameter is the gengrid item that was selected.
5798 * - @c "unselected" - The user has made an item unselected. The
5799 * @c event_info parameter is the gengrid item that was unselected.
5800 * - @c "realized" - This is called when the item in the gengrid
5801 * has its implementing Evas object instantiated, de facto. @c
5802 * event_info is the gengrid item that was created. The object
5803 * may be deleted at any time, so it is highly advised to the
5804 * caller @b not to use the object pointer returned from
5805 * elm_gengrid_item_object_get(), because it may point to freed
5807 * - @c "unrealized" - This is called when the implementing Evas
5808 * object for this item is deleted. @c event_info is the gengrid
5809 * item that was deleted.
5810 * - @c "changed" - Called when an item is added, removed, resized
5811 * or moved and when the gengrid is resized or gets "horizontal"
5813 * - @c "drag,start,up" - Called when the item in the gengrid has
5814 * been dragged (not scrolled) up.
5815 * - @c "drag,start,down" - Called when the item in the gengrid has
5816 * been dragged (not scrolled) down.
5817 * - @c "drag,start,left" - Called when the item in the gengrid has
5818 * been dragged (not scrolled) left.
5819 * - @c "drag,start,right" - Called when the item in the gengrid has
5820 * been dragged (not scrolled) right.
5821 * - @c "drag,stop" - Called when the item in the gengrid has
5822 * stopped being dragged.
5823 * - @c "drag" - Called when the item in the gengrid is being
5825 * - @c "scroll" - called when the content has been scrolled
5827 * - @c "scroll,drag,start" - called when dragging the content has
5829 * - @c "scroll,drag,stop" - called when dragging the content has
5832 * List of gendrid examples:
5833 * @li @ref gengrid_example
5837 * @addtogroup Gengrid
5841 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
5842 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
5843 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
5844 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
5845 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
5846 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
5847 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
5850 * @struct _Elm_Gengrid_Item_Class
5852 * Gengrid item class definition. See @ref Gengrid_Item_Class for
5855 struct _Elm_Gengrid_Item_Class
5857 const char *item_style;
5858 struct _Elm_Gengrid_Item_Class_Func
5860 GridItemLabelGetFunc label_get;
5861 GridItemIconGetFunc icon_get;
5862 GridItemStateGetFunc state_get;
5863 GridItemDelFunc del;
5865 }; /**< #Elm_Gengrid_Item_Class member definitions */
5868 * Add a new gengrid widget to the given parent Elementary
5869 * (container) object
5871 * @param parent The parent object
5872 * @return a new gengrid widget handle or @c NULL, on errors
5874 * This function inserts a new gengrid widget on the canvas.
5876 * @see elm_gengrid_item_size_set()
5877 * @see elm_gengrid_horizontal_set()
5878 * @see elm_gengrid_item_append()
5879 * @see elm_gengrid_item_del()
5880 * @see elm_gengrid_clear()
5884 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5887 * Set the size for the items of a given gengrid widget
5889 * @param obj The gengrid object.
5890 * @param w The items' width.
5891 * @param h The items' height;
5893 * A gengrid, after creation, has still no information on the size
5894 * to give to each of its cells. So, you most probably will end up
5895 * with squares one @ref Fingers "finger" wide, the default
5896 * size. Use this function to force a custom size for you items,
5897 * making them as big as you wish.
5899 * @see elm_gengrid_item_size_get()
5903 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5906 * Get the size set for the items of a given gengrid widget
5908 * @param obj The gengrid object.
5909 * @param w Pointer to a variable where to store the items' width.
5910 * @param h Pointer to a variable where to store the items' height.
5912 * @note Use @c NULL pointers on the size values you're not
5913 * interested in: they'll be ignored by the function.
5915 * @see elm_gengrid_item_size_get() for more details
5919 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5922 * Set the items grid's alignment within a given gengrid widget
5924 * @param obj The gengrid object.
5925 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
5926 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
5928 * This sets the alignment of the whole grid of items of a gengrid
5929 * within its given viewport. By default, those values are both
5930 * 0.5, meaning that the gengrid will have its items grid placed
5931 * exactly in the middle of its viewport.
5933 * @note If given alignment values are out of the cited ranges,
5934 * they'll be changed to the nearest boundary values on the valid
5937 * @see elm_gengrid_align_get()
5941 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
5944 * Get the items grid's alignment values within a given gengrid
5947 * @param obj The gengrid object.
5948 * @param align_x Pointer to a variable where to store the
5949 * horizontal alignment.
5950 * @param align_y Pointer to a variable where to store the vertical
5953 * @note Use @c NULL pointers on the alignment values you're not
5954 * interested in: they'll be ignored by the function.
5956 * @see elm_gengrid_align_set() for more details
5960 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
5963 * Set whether a given gengrid widget is or not able have items
5966 * @param obj The gengrid object
5967 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
5968 * @c EINA_FALSE to turn it off
5970 * If a gengrid is set to allow reordering, a click held for more
5971 * than 0.5 over a given item will highlight it specially,
5972 * signalling the gengrid has entered the reordering state. From
5973 * that time on, the user will be able to, while still holding the
5974 * mouse button down, move the item freely in the gengrid's
5975 * viewport, replacing to said item to the locations it goes to.
5976 * The replacements will be animated and, whenever the user
5977 * releases the mouse button, the item being replaced gets a new
5978 * definitive place in the grid.
5980 * @see elm_gengrid_reorder_mode_get()
5984 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5987 * Get whether a given gengrid widget is or not able have items
5990 * @param obj The gengrid object
5991 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
5994 * @see elm_gengrid_reorder_mode_set() for more details
5998 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6001 * Append a new item in a given gengrid widget.
6003 * @param obj The gengrid object.
6004 * @param gic The item class for the item.
6005 * @param data The item data.
6006 * @param func Convenience function called when the item is
6008 * @param func_data Data to be passed to @p func.
6009 * @return A handle to the item added or @c NULL, on errors.
6011 * This adds an item to the beginning of the gengrid.
6013 * @see elm_gengrid_item_prepend()
6014 * @see elm_gengrid_item_insert_before()
6015 * @see elm_gengrid_item_insert_after()
6016 * @see elm_gengrid_item_del()
6020 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);
6023 * Prepend a new item in a given gengrid widget.
6025 * @param obj The gengrid object.
6026 * @param gic The item class for the item.
6027 * @param data The item data.
6028 * @param func Convenience function called when the item is
6030 * @param func_data Data to be passed to @p func.
6031 * @return A handle to the item added or @c NULL, on errors.
6033 * This adds an item to the end of the gengrid.
6035 * @see elm_gengrid_item_append()
6036 * @see elm_gengrid_item_insert_before()
6037 * @see elm_gengrid_item_insert_after()
6038 * @see elm_gengrid_item_del()
6042 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);
6045 * Insert an item before another in a gengrid widget
6047 * @param obj The gengrid object.
6048 * @param gic The item class for the item.
6049 * @param data The item data.
6050 * @param relative The item to place this new one before.
6051 * @param func Convenience function called when the item is
6053 * @param func_data Data to be passed to @p func.
6054 * @return A handle to the item added or @c NULL, on errors.
6056 * This inserts an item before another in the gengrid.
6058 * @see elm_gengrid_item_append()
6059 * @see elm_gengrid_item_prepend()
6060 * @see elm_gengrid_item_insert_after()
6061 * @see elm_gengrid_item_del()
6065 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);
6068 * Insert an item after another in a gengrid widget
6070 * @param obj The gengrid object.
6071 * @param gic The item class for the item.
6072 * @param data The item data.
6073 * @param relative The item to place this new one after.
6074 * @param func Convenience function called when the item is
6076 * @param func_data Data to be passed to @p func.
6077 * @return A handle to the item added or @c NULL, on errors.
6079 * This inserts an item after another in the gengrid.
6081 * @see elm_gengrid_item_append()
6082 * @see elm_gengrid_item_prepend()
6083 * @see elm_gengrid_item_insert_after()
6084 * @see elm_gengrid_item_del()
6088 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);
6090 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);
6092 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);
6095 * Set whether items on a given gengrid widget are to get their
6096 * selection callbacks issued for @b every subsequent selection
6097 * click on them or just for the first click.
6099 * @param obj The gengrid object
6100 * @param always_select @c EINA_TRUE to make items "always
6101 * selected", @c EINA_FALSE, otherwise
6103 * By default, grid items will only call their selection callback
6104 * function when firstly getting selected, any subsequent further
6105 * clicks will do nothing. With this call, you make those
6106 * subsequent clicks also to issue the selection callbacks.
6108 * @note <b>Double clicks</b> will @b always be reported on items.
6110 * @see elm_gengrid_always_select_mode_get()
6114 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6117 * Get whether items on a given gengrid widget have their selection
6118 * callbacks issued for @b every subsequent selection click on them
6119 * or just for the first click.
6121 * @param obj The gengrid object.
6122 * @return @c EINA_TRUE if the gengrid items are "always selected",
6123 * @c EINA_FALSE, otherwise
6125 * @see elm_gengrid_always_select_mode_set() for more details
6129 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6132 * Set whether items on a given gengrid widget can be selected or not.
6134 * @param obj The gengrid object
6135 * @param no_select @c EINA_TRUE to make items selectable,
6136 * @c EINA_FALSE otherwise
6138 * This will make items in @p obj selectable or not. In the latter
6139 * case, any user interacion on the gendrid items will neither make
6140 * them appear selected nor them call their selection callback
6143 * @see elm_gengrid_no_select_mode_get()
6147 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6150 * Get whether items on a given gengrid widget can be selected or
6153 * @param obj The gengrid object
6154 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6157 * @see elm_gengrid_no_select_mode_set() for more details
6161 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6164 * Enable or disable multi-selection in a given gengrid widget
6166 * @param obj The gengrid object.
6167 * @param multi @c EINA_TRUE, to enable multi-selection,
6168 * @c EINA_FALSE to disable it.
6170 * Multi-selection is the ability for one to have @b more than one
6171 * item selected, on a given gengrid, simultaneously. When it is
6172 * enabled, a sequence of clicks on different items will make them
6173 * all selected, progressively. A click on an already selected item
6174 * will unselect it. If interecting via the keyboard,
6175 * multi-selection is enabled while holding the "Shift" key.
6177 * @note By default, multi-selection is @b disabled on gengrids
6179 * @see elm_gengrid_multi_select_get()
6183 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6186 * Get whether multi-selection is enabled or disabled for a given
6189 * @param obj The gengrid object.
6190 * @return @c EINA_TRUE, if multi-selection is enabled, @c
6191 * EINA_FALSE otherwise
6193 * @see elm_gengrid_multi_select_set() for more details
6197 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6200 * Enable or disable bouncing effect for a given gengrid widget
6202 * @param obj The gengrid object
6203 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6204 * @c EINA_FALSE to disable it
6205 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6206 * @c EINA_FALSE to disable it
6208 * The bouncing effect occurs whenever one reaches the gengrid's
6209 * edge's while panning it -- it will scroll past its limits a
6210 * little bit and return to the edge again, in a animated for,
6213 * @note By default, gengrids have bouncing enabled on both axis
6215 * @see elm_gengrid_bounce_get()
6219 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6222 * Get whether bouncing effects are enabled or disabled, for a
6223 * given gengrid widget, on each axis
6225 * @param obj The gengrid object
6226 * @param h_bounce Pointer to a variable where to store the
6227 * horizontal bouncing flag.
6228 * @param v_bounce Pointer to a variable where to store the
6229 * vertical bouncing flag.
6231 * @see elm_gengrid_bounce_set() for more details
6235 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6238 * Set a given gengrid widget's scrolling page size, relative to
6239 * its viewport size.
6241 * @param obj The gengrid object
6242 * @param h_pagerel The horizontal page (relative) size
6243 * @param v_pagerel The vertical page (relative) size
6245 * The gengrid's scroller is capable of binding scrolling by the
6246 * user to "pages". It means that, while scrolling and, specially
6247 * after releasing the mouse button, the grid will @b snap to the
6248 * nearest displaying page's area. When page sizes are set, the
6249 * grid's continuous content area is split into (equal) page sized
6252 * This function sets the size of a page <b>relatively to the
6253 * viewport dimensions</b> of the gengrid, for each axis. A value
6254 * @c 1.0 means "the exact viewport's size", in that axis, while @c
6255 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6256 * a viewport". Sane usable values are, than, between @c 0.0 and @c
6257 * 1.0. Values beyond those will make it behave behave
6258 * inconsistently. If you only want one axis to snap to pages, use
6259 * the value @c 0.0 for the other one.
6261 * There is a function setting page size values in @b absolute
6262 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6263 * is mutually exclusive to this one.
6265 * @see elm_gengrid_page_relative_get()
6269 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6272 * Get a given gengrid widget's scrolling page size, relative to
6273 * its viewport size.
6275 * @param obj The gengrid object
6276 * @param h_pagerel Pointer to a variable where to store the
6277 * horizontal page (relative) size
6278 * @param v_pagerel Pointer to a variable where to store the
6279 * vertical page (relative) size
6281 * @see elm_gengrid_page_relative_set() for more details
6285 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6288 * Set a given gengrid widget's scrolling page size
6290 * @param obj The gengrid object
6291 * @param h_pagerel The horizontal page size, in pixels
6292 * @param v_pagerel The vertical page size, in pixels
6294 * The gengrid's scroller is capable of binding scrolling by the
6295 * user to "pages". It means that, while scrolling and, specially
6296 * after releasing the mouse button, the grid will @b snap to the
6297 * nearest displaying page's area. When page sizes are set, the
6298 * grid's continuous content area is split into (equal) page sized
6301 * This function sets the size of a page of the gengrid, in pixels,
6302 * for each axis. Sane usable values are, between @c 0 and the
6303 * dimensions of @p obj, for each axis. Values beyond those will
6304 * make it behave behave inconsistently. If you only want one axis
6305 * to snap to pages, use the value @c 0 for the other one.
6307 * There is a function setting page size values in @b relative
6308 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6309 * use is mutually exclusive to this one.
6313 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6316 * Set for what direction a given gengrid widget will expand while
6317 * placing its items.
6319 * @param obj The gengrid object.
6320 * @param setting @c EINA_TRUE to make the gengrid expand
6321 * horizontally, @c EINA_FALSE to expand vertically.
6323 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6324 * in @b columns, from top to bottom and, when the space for a
6325 * column is filled, another one is started on the right, thus
6326 * expanding the grid horizontally. When in "vertical mode"
6327 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6328 * to right and, when the space for a row is filled, another one is
6329 * started below, thus expanding the grid vertically.
6331 * @see elm_gengrid_horizontal_get()
6335 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6338 * Get for what direction a given gengrid widget will expand while
6339 * placing its items.
6341 * @param obj The gengrid object.
6342 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6343 * @c EINA_FALSE if it's set to expand vertically.
6345 * @see elm_gengrid_horizontal_set() for more detais
6349 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6352 * Get the first item in a given gengrid widget
6354 * @param obj The gengrid object
6355 * @return The first item's handle or @c NULL, if there are no
6356 * items in @p obj (and on errors)
6358 * This returns the first item in the @p obj's internal list of
6361 * @see elm_gengrid_last_item_get()
6365 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6368 * Get the last item in a given gengrid widget
6370 * @param obj The gengrid object
6371 * @return The last item's handle or @c NULL, if there are no
6372 * items in @p obj (and on errors)
6374 * This returns the last item in the @p obj's internal list of
6377 * @see elm_gengrid_first_item_get()
6381 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6384 * Get the @b next item in a gengrid widget's internal list of items,
6385 * given a handle to one of those items.
6387 * @param item The gengrid item to fetch next from
6388 * @return The item after @p item, or @c NULL if there's none (and
6391 * This returns the item placed after the @p item, on the container
6394 * @see elm_gengrid_item_prev_get()
6398 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6401 * Get the @b previous item in a gengrid widget's internal list of items,
6402 * given a handle to one of those items.
6404 * @param item The gengrid item to fetch previous from
6405 * @return The item before @p item, or @c NULL if there's none (and
6408 * This returns the item placed before the @p item, on the container
6411 * @see elm_gengrid_item_next_get()
6415 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6418 * Get the gengrid object's handle which contains a given gengrid
6421 * @param item The item to fetch the container from
6422 * @return The gengrid (parent) object
6424 * This returns the gengrid object itself that an item belongs to.
6428 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6431 * Remove a gengrid item from the its parent, deleting it.
6433 * @param item The item to be removed.
6434 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6436 * @see elm_gengrid_clear(), to remove all items in a gengrid at
6441 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6444 * Update the contents of a given gengrid item
6446 * @param item The gengrid item
6448 * This updates an item by calling all the item class functions
6449 * again to get the icons, labels and states. Use this when the
6450 * original item data has changed and you want thta changes to be
6455 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6456 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6457 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6460 * Return the data associated to a given gengrid item
6462 * @param item The gengrid item.
6463 * @return the data associated to this item.
6465 * This returns the @c data value passed on the
6466 * elm_gengrid_item_append() and related item addition calls.
6468 * @see elm_gengrid_item_append()
6469 * @see elm_gengrid_item_data_set()
6473 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6476 * Set the data associated to a given gengrid item
6478 * @param item The gengrid item
6479 * @param data The new data pointer to set on it
6481 * This @b overrides the @c data value passed on the
6482 * elm_gengrid_item_append() and related item addition calls. This
6483 * function @b won't call elm_gengrid_item_update() automatically,
6484 * so you'd issue it afterwards if you want to hove the item
6485 * updated to reflect the that new data.
6487 * @see elm_gengrid_item_data_get()
6491 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6494 * Get a given gengrid item's position, relative to the whole
6495 * gengrid's grid area.
6497 * @param item The Gengrid item.
6498 * @param x Pointer to variable where to store the item's <b>row
6500 * @param y Pointer to variable where to store the item's <b>column
6503 * This returns the "logical" position of the item whithin the
6504 * gengrid. For example, @c (0, 1) would stand for first row,
6509 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6512 * Set whether a given gengrid item is selected or not
6514 * @param item The gengrid item
6515 * @param selected Use @c EINA_TRUE, to make it selected, @c
6516 * EINA_FALSE to make it unselected
6518 * This sets the selected state of an item. If multi selection is
6519 * not enabled on the containing gengrid and @p selected is @c
6520 * EINA_TRUE, any other previously selected items will get
6521 * unselected in favor of this new one.
6523 * @see elm_gengrid_item_selected_get()
6527 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6530 * Get whether a given gengrid item is selected or not
6532 * @param item The gengrid item
6533 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6535 * @see elm_gengrid_item_selected_set() for more details
6539 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6542 * Get the real Evas object created to implement the view of a
6543 * given gengrid item
6545 * @param item The gengrid item.
6546 * @return the Evas object implementing this item's view.
6548 * This returns the actual Evas object used to implement the
6549 * specified gengrid item's view. This may be @c NULL, as it may
6550 * not have been created or may have been deleted, at any time, by
6551 * the gengrid. <b>Do not modify this object</b> (move, resize,
6552 * show, hide, etc.), as the gengrid is controlling it. This
6553 * function is for querying, emitting custom signals or hooking
6554 * lower level callbacks for events on that object. Do not delete
6555 * this object under any circumstances.
6557 * @see elm_gengrid_item_data_get()
6561 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6564 * Show the portion of a gengrid's internal grid containing a given
6565 * item, @b immediately.
6567 * @param item The item to display
6569 * This causes gengrid to @b redraw its viewport's contents to the
6570 * region contining the given @p item item, if it is not fully
6573 * @see elm_gengrid_item_bring_in()
6577 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6580 * Animatedly bring in, to the visible are of a gengrid, a given
6583 * @param item The gengrid item to display
6585 * This causes gengrig to jump to the given @p item item and show
6586 * it (by scrolling), if it is not fully visible. This will use
6587 * animation to do so and take a period of time to complete.
6589 * @see elm_gengrid_item_show()
6593 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6596 * Set whether a given gengrid item is disabled or not.
6598 * @param item The gengrid item
6599 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6600 * to enable it back.
6602 * A disabled item cannot be selected or unselected. It will also
6603 * change its appearance, to signal the user it's disabled.
6605 * @see elm_gengrid_item_disabled_get()
6609 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6612 * Get whether a given gengrid item is disabled or not.
6614 * @param item The gengrid item
6615 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6618 * @see elm_gengrid_item_disabled_set() for more details
6622 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6625 * Set the text to be shown in a given gengrid item's tooltips.
6627 * @param item The gengrid item
6628 * @param text The text to set in the content
6630 * This call will setup the text to be used as tooltip to that item
6631 * (analogous to elm_object_tooltip_text_set(), but being item
6632 * tooltips with higher precedence than object tooltips). It can
6633 * have only one tooltip at a time, so any previous tooltip data
6638 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6641 * Set the content to be shown in a given gengrid item's tooltips
6643 * @param item The gengrid item.
6644 * @param func The function returning the tooltip contents.
6645 * @param data What to provide to @a func as callback data/context.
6646 * @param del_cb Called when data is not needed anymore, either when
6647 * another callback replaces @p func, the tooltip is unset with
6648 * elm_gengrid_item_tooltip_unset() or the owner @p item
6649 * dies. This callback receives as its first parameter the
6650 * given @p data, being @c event_info the item handle.
6652 * This call will setup the tooltip's contents to @p item
6653 * (analogous to elm_object_tooltip_content_cb_set(), but being
6654 * item tooltips with higher precedence than object tooltips). It
6655 * can have only one tooltip at a time, so any previous tooltip
6656 * content will get removed. @p func (with @p data) will be called
6657 * every time Elementary needs to show the tooltip and it should
6658 * return a valid Evas object, which will be fully managed by the
6659 * tooltip system, getting deleted when the tooltip is gone.
6663 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);
6666 * Unset a tooltip from a given gengrid item
6668 * @param item gengrid item to remove a previously set tooltip from.
6670 * This call removes any tooltip set on @p item. The callback
6671 * provided as @c del_cb to
6672 * elm_gengrid_item_tooltip_content_cb_set() will be called to
6673 * notify it is not used anymore (and have resources cleaned, if
6676 * @see elm_gengrid_item_tooltip_content_cb_set()
6680 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6683 * Set a different @b style for a given gengrid item's tooltip.
6685 * @param item gengrid item with tooltip set
6686 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6687 * "default", @c "transparent", etc)
6689 * Tooltips can have <b>alternate styles</b> to be displayed on,
6690 * which are defined by the theme set on Elementary. This function
6691 * works analogously as elm_object_tooltip_style_set(), but here
6692 * applied only to gengrid item objects. The default style for
6693 * tooltips is @c "default".
6695 * @note before you set a style you should define a tooltip with
6696 * elm_gengrid_item_tooltip_content_cb_set() or
6697 * elm_gengrid_item_tooltip_text_set()
6699 * @see elm_gengrid_item_tooltip_style_get()
6703 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6706 * Get the style set a given gengrid item's tooltip.
6708 * @param item gengrid item with tooltip already set on.
6709 * @return style the theme style in use, which defaults to
6710 * "default". If the object does not have a tooltip set,
6711 * then @c NULL is returned.
6713 * @see elm_gengrid_item_tooltip_style_set() for more details
6717 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6719 * @brief Disable size restrictions on an object's tooltip
6720 * @param item The tooltip's anchor object
6721 * @param disable If EINA_TRUE, size restrictions are disabled
6722 * @return EINA_FALSE on failure, EINA_TRUE on success
6724 * This function allows a tooltip to expand beyond its parant window's canvas.
6725 * It will instead be limited only by the size of the display.
6727 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6729 * @brief Retrieve size restriction state of an object's tooltip
6730 * @param item The tooltip's anchor object
6731 * @return If EINA_TRUE, size restrictions are disabled
6733 * This function returns whether a tooltip is allowed to expand beyond
6734 * its parant window's canvas.
6735 * It will instead be limited only by the size of the display.
6737 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6739 * Set the type of mouse pointer/cursor decoration to be shown,
6740 * when the mouse pointer is over the given gengrid widget item
6742 * @param item gengrid item to customize cursor on
6743 * @param cursor the cursor type's name
6745 * This function works analogously as elm_object_cursor_set(), but
6746 * here the cursor's changing area is restricted to the item's
6747 * area, and not the whole widget's. Note that that item cursors
6748 * have precedence over widget cursors, so that a mouse over @p
6749 * item will always show cursor @p type.
6751 * If this function is called twice for an object, a previously set
6752 * cursor will be unset on the second call.
6754 * @see elm_object_cursor_set()
6755 * @see elm_gengrid_item_cursor_get()
6756 * @see elm_gengrid_item_cursor_unset()
6760 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6763 * Get the type of mouse pointer/cursor decoration set to be shown,
6764 * when the mouse pointer is over the given gengrid widget item
6766 * @param item gengrid item with custom cursor set
6767 * @return the cursor type's name or @c NULL, if no custom cursors
6768 * were set to @p item (and on errors)
6770 * @see elm_object_cursor_get()
6771 * @see elm_gengrid_item_cursor_set() for more details
6772 * @see elm_gengrid_item_cursor_unset()
6776 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6779 * Unset any custom mouse pointer/cursor decoration set to be
6780 * shown, when the mouse pointer is over the given gengrid widget
6781 * item, thus making it show the @b default cursor again.
6783 * @param item a gengrid item
6785 * Use this call to undo any custom settings on this item's cursor
6786 * decoration, bringing it back to defaults (no custom style set).
6788 * @see elm_object_cursor_unset()
6789 * @see elm_gengrid_item_cursor_set() for more details
6793 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6796 * Set a different @b style for a given custom cursor set for a
6799 * @param item gengrid item with custom cursor set
6800 * @param style the <b>theme style</b> to use (e.g. @c "default",
6801 * @c "transparent", etc)
6803 * This function only makes sense when one is using custom mouse
6804 * cursor decorations <b>defined in a theme file</b> , which can
6805 * have, given a cursor name/type, <b>alternate styles</b> on
6806 * it. It works analogously as elm_object_cursor_style_set(), but
6807 * here applied only to gengrid item objects.
6809 * @warning Before you set a cursor style you should have defined a
6810 * custom cursor previously on the item, with
6811 * elm_gengrid_item_cursor_set()
6813 * @see elm_gengrid_item_cursor_engine_only_set()
6814 * @see elm_gengrid_item_cursor_style_get()
6818 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6821 * Get the current @b style set for a given gengrid item's custom
6824 * @param item gengrid item with custom cursor set.
6825 * @return style the cursor style in use. If the object does not
6826 * have a cursor set, then @c NULL is returned.
6828 * @see elm_gengrid_item_cursor_style_set() for more details
6832 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6835 * Set if the (custom) cursor for a given gengrid item should be
6836 * searched in its theme, also, or should only rely on the
6839 * @param item item with custom (custom) cursor already set on
6840 * @param engine_only Use @c EINA_TRUE to have cursors looked for
6841 * only on those provided by the rendering engine, @c EINA_FALSE to
6842 * have them searched on the widget's theme, as well.
6844 * @note This call is of use only if you've set a custom cursor
6845 * for gengrid items, with elm_gengrid_item_cursor_set().
6847 * @note By default, cursors will only be looked for between those
6848 * provided by the rendering engine.
6852 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6855 * Get if the (custom) cursor for a given gengrid item is being
6856 * searched in its theme, also, or is only relying on the rendering
6859 * @param item a gengrid item
6860 * @return @c EINA_TRUE, if cursors are being looked for only on
6861 * those provided by the rendering engine, @c EINA_FALSE if they
6862 * are being searched on the widget's theme, as well.
6864 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
6868 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6871 * Remove all items from a given gengrid widget
6873 * @param obj The gengrid object.
6875 * This removes (and deletes) all items in @p obj, leaving it
6878 * @see elm_gengrid_item_del(), to remove just one item.
6882 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6885 * Get the selected item in a given gengrid widget
6887 * @param obj The gengrid object.
6888 * @return The selected item's handleor @c NULL, if none is
6889 * selected at the moment (and on errors)
6891 * This returns the selected item in @p obj. If multi selection is
6892 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
6893 * the first item in the list is selected, which might not be very
6894 * useful. For that case, see elm_gengrid_selected_items_get().
6898 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6901 * Get <b>a list</b> of selected items in a given gengrid
6903 * @param obj The gengrid object.
6904 * @return The list of selected items or @c NULL, if none is
6905 * selected at the moment (and on errors)
6907 * This returns a list of the selected items, in the order that
6908 * they appear in the grid. This list is only valid as long as no
6909 * more items are selected or unselected (or unselected implictly
6910 * by deletion). The list contains #Elm_Gengrid_Item pointers as
6913 * @see elm_gengrid_selected_item_get()
6917 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6924 * @defgroup Clock Clock
6926 * @image html img/widget/clock/preview-00.png
6927 * @image latex img/widget/clock/preview-00.eps
6929 * This is a @b digital clock widget. In its default theme, it has a
6930 * vintage "flipping numbers clock" appearance, which will animate
6931 * sheets of individual algarisms individually as time goes by.
6933 * A newly created clock will fetch system's time (already
6934 * considering local time adjustments) to start with, and will tick
6935 * accondingly. It may or may not show seconds.
6937 * Clocks have an @b edition mode. When in it, the sheets will
6938 * display extra arrow indications on the top and bottom and the
6939 * user may click on them to raise or lower the time values. After
6940 * it's told to exit edition mode, it will keep ticking with that
6941 * new time set (it keeps the difference from local time).
6943 * Also, when under edition mode, user clicks on the cited arrows
6944 * which are @b held for some time will make the clock to flip the
6945 * sheet, thus editing the time, continuosly and automatically for
6946 * the user. The interval between sheet flips will keep growing in
6947 * time, so that it helps the user to reach a time which is distant
6950 * The time display is, by default, in military mode (24h), but an
6951 * am/pm indicator may be optionally shown, too, when it will
6954 * Smart callbacks one can register to:
6955 * - "changed" - the clock's user changed the time
6957 * Here is an example on its usage:
6958 * @li @ref clock_example
6967 * Identifiers for which clock digits should be editable, when a
6968 * clock widget is in edition mode. Values may be ORed together to
6969 * make a mask, naturally.
6971 * @see elm_clock_edit_set()
6972 * @see elm_clock_digit_edit_set()
6974 typedef enum _Elm_Clock_Digedit
6976 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
6977 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
6978 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
6979 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
6980 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
6981 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
6982 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
6983 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
6984 } Elm_Clock_Digedit;
6987 * Add a new clock widget to the given parent Elementary
6988 * (container) object
6990 * @param parent The parent object
6991 * @return a new clock widget handle or @c NULL, on errors
6993 * This function inserts a new clock widget on the canvas.
6997 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7000 * Set a clock widget's time, programmatically
7002 * @param obj The clock widget object
7003 * @param hrs The hours to set
7004 * @param min The minutes to set
7005 * @param sec The secondes to set
7007 * This function updates the time that is showed by the clock
7010 * Values @b must be set within the following ranges:
7011 * - 0 - 23, for hours
7012 * - 0 - 59, for minutes
7013 * - 0 - 59, for seconds,
7015 * even if the clock is not in "military" mode.
7017 * @warning The behavior for values set out of those ranges is @b
7022 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7025 * Get a clock widget's time values
7027 * @param obj The clock object
7028 * @param[out] hrs Pointer to the variable to get the hours value
7029 * @param[out] min Pointer to the variable to get the minutes value
7030 * @param[out] sec Pointer to the variable to get the seconds value
7032 * This function gets the time set for @p obj, returning
7033 * it on the variables passed as the arguments to function
7035 * @note Use @c NULL pointers on the time values you're not
7036 * interested in: they'll be ignored by the function.
7040 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7043 * Set whether a given clock widget is under <b>edition mode</b> or
7044 * under (default) displaying-only mode.
7046 * @param obj The clock object
7047 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7048 * put it back to "displaying only" mode
7050 * This function makes a clock's time to be editable or not <b>by
7051 * user interaction</b>. When in edition mode, clocks @b stop
7052 * ticking, until one brings them back to canonical mode. The
7053 * elm_clock_digit_edit_set() function will influence which digits
7054 * of the clock will be editable. By default, all of them will be
7055 * (#ELM_CLOCK_NONE).
7057 * @note am/pm sheets, if being shown, will @b always be editable
7058 * under edition mode.
7060 * @see elm_clock_edit_get()
7064 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7067 * Retrieve whether a given clock widget is under <b>edition
7068 * mode</b> or under (default) displaying-only mode.
7070 * @param obj The clock object
7071 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7074 * This function retrieves whether the clock's time can be edited
7075 * or not by user interaction.
7077 * @see elm_clock_edit_set() for more details
7081 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7084 * Set what digits of the given clock widget should be editable
7085 * when in edition mode.
7087 * @param obj The clock object
7088 * @param digedit Bit mask indicating the digits to be editable
7089 * (values in #Elm_Clock_Digedit).
7091 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7092 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7095 * @see elm_clock_digit_edit_get()
7099 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7102 * Retrieve what digits of the given clock widget should be
7103 * editable when in edition mode.
7105 * @param obj The clock object
7106 * @return Bit mask indicating the digits to be editable
7107 * (values in #Elm_Clock_Digedit).
7109 * @see elm_clock_digit_edit_set() for more details
7113 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7116 * Set if the given clock widget must show hours in military or
7119 * @param obj The clock object
7120 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7123 * This function sets if the clock must show hours in military or
7124 * am/pm mode. In some countries like Brazil the military mode
7125 * (00-24h-format) is used, in opposition to the USA, where the
7126 * am/pm mode is more commonly used.
7128 * @see elm_clock_show_am_pm_get()
7132 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7135 * Get if the given clock widget shows hours in military or am/pm
7138 * @param obj The clock object
7139 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7142 * This function gets if the clock shows hours in military or am/pm
7145 * @see elm_clock_show_am_pm_set() for more details
7149 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7152 * Set if the given clock widget must show time with seconds or not
7154 * @param obj The clock object
7155 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7157 * This function sets if the given clock must show or not elapsed
7158 * seconds. By default, they are @b not shown.
7160 * @see elm_clock_show_seconds_get()
7164 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7167 * Get whether the given clock widget is showing time with seconds
7170 * @param obj The clock object
7171 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7173 * This function gets whether @p obj is showing or not the elapsed
7176 * @see elm_clock_show_seconds_set()
7180 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7183 * Set the interval on time updates for an user mouse button hold
7184 * on clock widgets' time edition.
7186 * @param obj The clock object
7187 * @param interval The (first) interval value in seconds
7189 * This interval value is @b decreased while the user holds the
7190 * mouse pointer either incrementing or decrementing a given the
7191 * clock digit's value.
7193 * This helps the user to get to a given time distant from the
7194 * current one easier/faster, as it will start to flip quicker and
7195 * quicker on mouse button holds.
7197 * The calculation for the next flip interval value, starting from
7198 * the one set with this call, is the previous interval divided by
7199 * 1.05, so it decreases a little bit.
7201 * The default starting interval value for automatic flips is
7204 * @see elm_clock_interval_get()
7208 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7211 * Get the interval on time updates for an user mouse button hold
7212 * on clock widgets' time edition.
7214 * @param obj The clock object
7215 * @return The (first) interval value, in seconds, set on it
7217 * @see elm_clock_interval_set() for more details
7221 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7228 * @defgroup Layout Layout
7230 * @image html img/widget/layout/preview-00.png
7231 * @image latex img/widget/layout/preview-00.eps width=\textwidth
7233 * @image html img/layout-predefined.png
7234 * @image latex img/layout-predefined.eps width=\textwidth
7236 * This is a container widget that takes a standard Edje design file and
7237 * wraps it very thinly in a widget.
7239 * An Edje design (theme) file has a very wide range of possibilities to
7240 * describe the behavior of elements added to the Layout. Check out the Edje
7241 * documentation and the EDC reference to get more information about what can
7242 * be done with Edje.
7244 * Just like @ref List, @ref Box, and other container widgets, any
7245 * object added to the Layout will become its child, meaning that it will be
7246 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7248 * The Layout widget can contain as many Contents, Boxes or Tables as
7249 * described in its theme file. For instance, objects can be added to
7250 * different Tables by specifying the respective Table part names. The same
7251 * is valid for Content and Box.
7253 * The objects added as child of the Layout will behave as described in the
7254 * part description where they were added. There are 3 possible types of
7255 * parts where a child can be added:
7257 * @section secContent Content (SWALLOW part)
7259 * Only one object can be added to the @c SWALLOW part (but you still can
7260 * have many @c SWALLOW parts and one object on each of them). Use the @c
7261 * elm_layout_content_* set of functions to set, retrieve and unset objects
7262 * as content of the @c SWALLOW. After being set to this part, the object
7263 * size, position, visibility, clipping and other description properties
7264 * will be totally controled by the description of the given part (inside
7265 * the Edje theme file).
7267 * One can use @c evas_object_size_hint_* functions on the child to have some
7268 * kind of control over its behavior, but the resulting behavior will still
7269 * depend heavily on the @c SWALLOW part description.
7271 * The Edje theme also can change the part description, based on signals or
7272 * scripts running inside the theme. This change can also be animated. All of
7273 * this will affect the child object set as content accordingly. The object
7274 * size will be changed if the part size is changed, it will animate move if
7275 * the part is moving, and so on.
7277 * The following picture demonstrates a Layout widget with a child object
7278 * added to its @c SWALLOW:
7280 * @image html layout_swallow.png
7281 * @image latex layout_swallow.eps width=\textwidth
7283 * @section secBox Box (BOX part)
7285 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7286 * allows one to add objects to the box and have them distributed along its
7287 * area, accordingly to the specified @a layout property (now by @a layout we
7288 * mean the chosen layouting design of the Box, not the Layout widget
7291 * A similar effect for having a box with its position, size and other things
7292 * controled by the Layout theme would be to create an Elementary @ref Box
7293 * widget and add it as a Content in the @c SWALLOW part.
7295 * The main difference of using the Layout Box is that its behavior, the box
7296 * properties like layouting format, padding, align, etc. will be all
7297 * controled by the theme. This means, for example, that a signal could be
7298 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7299 * handled the signal by changing the box padding, or align, or both. Using
7300 * the Elementary @ref Box widget is not necessarily harder or easier, it
7301 * just depends on the circunstances and requirements.
7303 * The Layout Box can be used through the @c elm_layout_box_* set of
7306 * The following picture demonstrates a Layout widget with many child objects
7307 * added to its @c BOX part:
7309 * @image html layout_box.png
7310 * @image latex layout_box.eps width=\textwidth
7312 * @section secTable Table (TABLE part)
7314 * Just like the @ref secBox, the Layout Table is very similar to the
7315 * Elementary @ref Table widget. It allows one to add objects to the Table
7316 * specifying the row and column where the object should be added, and any
7317 * column or row span if necessary.
7319 * Again, we could have this design by adding a @ref Table widget to the @c
7320 * SWALLOW part using elm_layout_content_set(). The same difference happens
7321 * here when choosing to use the Layout Table (a @c TABLE part) instead of
7322 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7324 * The Layout Table can be used through the @c elm_layout_table_* set of
7327 * The following picture demonstrates a Layout widget with many child objects
7328 * added to its @c TABLE part:
7330 * @image html layout_table.png
7331 * @image latex layout_table.eps width=\textwidth
7333 * @section secPredef Predefined Layouts
7335 * Another interesting thing about the Layout widget is that it offers some
7336 * predefined themes that come with the default Elementary theme. These
7337 * themes can be set by the call elm_layout_theme_set(), and provide some
7338 * basic functionality depending on the theme used.
7340 * Most of them already send some signals, some already provide a toolbar or
7341 * back and next buttons.
7343 * These are available predefined theme layouts. All of them have class = @c
7344 * layout, group = @c application, and style = one of the following options:
7346 * @li @c toolbar-content - application with toolbar and main content area
7347 * @li @c toolbar-content-back - application with toolbar and main content
7348 * area with a back button and title area
7349 * @li @c toolbar-content-back-next - application with toolbar and main
7350 * content area with a back and next buttons and title area
7351 * @li @c content-back - application with a main content area with a back
7352 * button and title area
7353 * @li @c content-back-next - application with a main content area with a
7354 * back and next buttons and title area
7355 * @li @c toolbar-vbox - application with toolbar and main content area as a
7357 * @li @c toolbar-table - application with toolbar and main content area as a
7360 * @section secExamples Examples
7362 * Some examples of the Layout widget can be found here:
7363 * @li @ref layout_example_01
7364 * @li @ref layout_example_02
7365 * @li @ref layout_example_03
7366 * @li @ref layout_example_edc
7371 * Add a new layout to the parent
7373 * @param parent The parent object
7374 * @return The new object or NULL if it cannot be created
7376 * @see elm_layout_file_set()
7377 * @see elm_layout_theme_set()
7381 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7383 * Set the file that will be used as layout
7385 * @param obj The layout object
7386 * @param file The path to file (edj) that will be used as layout
7387 * @param group The group that the layout belongs in edje file
7389 * @return (1 = success, 0 = error)
7393 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7395 * Set the edje group from the elementary theme that will be used as layout
7397 * @param obj The layout object
7398 * @param clas the clas of the group
7399 * @param group the group
7400 * @param style the style to used
7402 * @return (1 = success, 0 = error)
7406 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7408 * Set the layout content.
7410 * @param obj The layout object
7411 * @param swallow The swallow part name in the edje file
7412 * @param content The child that will be added in this layout object
7414 * Once the content object is set, a previously set one will be deleted.
7415 * If you want to keep that old content object, use the
7416 * elm_layout_content_unset() function.
7418 * @note In an Edje theme, the part used as a content container is called @c
7419 * SWALLOW. This is why the parameter name is called @p swallow, but it is
7420 * expected to be a part name just like the second parameter of
7421 * elm_layout_box_append().
7423 * @see elm_layout_box_append()
7424 * @see elm_layout_content_get()
7425 * @see elm_layout_content_unset()
7430 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7432 * Get the child object in the given content part.
7434 * @param obj The layout object
7435 * @param swallow The SWALLOW part to get its content
7437 * @return The swallowed object or NULL if none or an error occurred
7439 * @see elm_layout_content_set()
7443 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7445 * Unset the layout content.
7447 * @param obj The layout object
7448 * @param swallow The swallow part name in the edje file
7449 * @return The content that was being used
7451 * Unparent and return the content object which was set for this part.
7453 * @see elm_layout_content_set()
7457 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7459 * Set the text of the given part
7461 * @param obj The layout object
7462 * @param part The TEXT part where to set the text
7463 * @param text The text to set
7466 * @deprecated use elm_object_text_* instead.
7468 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7470 * Get the text set in the given part
7472 * @param obj The layout object
7473 * @param part The TEXT part to retrieve the text off
7475 * @return The text set in @p part
7478 * @deprecated use elm_object_text_* instead.
7480 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7482 * Append child to layout box part.
7484 * @param obj the layout object
7485 * @param part the box part to which the object will be appended.
7486 * @param child the child object to append to box.
7488 * Once the object is appended, it will become child of the layout. Its
7489 * lifetime will be bound to the layout, whenever the layout dies the child
7490 * will be deleted automatically. One should use elm_layout_box_remove() to
7491 * make this layout forget about the object.
7493 * @see elm_layout_box_prepend()
7494 * @see elm_layout_box_insert_before()
7495 * @see elm_layout_box_insert_at()
7496 * @see elm_layout_box_remove()
7500 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7502 * Prepend child to layout box part.
7504 * @param obj the layout object
7505 * @param part the box part to prepend.
7506 * @param child the child object to prepend to box.
7508 * Once the object is prepended, it will become child of the layout. Its
7509 * lifetime will be bound to the layout, whenever the layout dies the child
7510 * will be deleted automatically. One should use elm_layout_box_remove() to
7511 * make this layout forget about the object.
7513 * @see elm_layout_box_append()
7514 * @see elm_layout_box_insert_before()
7515 * @see elm_layout_box_insert_at()
7516 * @see elm_layout_box_remove()
7520 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7522 * Insert child to layout box part before a reference object.
7524 * @param obj the layout object
7525 * @param part the box part to insert.
7526 * @param child the child object to insert into box.
7527 * @param reference another reference object to insert before in box.
7529 * Once the object is inserted, it will become child of the layout. Its
7530 * lifetime will be bound to the layout, whenever the layout dies the child
7531 * will be deleted automatically. One should use elm_layout_box_remove() to
7532 * make this layout forget about the object.
7534 * @see elm_layout_box_append()
7535 * @see elm_layout_box_prepend()
7536 * @see elm_layout_box_insert_before()
7537 * @see elm_layout_box_remove()
7541 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7543 * Insert child to layout box part at a given position.
7545 * @param obj the layout object
7546 * @param part the box part to insert.
7547 * @param child the child object to insert into box.
7548 * @param pos the numeric position >=0 to insert the child.
7550 * Once the object is inserted, it will become child of the layout. Its
7551 * lifetime will be bound to the layout, whenever the layout dies the child
7552 * will be deleted automatically. One should use elm_layout_box_remove() to
7553 * make this layout forget about the object.
7555 * @see elm_layout_box_append()
7556 * @see elm_layout_box_prepend()
7557 * @see elm_layout_box_insert_before()
7558 * @see elm_layout_box_remove()
7562 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7564 * Remove a child of the given part box.
7566 * @param obj The layout object
7567 * @param part The box part name to remove child.
7568 * @param child The object to remove from box.
7569 * @return The object that was being used, or NULL if not found.
7571 * The object will be removed from the box part and its lifetime will
7572 * not be handled by the layout anymore. This is equivalent to
7573 * elm_layout_content_unset() for box.
7575 * @see elm_layout_box_append()
7576 * @see elm_layout_box_remove_all()
7580 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7582 * Remove all child of the given part box.
7584 * @param obj The layout object
7585 * @param part The box part name to remove child.
7586 * @param clear If EINA_TRUE, then all objects will be deleted as
7587 * well, otherwise they will just be removed and will be
7588 * dangling on the canvas.
7590 * The objects will be removed from the box part and their lifetime will
7591 * not be handled by the layout anymore. This is equivalent to
7592 * elm_layout_box_remove() for all box children.
7594 * @see elm_layout_box_append()
7595 * @see elm_layout_box_remove()
7599 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7601 * Insert child to layout table part.
7603 * @param obj the layout object
7604 * @param part the box part to pack child.
7605 * @param child_obj the child object to pack into table.
7606 * @param col the column to which the child should be added. (>= 0)
7607 * @param row the row to which the child should be added. (>= 0)
7608 * @param colspan how many columns should be used to store this object. (>=
7610 * @param rowspan how many rows should be used to store this object. (>= 1)
7612 * Once the object is inserted, it will become child of the table. Its
7613 * lifetime will be bound to the layout, and whenever the layout dies the
7614 * child will be deleted automatically. One should use
7615 * elm_layout_table_remove() to make this layout forget about the object.
7617 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7618 * more space than a single cell. For instance, the following code:
7620 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7623 * Would result in an object being added like the following picture:
7625 * @image html layout_colspan.png
7626 * @image latex layout_colspan.eps width=\textwidth
7628 * @see elm_layout_table_unpack()
7629 * @see elm_layout_table_clear()
7633 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);
7635 * Unpack (remove) a child of the given part table.
7637 * @param obj The layout object
7638 * @param part The table part name to remove child.
7639 * @param child_obj The object to remove from table.
7640 * @return The object that was being used, or NULL if not found.
7642 * The object will be unpacked from the table part and its lifetime
7643 * will not be handled by the layout anymore. This is equivalent to
7644 * elm_layout_content_unset() for table.
7646 * @see elm_layout_table_pack()
7647 * @see elm_layout_table_clear()
7651 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7653 * Remove all child of the given part table.
7655 * @param obj The layout object
7656 * @param part The table part name to remove child.
7657 * @param clear If EINA_TRUE, then all objects will be deleted as
7658 * well, otherwise they will just be removed and will be
7659 * dangling on the canvas.
7661 * The objects will be removed from the table part and their lifetime will
7662 * not be handled by the layout anymore. This is equivalent to
7663 * elm_layout_table_unpack() for all table children.
7665 * @see elm_layout_table_pack()
7666 * @see elm_layout_table_unpack()
7670 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7672 * Get the edje layout
7674 * @param obj The layout object
7676 * @return A Evas_Object with the edje layout settings loaded
7677 * with function elm_layout_file_set
7679 * This returns the edje object. It is not expected to be used to then
7680 * swallow objects via edje_object_part_swallow() for example. Use
7681 * elm_layout_content_set() instead so child object handling and sizing is
7684 * @note This function should only be used if you really need to call some
7685 * low level Edje function on this edje object. All the common stuff (setting
7686 * text, emitting signals, hooking callbacks to signals, etc.) can be done
7687 * with proper elementary functions.
7689 * @see elm_object_signal_callback_add()
7690 * @see elm_object_signal_emit()
7691 * @see elm_object_text_part_set()
7692 * @see elm_layout_content_set()
7693 * @see elm_layout_box_append()
7694 * @see elm_layout_table_pack()
7695 * @see elm_layout_data_get()
7699 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7701 * Get the edje data from the given layout
7703 * @param obj The layout object
7704 * @param key The data key
7706 * @return The edje data string
7708 * This function fetches data specified inside the edje theme of this layout.
7709 * This function return NULL if data is not found.
7711 * In EDC this comes from a data block within the group block that @p
7712 * obj was loaded from. E.g.
7719 * item: "key1" "value1";
7720 * item: "key2" "value2";
7728 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7732 * @param obj The layout object
7734 * Manually forces a sizing re-evaluation. This is useful when the minimum
7735 * size required by the edje theme of this layout has changed. The change on
7736 * the minimum size required by the edje theme is not immediately reported to
7737 * the elementary layout, so one needs to call this function in order to tell
7738 * the widget (layout) that it needs to reevaluate its own size.
7740 * The minimum size of the theme is calculated based on minimum size of
7741 * parts, the size of elements inside containers like box and table, etc. All
7742 * of this can change due to state changes, and that's when this function
7745 * Also note that a standard signal of "size,eval" "elm" emitted from the
7746 * edje object will cause this to happen too.
7750 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
7751 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
7752 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7753 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7754 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
7755 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7756 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);
7757 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7759 * @def elm_layout_icon_set
7760 * Convienience macro to set the icon object in a layout that follows the
7761 * Elementary naming convention for its parts.
7765 #define elm_layout_icon_set(_ly, _obj) \
7768 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
7769 if ((_obj)) sig = "elm,state,icon,visible"; \
7770 else sig = "elm,state,icon,hidden"; \
7771 elm_object_signal_emit((_ly), sig, "elm"); \
7775 * @def elm_layout_icon_get
7776 * Convienience macro to get the icon object from a layout that follows the
7777 * Elementary naming convention for its parts.
7781 #define elm_layout_icon_get(_ly) \
7782 elm_layout_content_get((_ly), "elm.swallow.icon")
7785 * @def elm_layout_end_set
7786 * Convienience macro to set the end object in a layout that follows the
7787 * Elementary naming convention for its parts.
7791 #define elm_layout_end_set(_ly, _obj) \
7794 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
7795 if ((_obj)) sig = "elm,state,end,visible"; \
7796 else sig = "elm,state,end,hidden"; \
7797 elm_object_signal_emit((_ly), sig, "elm"); \
7801 * @def elm_layout_end_get
7802 * Convienience macro to get the end object in a layout that follows the
7803 * Elementary naming convention for its parts.
7807 #define elm_layout_end_get(_ly) \
7808 elm_layout_content_get((_ly), "elm.swallow.end")
7811 * @def elm_layout_label_set
7812 * Convienience macro to set the label in a layout that follows the
7813 * Elementary naming convention for its parts.
7816 * @deprecated use elm_object_text_* instead.
7818 #define elm_layout_label_set(_ly, _txt) \
7819 elm_layout_text_set((_ly), "elm.text", (_txt))
7822 * @def elm_layout_label_get
7823 * Convienience macro to get the label in a layout that follows the
7824 * Elementary naming convention for its parts.
7827 * @deprecated use elm_object_text_* instead.
7829 #define elm_layout_label_get(_ly) \
7830 elm_layout_text_get((_ly), "elm.text")
7832 /* smart callbacks called:
7833 * "theme,changed" - when elm theme is changed.
7837 * @defgroup Notify Notify
7839 * @image html img/widget/notify/preview-00.png
7840 * @image latex img/widget/notify/preview-00.eps
7842 * Display a container in a particular region of the parent(top, bottom,
7843 * etc. A timeout can be set to automatically hide the notify. This is so
7844 * that, after an evas_object_show() on a notify object, if a timeout was set
7845 * on it, it will @b automatically get hidden after that time.
7847 * Signals that you can add callbacks for are:
7848 * @li "timeout" - when timeout happens on notify and it's hidden
7849 * @li "block,clicked" - when a click outside of the notify happens
7851 * @ref tutorial_notify show usage of the API.
7856 * @brief Possible orient values for notify.
7858 * This values should be used in conjunction to elm_notify_orient_set() to
7859 * set the position in which the notify should appear(relative to its parent)
7860 * and in conjunction with elm_notify_orient_get() to know where the notify
7863 typedef enum _Elm_Notify_Orient
7865 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
7866 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
7867 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
7868 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
7869 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
7870 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
7871 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
7872 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
7873 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
7874 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
7875 } Elm_Notify_Orient;
7877 * @brief Add a new notify to the parent
7879 * @param parent The parent object
7880 * @return The new object or NULL if it cannot be created
7882 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7884 * @brief Set the content of the notify widget
7886 * @param obj The notify object
7887 * @param content The content will be filled in this notify object
7889 * Once the content object is set, a previously set one will be deleted. If
7890 * you want to keep that old content object, use the
7891 * elm_notify_content_unset() function.
7893 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7895 * @brief Unset the content of the notify widget
7897 * @param obj The notify object
7898 * @return The content that was being used
7900 * Unparent and return the content object which was set for this widget
7902 * @see elm_notify_content_set()
7904 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7906 * @brief Return the content of the notify widget
7908 * @param obj The notify object
7909 * @return The content that is being used
7911 * @see elm_notify_content_set()
7913 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7915 * @brief Set the notify parent
7917 * @param obj The notify object
7918 * @param content The new parent
7920 * Once the parent object is set, a previously set one will be disconnected
7923 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7925 * @brief Get the notify parent
7927 * @param obj The notify object
7928 * @return The parent
7930 * @see elm_notify_parent_set()
7932 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7934 * @brief Set the orientation
7936 * @param obj The notify object
7937 * @param orient The new orientation
7939 * Sets the position in which the notify will appear in its parent.
7941 * @see @ref Elm_Notify_Orient for possible values.
7943 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
7945 * @brief Return the orientation
7946 * @param obj The notify object
7947 * @return The orientation of the notification
7949 * @see elm_notify_orient_set()
7950 * @see Elm_Notify_Orient
7952 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7954 * @brief Set the time interval after which the notify window is going to be
7957 * @param obj The notify object
7958 * @param time The timeout in seconds
7960 * This function sets a timeout and starts the timer controlling when the
7961 * notify is hidden. Since calling evas_object_show() on a notify restarts
7962 * the timer controlling when the notify is hidden, setting this before the
7963 * notify is shown will in effect mean starting the timer when the notify is
7966 * @note Set a value <= 0.0 to disable a running timer.
7968 * @note If the value > 0.0 and the notify is previously visible, the
7969 * timer will be started with this value, canceling any running timer.
7971 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7973 * @brief Return the timeout value (in seconds)
7974 * @param obj the notify object
7976 * @see elm_notify_timeout_set()
7978 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7980 * @brief Sets whether events should be passed to by a click outside
7983 * @param obj The notify object
7984 * @param repeats EINA_TRUE Events are repeats, else no
7986 * When true if the user clicks outside the window the events will be caught
7987 * by the others widgets, else the events are blocked.
7989 * @note The default value is EINA_TRUE.
7991 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
7993 * @brief Return true if events are repeat below the notify object
7994 * @param obj the notify object
7996 * @see elm_notify_repeat_events_set()
7998 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8004 * @defgroup Hover Hover
8006 * @image html img/widget/hover/preview-00.png
8007 * @image latex img/widget/hover/preview-00.eps
8009 * A Hover object will hover over its @p parent object at the @p target
8010 * location. Anything in the background will be given a darker coloring to
8011 * indicate that the hover object is on top (at the default theme). When the
8012 * hover is clicked it is dismissed(hidden), if the contents of the hover are
8013 * clicked that @b doesn't cause the hover to be dismissed.
8015 * @note The hover object will take up the entire space of @p target
8018 * Elementary has the following styles for the hover widget:
8022 * @li hoversel_vertical
8024 * The following are the available position for content:
8036 * Signals that you can add callbacks for are:
8037 * @li "clicked" - the user clicked the empty space in the hover to dismiss
8038 * @li "smart,changed" - a content object placed under the "smart"
8039 * policy was replaced to a new slot direction.
8041 * See @ref tutorial_hover for more information.
8045 typedef enum _Elm_Hover_Axis
8047 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8048 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8049 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8050 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8053 * @brief Adds a hover object to @p parent
8055 * @param parent The parent object
8056 * @return The hover object or NULL if one could not be created
8058 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8060 * @brief Sets the target object for the hover.
8062 * @param obj The hover object
8063 * @param target The object to center the hover onto. The hover
8065 * This function will cause the hover to be centered on the target object.
8067 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8069 * @brief Gets the target object for the hover.
8071 * @param obj The hover object
8072 * @param parent The object to locate the hover over.
8074 * @see elm_hover_target_set()
8076 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8078 * @brief Sets the parent object for the hover.
8080 * @param obj The hover object
8081 * @param parent The object to locate the hover over.
8083 * This function will cause the hover to take up the entire space that the
8084 * parent object fills.
8086 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8088 * @brief Gets the parent object for the hover.
8090 * @param obj The hover object
8091 * @return The parent object to locate the hover over.
8093 * @see elm_hover_parent_set()
8095 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8097 * @brief Sets the content of the hover object and the direction in which it
8100 * @param obj The hover object
8101 * @param swallow The direction that the object will be displayed
8102 * at. Accepted values are "left", "top-left", "top", "top-right",
8103 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8105 * @param content The content to place at @p swallow
8107 * Once the content object is set for a given direction, a previously
8108 * set one (on the same direction) will be deleted. If you want to
8109 * keep that old content object, use the elm_hover_content_unset()
8112 * All directions may have contents at the same time, except for
8113 * "smart". This is a special placement hint and its use case
8114 * independs of the calculations coming from
8115 * elm_hover_best_content_location_get(). Its use is for cases when
8116 * one desires only one hover content, but with a dinamic special
8117 * placement within the hover area. The content's geometry, whenever
8118 * it changes, will be used to decide on a best location not
8119 * extrapolating the hover's parent object view to show it in (still
8120 * being the hover's target determinant of its medium part -- move and
8121 * resize it to simulate finger sizes, for example). If one of the
8122 * directions other than "smart" are used, a previously content set
8123 * using it will be deleted, and vice-versa.
8125 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8127 * @brief Get the content of the hover object, in a given direction.
8129 * Return the content object which was set for this widget in the
8130 * @p swallow direction.
8132 * @param obj The hover object
8133 * @param swallow The direction that the object was display at.
8134 * @return The content that was being used
8136 * @see elm_hover_content_set()
8138 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8140 * @brief Unset the content of the hover object, in a given direction.
8142 * Unparent and return the content object set at @p swallow direction.
8144 * @param obj The hover object
8145 * @param swallow The direction that the object was display at.
8146 * @return The content that was being used.
8148 * @see elm_hover_content_set()
8150 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8152 * @brief Returns the best swallow location for content in the hover.
8154 * @param obj The hover object
8155 * @param pref_axis The preferred orientation axis for the hover object to use
8156 * @return The edje location to place content into the hover or @c
8159 * Best is defined here as the location at which there is the most available
8162 * @p pref_axis may be one of
8163 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8164 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8165 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8166 * - @c ELM_HOVER_AXIS_BOTH -- both
8168 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8169 * nescessarily be along the horizontal axis("left" or "right"). If
8170 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8171 * be along the vertical axis("top" or "bottom"). Chossing
8172 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8173 * returned position may be in either axis.
8175 * @see elm_hover_content_set()
8177 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8184 * @defgroup Entry Entry
8186 * @image html img/widget/entry/preview-00.png
8187 * @image latex img/widget/entry/preview-00.eps width=\textwidth
8188 * @image html img/widget/entry/preview-01.png
8189 * @image latex img/widget/entry/preview-01.eps width=\textwidth
8190 * @image html img/widget/entry/preview-02.png
8191 * @image latex img/widget/entry/preview-02.eps width=\textwidth
8192 * @image html img/widget/entry/preview-03.png
8193 * @image latex img/widget/entry/preview-03.eps width=\textwidth
8195 * An entry is a convenience widget which shows a box that the user can
8196 * enter text into. Entries by default don't scroll, so they grow to
8197 * accomodate the entire text, resizing the parent window as needed. This
8198 * can be changed with the elm_entry_scrollable_set() function.
8200 * They can also be single line or multi line (the default) and when set
8201 * to multi line mode they support text wrapping in any of the modes
8202 * indicated by #Elm_Wrap_Type.
8204 * Other features include password mode, filtering of inserted text with
8205 * elm_entry_text_filter_append() and related functions, inline "items" and
8206 * formatted markup text.
8208 * @section entry-markup Formatted text
8210 * The markup tags supported by the Entry are defined by the theme, but
8211 * even when writing new themes or extensions it's a good idea to stick to
8212 * a sane default, to maintain coherency and avoid application breakages.
8213 * Currently defined by the default theme are the following tags:
8214 * @li \<br\>: Inserts a line break.
8215 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8217 * @li \<tab\>: Inserts a tab.
8218 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8220 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8221 * @li \<link\>...\</link\>: Underlines the enclosed text.
8222 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8224 * @section entry-special Special markups
8226 * Besides those used to format text, entries support two special markup
8227 * tags used to insert clickable portions of text or items inlined within
8230 * @subsection entry-anchors Anchors
8232 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8233 * \</a\> tags and an event will be generated when this text is clicked,
8237 * This text is outside <a href=anc-01>but this one is an anchor</a>
8240 * The @c href attribute in the opening tag gives the name that will be
8241 * used to identify the anchor and it can be any valid utf8 string.
8243 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8244 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8245 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8246 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8249 * @subsection entry-items Items
8251 * Inlined in the text, any other @c Evas_Object can be inserted by using
8252 * \<item\> tags this way:
8255 * <item size=16x16 vsize=full href=emoticon/haha></item>
8258 * Just like with anchors, the @c href identifies each item, but these need,
8259 * in addition, to indicate their size, which is done using any one of
8260 * @c size, @c absize or @c relsize attributes. These attributes take their
8261 * value in the WxH format, where W is the width and H the height of the
8264 * @li absize: Absolute pixel size for the item. Whatever value is set will
8265 * be the item's size regardless of any scale value the object may have
8266 * been set to. The final line height will be adjusted to fit larger items.
8267 * @li size: Similar to @c absize, but it's adjusted to the scale value set
8269 * @li relsize: Size is adjusted for the item to fit within the current
8272 * Besides their size, items are specificed a @c vsize value that affects
8273 * how their final size and position are calculated. The possible values
8275 * @li ascent: Item will be placed within the line's baseline and its
8276 * ascent. That is, the height between the line where all characters are
8277 * positioned and the highest point in the line. For @c size and @c absize
8278 * items, the descent value will be added to the total line height to make
8279 * them fit. @c relsize items will be adjusted to fit within this space.
8280 * @li full: Items will be placed between the descent and ascent, or the
8281 * lowest point in the line and its highest.
8283 * The next image shows different configurations of items and how they
8284 * are the previously mentioned options affect their sizes. In all cases,
8285 * the green line indicates the ascent, blue for the baseline and red for
8288 * @image html entry_item.png
8289 * @image latex entry_item.eps width=\textwidth
8291 * And another one to show how size differs from absize. In the first one,
8292 * the scale value is set to 1.0, while the second one is using one of 2.0.
8294 * @image html entry_item_scale.png
8295 * @image latex entry_item_scale.eps width=\textwidth
8297 * After the size for an item is calculated, the entry will request an
8298 * object to place in its space. For this, the functions set with
8299 * elm_entry_item_provider_append() and related functions will be called
8300 * in order until one of them returns a @c non-NULL value. If no providers
8301 * are available, or all of them return @c NULL, then the entry falls back
8302 * to one of the internal defaults, provided the name matches with one of
8305 * All of the following are currently supported:
8308 * - emoticon/angry-shout
8309 * - emoticon/crazy-laugh
8310 * - emoticon/evil-laugh
8312 * - emoticon/goggle-smile
8314 * - emoticon/grumpy-smile
8316 * - emoticon/guilty-smile
8318 * - emoticon/half-smile
8319 * - emoticon/happy-panting
8321 * - emoticon/indifferent
8323 * - emoticon/knowing-grin
8325 * - emoticon/little-bit-sorry
8326 * - emoticon/love-lots
8328 * - emoticon/minimal-smile
8329 * - emoticon/not-happy
8330 * - emoticon/not-impressed
8332 * - emoticon/opensmile
8335 * - emoticon/squint-laugh
8336 * - emoticon/surprised
8337 * - emoticon/suspicious
8338 * - emoticon/tongue-dangling
8339 * - emoticon/tongue-poke
8341 * - emoticon/unhappy
8342 * - emoticon/very-sorry
8345 * - emoticon/worried
8348 * Alternatively, an item may reference an image by its path, using
8349 * the URI form @c file:///path/to/an/image.png and the entry will then
8350 * use that image for the item.
8352 * @section entry-files Loading and saving files
8354 * Entries have convinience functions to load text from a file and save
8355 * changes back to it after a short delay. The automatic saving is enabled
8356 * by default, but can be disabled with elm_entry_autosave_set() and files
8357 * can be loaded directly as plain text or have any markup in them
8358 * recognized. See elm_entry_file_set() for more details.
8360 * @section entry-signals Emitted signals
8362 * This widget emits the following signals:
8364 * @li "changed": The text within the entry was changed.
8365 * @li "changed,user": The text within the entry was changed because of user interaction.
8366 * @li "activated": The enter key was pressed on a single line entry.
8367 * @li "press": A mouse button has been pressed on the entry.
8368 * @li "longpressed": A mouse button has been pressed and held for a couple
8370 * @li "clicked": The entry has been clicked (mouse press and release).
8371 * @li "clicked,double": The entry has been double clicked.
8372 * @li "clicked,triple": The entry has been triple clicked.
8373 * @li "focused": The entry has received focus.
8374 * @li "unfocused": The entry has lost focus.
8375 * @li "selection,paste": A paste of the clipboard contents was requested.
8376 * @li "selection,copy": A copy of the selected text into the clipboard was
8378 * @li "selection,cut": A cut of the selected text into the clipboard was
8380 * @li "selection,start": A selection has begun and no previous selection
8382 * @li "selection,changed": The current selection has changed.
8383 * @li "selection,cleared": The current selection has been cleared.
8384 * @li "cursor,changed": The cursor has changed position.
8385 * @li "anchor,clicked": An anchor has been clicked. The event_info
8386 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8387 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8388 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8389 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8390 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8391 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8392 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8393 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8394 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8395 * @li "preedit,changed": The preedit string has changed.
8397 * @section entry-examples
8399 * An overview of the Entry API can be seen in @ref entry_example_01
8404 * @typedef Elm_Entry_Anchor_Info
8406 * The info sent in the callback for the "anchor,clicked" signals emitted
8409 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8411 * @struct _Elm_Entry_Anchor_Info
8413 * The info sent in the callback for the "anchor,clicked" signals emitted
8416 struct _Elm_Entry_Anchor_Info
8418 const char *name; /**< The name of the anchor, as stated in its href */
8419 int button; /**< The mouse button used to click on it */
8420 Evas_Coord x, /**< Anchor geometry, relative to canvas */
8421 y, /**< Anchor geometry, relative to canvas */
8422 w, /**< Anchor geometry, relative to canvas */
8423 h; /**< Anchor geometry, relative to canvas */
8426 * @typedef Elm_Entry_Filter_Cb
8427 * This callback type is used by entry filters to modify text.
8428 * @param data The data specified as the last param when adding the filter
8429 * @param entry The entry object
8430 * @param text A pointer to the location of the text being filtered. This data can be modified,
8431 * but any additional allocations must be managed by the user.
8432 * @see elm_entry_text_filter_append
8433 * @see elm_entry_text_filter_prepend
8435 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8438 * This adds an entry to @p parent object.
8440 * By default, entries are:
8444 * @li autosave is enabled
8446 * @param parent The parent object
8447 * @return The new object or NULL if it cannot be created
8449 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8451 * Sets the entry to single line mode.
8453 * In single line mode, entries don't ever wrap when the text reaches the
8454 * edge, and instead they keep growing horizontally. Pressing the @c Enter
8455 * key will generate an @c "activate" event instead of adding a new line.
8457 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8458 * and pressing enter will break the text into a different line
8459 * without generating any events.
8461 * @param obj The entry object
8462 * @param single_line If true, the text in the entry
8463 * will be on a single line.
8465 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8467 * Gets whether the entry is set to be single line.
8469 * @param obj The entry object
8470 * @return single_line If true, the text in the entry is set to display
8473 * @see elm_entry_single_line_set()
8475 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8477 * Sets the entry to password mode.
8479 * In password mode, entries are implicitly single line and the display of
8480 * any text in them is replaced with asterisks (*).
8482 * @param obj The entry object
8483 * @param password If true, password mode is enabled.
8485 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8487 * Gets whether the entry is set to password mode.
8489 * @param obj The entry object
8490 * @return If true, the entry is set to display all characters
8493 * @see elm_entry_password_set()
8495 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8497 * This sets the text displayed within the entry to @p entry.
8499 * @param obj The entry object
8500 * @param entry The text to be displayed
8502 * @deprecated Use elm_object_text_set() instead.
8504 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8506 * This returns the text currently shown in object @p entry.
8507 * See also elm_entry_entry_set().
8509 * @param obj The entry object
8510 * @return The currently displayed text or NULL on failure
8512 * @deprecated Use elm_object_text_get() instead.
8514 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8516 * Appends @p entry to the text of the entry.
8518 * Adds the text in @p entry to the end of any text already present in the
8521 * The appended text is subject to any filters set for the widget.
8523 * @param obj The entry object
8524 * @param entry The text to be displayed
8526 * @see elm_entry_text_filter_append()
8528 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8530 * Gets whether the entry is empty.
8532 * Empty means no text at all. If there are any markup tags, like an item
8533 * tag for which no provider finds anything, and no text is displayed, this
8534 * function still returns EINA_FALSE.
8536 * @param obj The entry object
8537 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8539 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8541 * Gets any selected text within the entry.
8543 * If there's any selected text in the entry, this function returns it as
8544 * a string in markup format. NULL is returned if no selection exists or
8545 * if an error occurred.
8547 * The returned value points to an internal string and should not be freed
8548 * or modified in any way. If the @p entry object is deleted or its
8549 * contents are changed, the returned pointer should be considered invalid.
8551 * @param obj The entry object
8552 * @return The selected text within the entry or NULL on failure
8554 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8556 * Inserts the given text into the entry at the current cursor position.
8558 * This inserts text at the cursor position as if it was typed
8559 * by the user (note that this also allows markup which a user
8560 * can't just "type" as it would be converted to escaped text, so this
8561 * call can be used to insert things like emoticon items or bold push/pop
8562 * tags, other font and color change tags etc.)
8564 * If any selection exists, it will be replaced by the inserted text.
8566 * The inserted text is subject to any filters set for the widget.
8568 * @param obj The entry object
8569 * @param entry The text to insert
8571 * @see elm_entry_text_filter_append()
8573 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8575 * Set the line wrap type to use on multi-line entries.
8577 * Sets the wrap type used by the entry to any of the specified in
8578 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8579 * line (without inserting a line break or paragraph separator) when it
8580 * reaches the far edge of the widget.
8582 * Note that this only makes sense for multi-line entries. A widget set
8583 * to be single line will never wrap.
8585 * @param obj The entry object
8586 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8588 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8590 * Gets the wrap mode the entry was set to use.
8592 * @param obj The entry object
8595 * @see also elm_entry_line_wrap_set()
8597 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8599 * Sets if the entry is to be editable or not.
8601 * By default, entries are editable and when focused, any text input by the
8602 * user will be inserted at the current cursor position. But calling this
8603 * function with @p editable as EINA_FALSE will prevent the user from
8604 * inputting text into the entry.
8606 * The only way to change the text of a non-editable entry is to use
8607 * elm_object_text_set(), elm_entry_entry_insert() and other related
8610 * @param obj The entry object
8611 * @param editable If EINA_TRUE, user input will be inserted in the entry,
8612 * if not, the entry is read-only and no user input is allowed.
8614 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8616 * Gets whether the entry is editable or not.
8618 * @param obj The entry object
8619 * @return If true, the entry is editable by the user.
8620 * If false, it is not editable by the user
8622 * @see elm_entry_editable_set()
8624 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8626 * This drops any existing text selection within the entry.
8628 * @param obj The entry object
8630 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8632 * This selects all text within the entry.
8634 * @param obj The entry object
8636 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8638 * This moves the cursor one place to the right within the entry.
8640 * @param obj The entry object
8641 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8643 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8645 * This moves the cursor one place to the left within the entry.
8647 * @param obj The entry object
8648 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8650 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8652 * This moves the cursor one line up within the entry.
8654 * @param obj The entry object
8655 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8657 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8659 * This moves the cursor one line down within the entry.
8661 * @param obj The entry object
8662 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8664 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8666 * This moves the cursor to the beginning of the entry.
8668 * @param obj The entry object
8670 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8672 * This moves the cursor to the end of the entry.
8674 * @param obj The entry object
8676 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8678 * This moves the cursor to the beginning of the current line.
8680 * @param obj The entry object
8682 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8684 * This moves the cursor to the end of the current line.
8686 * @param obj The entry object
8688 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8690 * This begins a selection within the entry as though
8691 * the user were holding down the mouse button to make a selection.
8693 * @param obj The entry object
8695 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8697 * This ends a selection within the entry as though
8698 * the user had just released the mouse button while making a selection.
8700 * @param obj The entry object
8702 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8704 * Gets whether a format node exists at the current cursor position.
8706 * A format node is anything that defines how the text is rendered. It can
8707 * be a visible format node, such as a line break or a paragraph separator,
8708 * or an invisible one, such as bold begin or end tag.
8709 * This function returns whether any format node exists at the current
8712 * @param obj The entry object
8713 * @return EINA_TRUE if the current cursor position contains a format node,
8714 * EINA_FALSE otherwise.
8716 * @see elm_entry_cursor_is_visible_format_get()
8718 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8720 * Gets if the current cursor position holds a visible format node.
8722 * @param obj The entry object
8723 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8724 * if it's an invisible one or no format exists.
8726 * @see elm_entry_cursor_is_format_get()
8728 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8730 * Gets the character pointed by the cursor at its current position.
8732 * This function returns a string with the utf8 character stored at the
8733 * current cursor position.
8734 * Only the text is returned, any format that may exist will not be part
8735 * of the return value.
8737 * @param obj The entry object
8738 * @return The text pointed by the cursors.
8740 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8742 * This function returns the geometry of the cursor.
8744 * It's useful if you want to draw something on the cursor (or where it is),
8745 * or for example in the case of scrolled entry where you want to show the
8748 * @param obj The entry object
8749 * @param x returned geometry
8750 * @param y returned geometry
8751 * @param w returned geometry
8752 * @param h returned geometry
8753 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8755 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);
8757 * Sets the cursor position in the entry to the given value
8759 * The value in @p pos is the index of the character position within the
8760 * contents of the string as returned by elm_entry_cursor_pos_get().
8762 * @param obj The entry object
8763 * @param pos The position of the cursor
8765 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8767 * Retrieves the current position of the cursor in the entry
8769 * @param obj The entry object
8770 * @return The cursor position
8772 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8774 * This executes a "cut" action on the selected text in the entry.
8776 * @param obj The entry object
8778 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
8780 * This executes a "copy" action on the selected text in the entry.
8782 * @param obj The entry object
8784 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
8786 * This executes a "paste" action in the entry.
8788 * @param obj The entry object
8790 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
8792 * This clears and frees the items in a entry's contextual (longpress)
8795 * @param obj The entry object
8797 * @see elm_entry_context_menu_item_add()
8799 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8801 * This adds an item to the entry's contextual menu.
8803 * A longpress on an entry will make the contextual menu show up, if this
8804 * hasn't been disabled with elm_entry_context_menu_disabled_set().
8805 * By default, this menu provides a few options like enabling selection mode,
8806 * which is useful on embedded devices that need to be explicit about it,
8807 * and when a selection exists it also shows the copy and cut actions.
8809 * With this function, developers can add other options to this menu to
8810 * perform any action they deem necessary.
8812 * @param obj The entry object
8813 * @param label The item's text label
8814 * @param icon_file The item's icon file
8815 * @param icon_type The item's icon type
8816 * @param func The callback to execute when the item is clicked
8817 * @param data The data to associate with the item for related functions
8819 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);
8821 * This disables the entry's contextual (longpress) menu.
8823 * @param obj The entry object
8824 * @param disabled If true, the menu is disabled
8826 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8828 * This returns whether the entry's contextual (longpress) menu is
8831 * @param obj The entry object
8832 * @return If true, the menu is disabled
8834 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8836 * This appends a custom item provider to the list for that entry
8838 * This appends the given callback. The list is walked from beginning to end
8839 * with each function called given the item href string in the text. If the
8840 * function returns an object handle other than NULL (it should create an
8841 * object to do this), then this object is used to replace that item. If
8842 * not the next provider is called until one provides an item object, or the
8843 * default provider in entry does.
8845 * @param obj The entry object
8846 * @param func The function called to provide the item object
8847 * @param data The data passed to @p func
8849 * @see @ref entry-items
8851 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);
8853 * This prepends a custom item provider to the list for that entry
8855 * This prepends the given callback. See elm_entry_item_provider_append() for
8858 * @param obj The entry object
8859 * @param func The function called to provide the item object
8860 * @param data The data passed to @p func
8862 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);
8864 * This removes a custom item provider to the list for that entry
8866 * This removes the given callback. See elm_entry_item_provider_append() for
8869 * @param obj The entry object
8870 * @param func The function called to provide the item object
8871 * @param data The data passed to @p func
8873 EAPI void elm_entry_item_provider_remove(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
8875 * Append a filter function for text inserted in the entry
8877 * Append the given callback to the list. This functions will be called
8878 * whenever any text is inserted into the entry, with the text to be inserted
8879 * as a parameter. The callback function is free to alter the text in any way
8880 * it wants, but it must remember to free the given pointer and update it.
8881 * If the new text is to be discarded, the function can free it and set its
8882 * text parameter to NULL. This will also prevent any following filters from
8885 * @param obj The entry object
8886 * @param func The function to use as text filter
8887 * @param data User data to pass to @p func
8889 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8891 * Prepend a filter function for text insdrted in the entry
8893 * Prepend the given callback to the list. See elm_entry_text_filter_append()
8894 * for more information
8896 * @param obj The entry object
8897 * @param func The function to use as text filter
8898 * @param data User data to pass to @p func
8900 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8902 * Remove a filter from the list
8904 * Removes the given callback from the filter list. See
8905 * elm_entry_text_filter_append() for more information.
8907 * @param obj The entry object
8908 * @param func The filter function to remove
8909 * @param data The user data passed when adding the function
8911 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8913 * This converts a markup (HTML-like) string into UTF-8.
8915 * The returned string is a malloc'ed buffer and it should be freed when
8916 * not needed anymore.
8918 * @param s The string (in markup) to be converted
8919 * @return The converted string (in UTF-8). It should be freed.
8921 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8923 * This converts a UTF-8 string into markup (HTML-like).
8925 * The returned string is a malloc'ed buffer and it should be freed when
8926 * not needed anymore.
8928 * @param s The string (in UTF-8) to be converted
8929 * @return The converted string (in markup). It should be freed.
8931 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8933 * This sets the file (and implicitly loads it) for the text to display and
8934 * then edit. All changes are written back to the file after a short delay if
8935 * the entry object is set to autosave (which is the default).
8937 * If the entry had any other file set previously, any changes made to it
8938 * will be saved if the autosave feature is enabled, otherwise, the file
8939 * will be silently discarded and any non-saved changes will be lost.
8941 * @param obj The entry object
8942 * @param file The path to the file to load and save
8943 * @param format The file format
8945 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
8947 * Gets the file being edited by the entry.
8949 * This function can be used to retrieve any file set on the entry for
8950 * edition, along with the format used to load and save it.
8952 * @param obj The entry object
8953 * @param file The path to the file to load and save
8954 * @param format The file format
8956 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
8958 * This function writes any changes made to the file set with
8959 * elm_entry_file_set()
8961 * @param obj The entry object
8963 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
8965 * This sets the entry object to 'autosave' the loaded text file or not.
8967 * @param obj The entry object
8968 * @param autosave Autosave the loaded file or not
8970 * @see elm_entry_file_set()
8972 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
8974 * This gets the entry object's 'autosave' status.
8976 * @param obj The entry object
8977 * @return Autosave the loaded file or not
8979 * @see elm_entry_file_set()
8981 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8983 * Control pasting of text and images for the widget.
8985 * Normally the entry allows both text and images to be pasted. By setting
8986 * textonly to be true, this prevents images from being pasted.
8988 * Note this only changes the behaviour of text.
8990 * @param obj The entry object
8991 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
8994 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
8996 * Getting elm_entry text paste/drop mode.
8998 * In textonly mode, only text may be pasted or dropped into the widget.
9000 * @param obj The entry object
9001 * @return If the widget only accepts text from pastes.
9003 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9005 * Enable or disable scrolling in entry
9007 * Normally the entry is not scrollable unless you enable it with this call.
9009 * @param obj The entry object
9010 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9012 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9014 * Get the scrollable state of the entry
9016 * Normally the entry is not scrollable. This gets the scrollable state
9017 * of the entry. See elm_entry_scrollable_set() for more information.
9019 * @param obj The entry object
9020 * @return The scrollable state
9022 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
9024 * This sets a widget to be displayed to the left of a scrolled entry.
9026 * @param obj The scrolled entry object
9027 * @param icon The widget to display on the left side of the scrolled
9030 * @note A previously set widget will be destroyed.
9031 * @note If the object being set does not have minimum size hints set,
9032 * it won't get properly displayed.
9034 * @see elm_entry_end_set()
9036 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9038 * Gets the leftmost widget of the scrolled entry. This object is
9039 * owned by the scrolled entry and should not be modified.
9041 * @param obj The scrolled entry object
9042 * @return the left widget inside the scroller
9044 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9046 * Unset the leftmost widget of the scrolled entry, unparenting and
9049 * @param obj The scrolled entry object
9050 * @return the previously set icon sub-object of this entry, on
9053 * @see elm_entry_icon_set()
9055 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9057 * Sets the visibility of the left-side widget of the scrolled entry,
9058 * set by elm_entry_icon_set().
9060 * @param obj The scrolled entry object
9061 * @param setting EINA_TRUE if the object should be displayed,
9062 * EINA_FALSE if not.
9064 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9066 * This sets a widget to be displayed to the end of a scrolled entry.
9068 * @param obj The scrolled entry object
9069 * @param end The widget to display on the right side of the scrolled
9072 * @note A previously set widget will be destroyed.
9073 * @note If the object being set does not have minimum size hints set,
9074 * it won't get properly displayed.
9076 * @see elm_entry_icon_set
9078 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9080 * Gets the endmost widget of the scrolled entry. This object is owned
9081 * by the scrolled entry and should not be modified.
9083 * @param obj The scrolled entry object
9084 * @return the right widget inside the scroller
9086 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9088 * Unset the endmost widget of the scrolled entry, unparenting and
9091 * @param obj The scrolled entry object
9092 * @return the previously set icon sub-object of this entry, on
9095 * @see elm_entry_icon_set()
9097 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9099 * Sets the visibility of the end widget of the scrolled entry, set by
9100 * elm_entry_end_set().
9102 * @param obj The scrolled entry object
9103 * @param setting EINA_TRUE if the object should be displayed,
9104 * EINA_FALSE if not.
9106 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9108 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9111 * Setting an entry to single-line mode with elm_entry_single_line_set()
9112 * will automatically disable the display of scrollbars when the entry
9113 * moves inside its scroller.
9115 * @param obj The scrolled entry object
9116 * @param h The horizontal scrollbar policy to apply
9117 * @param v The vertical scrollbar policy to apply
9119 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9121 * This enables/disables bouncing within the entry.
9123 * This function sets whether the entry will bounce when scrolling reaches
9124 * the end of the contained entry.
9126 * @param obj The scrolled entry object
9127 * @param h The horizontal bounce state
9128 * @param v The vertical bounce state
9130 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9132 * Get the bounce mode
9134 * @param obj The Entry object
9135 * @param h_bounce Allow bounce horizontally
9136 * @param v_bounce Allow bounce vertically
9138 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9140 /* pre-made filters for entries */
9142 * @typedef Elm_Entry_Filter_Limit_Size
9144 * Data for the elm_entry_filter_limit_size() entry filter.
9146 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9148 * @struct _Elm_Entry_Filter_Limit_Size
9150 * Data for the elm_entry_filter_limit_size() entry filter.
9152 struct _Elm_Entry_Filter_Limit_Size
9154 int max_char_count; /**< The maximum number of characters allowed. */
9155 int max_byte_count; /**< The maximum number of bytes allowed*/
9158 * Filter inserted text based on user defined character and byte limits
9160 * Add this filter to an entry to limit the characters that it will accept
9161 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9162 * The funtion works on the UTF-8 representation of the string, converting
9163 * it from the set markup, thus not accounting for any format in it.
9165 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9166 * it as data when setting the filter. In it, it's possible to set limits
9167 * by character count or bytes (any of them is disabled if 0), and both can
9168 * be set at the same time. In that case, it first checks for characters,
9171 * The function will cut the inserted text in order to allow only the first
9172 * number of characters that are still allowed. The cut is made in
9173 * characters, even when limiting by bytes, in order to always contain
9174 * valid ones and avoid half unicode characters making it in.
9176 * This filter, like any others, does not apply when setting the entry text
9177 * directly with elm_object_text_set() (or the deprecated
9178 * elm_entry_entry_set()).
9180 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9182 * @typedef Elm_Entry_Filter_Accept_Set
9184 * Data for the elm_entry_filter_accept_set() entry filter.
9186 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9188 * @struct _Elm_Entry_Filter_Accept_Set
9190 * Data for the elm_entry_filter_accept_set() entry filter.
9192 struct _Elm_Entry_Filter_Accept_Set
9194 const char *accepted; /**< Set of characters accepted in the entry. */
9195 const char *rejected; /**< Set of characters rejected from the entry. */
9198 * Filter inserted text based on accepted or rejected sets of characters
9200 * Add this filter to an entry to restrict the set of accepted characters
9201 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9202 * This structure contains both accepted and rejected sets, but they are
9203 * mutually exclusive.
9205 * The @c accepted set takes preference, so if it is set, the filter will
9206 * only work based on the accepted characters, ignoring anything in the
9207 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9209 * In both cases, the function filters by matching utf8 characters to the
9210 * raw markup text, so it can be used to remove formatting tags.
9212 * This filter, like any others, does not apply when setting the entry text
9213 * directly with elm_object_text_set() (or the deprecated
9214 * elm_entry_entry_set()).
9216 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9221 /* composite widgets - these basically put together basic widgets above
9222 * in convenient packages that do more than basic stuff */
9226 * @defgroup Anchorview Anchorview
9228 * @image html img/widget/anchorview/preview-00.png
9229 * @image latex img/widget/anchorview/preview-00.eps
9231 * Anchorview is for displaying text that contains markup with anchors
9232 * like <c>\<a href=1234\>something\</\></c> in it.
9234 * Besides being styled differently, the anchorview widget provides the
9235 * necessary functionality so that clicking on these anchors brings up a
9236 * popup with user defined content such as "call", "add to contacts" or
9237 * "open web page". This popup is provided using the @ref Hover widget.
9239 * This widget is very similar to @ref Anchorblock, so refer to that
9240 * widget for an example. The only difference Anchorview has is that the
9241 * widget is already provided with scrolling functionality, so if the
9242 * text set to it is too large to fit in the given space, it will scroll,
9243 * whereas the @ref Anchorblock widget will keep growing to ensure all the
9244 * text can be displayed.
9246 * This widget emits the following signals:
9247 * @li "anchor,clicked": will be called when an anchor is clicked. The
9248 * @p event_info parameter on the callback will be a pointer of type
9249 * ::Elm_Entry_Anchorview_Info.
9251 * See @ref Anchorblock for an example on how to use both of them.
9260 * @typedef Elm_Entry_Anchorview_Info
9262 * The info sent in the callback for "anchor,clicked" signals emitted by
9263 * the Anchorview widget.
9265 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9267 * @struct _Elm_Entry_Anchorview_Info
9269 * The info sent in the callback for "anchor,clicked" signals emitted by
9270 * the Anchorview widget.
9272 struct _Elm_Entry_Anchorview_Info
9274 const char *name; /**< Name of the anchor, as indicated in its href
9276 int button; /**< The mouse button used to click on it */
9277 Evas_Object *hover; /**< The hover object to use for the popup */
9279 Evas_Coord x, y, w, h;
9280 } anchor, /**< Geometry selection of text used as anchor */
9281 hover_parent; /**< Geometry of the object used as parent by the
9283 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9284 for content on the left side of
9285 the hover. Before calling the
9286 callback, the widget will make the
9287 necessary calculations to check
9288 which sides are fit to be set with
9289 content, based on the position the
9290 hover is activated and its distance
9291 to the edges of its parent object
9293 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9294 the right side of the hover.
9295 See @ref hover_left */
9296 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9297 of the hover. See @ref hover_left */
9298 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9299 below the hover. See @ref
9303 * Add a new Anchorview object
9305 * @param parent The parent object
9306 * @return The new object or NULL if it cannot be created
9308 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9310 * Set the text to show in the anchorview
9312 * Sets the text of the anchorview to @p text. This text can include markup
9313 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9314 * text that will be specially styled and react to click events, ended with
9315 * either of \</a\> or \</\>. When clicked, the anchor will emit an
9316 * "anchor,clicked" signal that you can attach a callback to with
9317 * evas_object_smart_callback_add(). The name of the anchor given in the
9318 * event info struct will be the one set in the href attribute, in this
9321 * Other markup can be used to style the text in different ways, but it's
9322 * up to the style defined in the theme which tags do what.
9323 * @deprecated use elm_object_text_set() instead.
9325 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9327 * Get the markup text set for the anchorview
9329 * Retrieves the text set on the anchorview, with markup tags included.
9331 * @param obj The anchorview object
9332 * @return The markup text set or @c NULL if nothing was set or an error
9334 * @deprecated use elm_object_text_set() instead.
9336 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9338 * Set the parent of the hover popup
9340 * Sets the parent object to use by the hover created by the anchorview
9341 * when an anchor is clicked. See @ref Hover for more details on this.
9342 * If no parent is set, the same anchorview object will be used.
9344 * @param obj The anchorview object
9345 * @param parent The object to use as parent for the hover
9347 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9349 * Get the parent of the hover popup
9351 * Get the object used as parent for the hover created by the anchorview
9352 * widget. See @ref Hover for more details on this.
9354 * @param obj The anchorview object
9355 * @return The object used as parent for the hover, NULL if none is set.
9357 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9359 * Set the style that the hover should use
9361 * When creating the popup hover, anchorview will request that it's
9362 * themed according to @p style.
9364 * @param obj The anchorview object
9365 * @param style The style to use for the underlying hover
9367 * @see elm_object_style_set()
9369 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9371 * Get the style that the hover should use
9373 * Get the style the hover created by anchorview will use.
9375 * @param obj The anchorview object
9376 * @return The style to use by the hover. NULL means the default is used.
9378 * @see elm_object_style_set()
9380 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9382 * Ends the hover popup in the anchorview
9384 * When an anchor is clicked, the anchorview widget will create a hover
9385 * object to use as a popup with user provided content. This function
9386 * terminates this popup, returning the anchorview to its normal state.
9388 * @param obj The anchorview object
9390 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9392 * Set bouncing behaviour when the scrolled content reaches an edge
9394 * Tell the internal scroller object whether it should bounce or not
9395 * when it reaches the respective edges for each axis.
9397 * @param obj The anchorview object
9398 * @param h_bounce Whether to bounce or not in the horizontal axis
9399 * @param v_bounce Whether to bounce or not in the vertical axis
9401 * @see elm_scroller_bounce_set()
9403 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9405 * Get the set bouncing behaviour of the internal scroller
9407 * Get whether the internal scroller should bounce when the edge of each
9408 * axis is reached scrolling.
9410 * @param obj The anchorview object
9411 * @param h_bounce Pointer where to store the bounce state of the horizontal
9413 * @param v_bounce Pointer where to store the bounce state of the vertical
9416 * @see elm_scroller_bounce_get()
9418 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9420 * Appends a custom item provider to the given anchorview
9422 * Appends the given function to the list of items providers. This list is
9423 * called, one function at a time, with the given @p data pointer, the
9424 * anchorview object and, in the @p item parameter, the item name as
9425 * referenced in its href string. Following functions in the list will be
9426 * called in order until one of them returns something different to NULL,
9427 * which should be an Evas_Object which will be used in place of the item
9430 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9431 * href=item/name\>\</item\>
9433 * @param obj The anchorview object
9434 * @param func The function to add to the list of providers
9435 * @param data User data that will be passed to the callback function
9437 * @see elm_entry_item_provider_append()
9439 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);
9441 * Prepend a custom item provider to the given anchorview
9443 * Like elm_anchorview_item_provider_append(), but it adds the function
9444 * @p func to the beginning of the list, instead of the end.
9446 * @param obj The anchorview object
9447 * @param func The function to add to the list of providers
9448 * @param data User data that will be passed to the callback function
9450 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);
9452 * Remove a custom item provider from the list of the given anchorview
9454 * Removes the function and data pairing that matches @p func and @p data.
9455 * That is, unless the same function and same user data are given, the
9456 * function will not be removed from the list. This allows us to add the
9457 * same callback several times, with different @p data pointers and be
9458 * able to remove them later without conflicts.
9460 * @param obj The anchorview object
9461 * @param func The function to remove from the list
9462 * @param data The data matching the function to remove from the list
9464 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);
9471 * @defgroup Anchorblock Anchorblock
9473 * @image html img/widget/anchorblock/preview-00.png
9474 * @image latex img/widget/anchorblock/preview-00.eps
9476 * Anchorblock is for displaying text that contains markup with anchors
9477 * like <c>\<a href=1234\>something\</\></c> in it.
9479 * Besides being styled differently, the anchorblock widget provides the
9480 * necessary functionality so that clicking on these anchors brings up a
9481 * popup with user defined content such as "call", "add to contacts" or
9482 * "open web page". This popup is provided using the @ref Hover widget.
9484 * This widget emits the following signals:
9485 * @li "anchor,clicked": will be called when an anchor is clicked. The
9486 * @p event_info parameter on the callback will be a pointer of type
9487 * ::Elm_Entry_Anchorblock_Info.
9493 * Since examples are usually better than plain words, we might as well
9494 * try @ref tutorial_anchorblock_example "one".
9497 * @addtogroup Anchorblock
9501 * @typedef Elm_Entry_Anchorblock_Info
9503 * The info sent in the callback for "anchor,clicked" signals emitted by
9504 * the Anchorblock widget.
9506 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9508 * @struct _Elm_Entry_Anchorblock_Info
9510 * The info sent in the callback for "anchor,clicked" signals emitted by
9511 * the Anchorblock widget.
9513 struct _Elm_Entry_Anchorblock_Info
9515 const char *name; /**< Name of the anchor, as indicated in its href
9517 int button; /**< The mouse button used to click on it */
9518 Evas_Object *hover; /**< The hover object to use for the popup */
9520 Evas_Coord x, y, w, h;
9521 } anchor, /**< Geometry selection of text used as anchor */
9522 hover_parent; /**< Geometry of the object used as parent by the
9524 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9525 for content on the left side of
9526 the hover. Before calling the
9527 callback, the widget will make the
9528 necessary calculations to check
9529 which sides are fit to be set with
9530 content, based on the position the
9531 hover is activated and its distance
9532 to the edges of its parent object
9534 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9535 the right side of the hover.
9536 See @ref hover_left */
9537 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9538 of the hover. See @ref hover_left */
9539 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9540 below the hover. See @ref
9544 * Add a new Anchorblock object
9546 * @param parent The parent object
9547 * @return The new object or NULL if it cannot be created
9549 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9551 * Set the text to show in the anchorblock
9553 * Sets the text of the anchorblock to @p text. This text can include markup
9554 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9555 * of text that will be specially styled and react to click events, ended
9556 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9557 * "anchor,clicked" signal that you can attach a callback to with
9558 * evas_object_smart_callback_add(). The name of the anchor given in the
9559 * event info struct will be the one set in the href attribute, in this
9562 * Other markup can be used to style the text in different ways, but it's
9563 * up to the style defined in the theme which tags do what.
9564 * @deprecated use elm_object_text_set() instead.
9566 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9568 * Get the markup text set for the anchorblock
9570 * Retrieves the text set on the anchorblock, with markup tags included.
9572 * @param obj The anchorblock object
9573 * @return The markup text set or @c NULL if nothing was set or an error
9575 * @deprecated use elm_object_text_set() instead.
9577 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9579 * Set the parent of the hover popup
9581 * Sets the parent object to use by the hover created by the anchorblock
9582 * when an anchor is clicked. See @ref Hover for more details on this.
9584 * @param obj The anchorblock object
9585 * @param parent The object to use as parent for the hover
9587 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9589 * Get the parent of the hover popup
9591 * Get the object used as parent for the hover created by the anchorblock
9592 * widget. See @ref Hover for more details on this.
9593 * If no parent is set, the same anchorblock object will be used.
9595 * @param obj The anchorblock object
9596 * @return The object used as parent for the hover, NULL if none is set.
9598 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9600 * Set the style that the hover should use
9602 * When creating the popup hover, anchorblock will request that it's
9603 * themed according to @p style.
9605 * @param obj The anchorblock object
9606 * @param style The style to use for the underlying hover
9608 * @see elm_object_style_set()
9610 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9612 * Get the style that the hover should use
9614 * Get the style the hover created by anchorblock will use.
9616 * @param obj The anchorblock object
9617 * @return The style to use by the hover. NULL means the default is used.
9619 * @see elm_object_style_set()
9621 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9623 * Ends the hover popup in the anchorblock
9625 * When an anchor is clicked, the anchorblock widget will create a hover
9626 * object to use as a popup with user provided content. This function
9627 * terminates this popup, returning the anchorblock to its normal state.
9629 * @param obj The anchorblock object
9631 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9633 * Appends a custom item provider to the given anchorblock
9635 * Appends the given function to the list of items providers. This list is
9636 * called, one function at a time, with the given @p data pointer, the
9637 * anchorblock object and, in the @p item parameter, the item name as
9638 * referenced in its href string. Following functions in the list will be
9639 * called in order until one of them returns something different to NULL,
9640 * which should be an Evas_Object which will be used in place of the item
9643 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9644 * href=item/name\>\</item\>
9646 * @param obj The anchorblock object
9647 * @param func The function to add to the list of providers
9648 * @param data User data that will be passed to the callback function
9650 * @see elm_entry_item_provider_append()
9652 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);
9654 * Prepend a custom item provider to the given anchorblock
9656 * Like elm_anchorblock_item_provider_append(), but it adds the function
9657 * @p func to the beginning of the list, instead of the end.
9659 * @param obj The anchorblock object
9660 * @param func The function to add to the list of providers
9661 * @param data User data that will be passed to the callback function
9663 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);
9665 * Remove a custom item provider from the list of the given anchorblock
9667 * Removes the function and data pairing that matches @p func and @p data.
9668 * That is, unless the same function and same user data are given, the
9669 * function will not be removed from the list. This allows us to add the
9670 * same callback several times, with different @p data pointers and be
9671 * able to remove them later without conflicts.
9673 * @param obj The anchorblock object
9674 * @param func The function to remove from the list
9675 * @param data The data matching the function to remove from the list
9677 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);
9683 * @defgroup Bubble Bubble
9685 * @image html img/widget/bubble/preview-00.png
9686 * @image html img/widget/bubble/preview-01.png
9687 * @image html img/widget/bubble/preview-02.png
9689 * @brief The Bubble is a widget to show text similarly to how speech is
9690 * represented in comics.
9692 * The bubble widget contains 5 important visual elements:
9693 * @li The frame is a rectangle with rounded rectangles and an "arrow".
9694 * @li The @p icon is an image to which the frame's arrow points to.
9695 * @li The @p label is a text which appears to the right of the icon if the
9696 * corner is "top_left" or "bottom_left" and is right aligned to the frame
9698 * @li The @p info is a text which appears to the right of the label. Info's
9699 * font is of a ligther color than label.
9700 * @li The @p content is an evas object that is shown inside the frame.
9702 * The position of the arrow, icon, label and info depends on which corner is
9703 * selected. The four available corners are:
9704 * @li "top_left" - Default
9707 * @li "bottom_right"
9709 * Signals that you can add callbacks for are:
9710 * @li "clicked" - This is called when a user has clicked the bubble.
9712 * For an example of using a buble see @ref bubble_01_example_page "this".
9717 * Add a new bubble to the parent
9719 * @param parent The parent object
9720 * @return The new object or NULL if it cannot be created
9722 * This function adds a text bubble to the given parent evas object.
9724 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9726 * Set the label of the bubble
9728 * @param obj The bubble object
9729 * @param label The string to set in the label
9731 * This function sets the title of the bubble. Where this appears depends on
9732 * the selected corner.
9733 * @deprecated use elm_object_text_set() instead.
9735 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9737 * Get the label of the bubble
9739 * @param obj The bubble object
9740 * @return The string of set in the label
9742 * This function gets the title of the bubble.
9743 * @deprecated use elm_object_text_set() instead.
9745 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9747 * Set the info of the bubble
9749 * @param obj The bubble object
9750 * @param info The given info about the bubble
9752 * This function sets the info of the bubble. Where this appears depends on
9753 * the selected corner.
9754 * @deprecated use elm_object_text_set() instead.
9756 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
9758 * Get the info of the bubble
9760 * @param obj The bubble object
9762 * @return The "info" string of the bubble
9764 * This function gets the info text.
9765 * @deprecated use elm_object_text_set() instead.
9767 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9769 * Set the content to be shown in the bubble
9771 * Once the content object is set, a previously set one will be deleted.
9772 * If you want to keep the old content object, use the
9773 * elm_bubble_content_unset() function.
9775 * @param obj The bubble object
9776 * @param content The given content of the bubble
9778 * This function sets the content shown on the middle of the bubble.
9780 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9782 * Get the content shown in the bubble
9784 * Return the content object which is set for this widget.
9786 * @param obj The bubble object
9787 * @return The content that is being used
9789 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9791 * Unset the content shown in the bubble
9793 * Unparent and return the content object which was set for this widget.
9795 * @param obj The bubble object
9796 * @return The content that was being used
9798 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9800 * Set the icon of the bubble
9802 * Once the icon object is set, a previously set one will be deleted.
9803 * If you want to keep the old content object, use the
9804 * elm_icon_content_unset() function.
9806 * @param obj The bubble object
9807 * @param icon The given icon for the bubble
9809 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9811 * Get the icon of the bubble
9813 * @param obj The bubble object
9814 * @return The icon for the bubble
9816 * This function gets the icon shown on the top left of bubble.
9818 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9820 * Unset the icon of the bubble
9822 * Unparent and return the icon object which was set for this widget.
9824 * @param obj The bubble object
9825 * @return The icon that was being used
9827 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9829 * Set the corner of the bubble
9831 * @param obj The bubble object.
9832 * @param corner The given corner for the bubble.
9834 * This function sets the corner of the bubble. The corner will be used to
9835 * determine where the arrow in the frame points to and where label, icon and
9838 * Possible values for corner are:
9839 * @li "top_left" - Default
9842 * @li "bottom_right"
9844 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
9846 * Get the corner of the bubble
9848 * @param obj The bubble object.
9849 * @return The given corner for the bubble.
9851 * This function gets the selected corner of the bubble.
9853 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9859 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9860 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
9861 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
9862 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
9863 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
9864 /* smart callbacks called:
9865 * "clicked" - the user clicked the icon
9866 * "drag,start" - Someone started dragging the image out of the object
9867 * "drag,end" - Dragged item was dropped (somewhere)
9872 * @defgroup Elm_Gesture_Layer Gesture Layer
9873 * Gesture Layer Usage:
9875 * Use Gesture Layer to detect gestures.
9876 * The advantage is that you don't have to implement
9877 * gesture detection, just set callbacks of gesture state.
9878 * By using gesture layer we make standard interface.
9880 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
9881 * with a parent object parameter.
9882 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
9883 * call. Usually with same object as target (2nd parameter).
9885 * Now you need to tell gesture layer what gestures you follow.
9886 * This is done with @ref elm_gesture_layer_cb_set call.
9887 * By setting the callback you actually saying to gesture layer:
9888 * I would like to know when the gesture @ref Elm_Gesture_Types
9889 * switches to state @ref Elm_Gesture_State.
9891 * Next, you need to implement the actual action that follows the input
9894 * Note that if you like to stop being reported about a gesture, just set
9895 * all callbacks referring this gesture to NULL.
9896 * (again with @ref elm_gesture_layer_cb_set)
9898 * The information reported by gesture layer to your callback is depending
9899 * on @ref Elm_Gesture_Types:
9900 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
9901 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
9902 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
9904 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
9905 * @ref ELM_GESTURE_MOMENTUM.
9907 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
9908 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
9909 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
9910 * Note that we consider a flick as a line-gesture that should be completed
9911 * in flick-time-limit as defined in @ref Config.
9913 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
9915 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
9919 * @enum _Elm_Gesture_Types
9920 * Enum of supported gesture types.
9921 * @ingroup Elm_Gesture_Layer
9923 enum _Elm_Gesture_Types
9925 ELM_GESTURE_FIRST = 0,
9927 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
9928 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
9929 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
9930 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
9932 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
9934 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
9935 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
9937 ELM_GESTURE_ZOOM, /**< Zoom */
9938 ELM_GESTURE_ROTATE, /**< Rotate */
9944 * @typedef Elm_Gesture_Types
9945 * gesture types enum
9946 * @ingroup Elm_Gesture_Layer
9948 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
9951 * @enum _Elm_Gesture_State
9952 * Enum of gesture states.
9953 * @ingroup Elm_Gesture_Layer
9955 enum _Elm_Gesture_State
9957 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
9958 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
9959 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
9960 ELM_GESTURE_STATE_END, /**< Gesture completed */
9961 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
9965 * @typedef Elm_Gesture_State
9966 * gesture states enum
9967 * @ingroup Elm_Gesture_Layer
9969 typedef enum _Elm_Gesture_State Elm_Gesture_State;
9972 * @struct _Elm_Gesture_Taps_Info
9973 * Struct holds taps info for user
9974 * @ingroup Elm_Gesture_Layer
9976 struct _Elm_Gesture_Taps_Info
9978 Evas_Coord x, y; /**< Holds center point between fingers */
9979 unsigned int n; /**< Number of fingers tapped */
9980 unsigned int timestamp; /**< event timestamp */
9984 * @typedef Elm_Gesture_Taps_Info
9985 * holds taps info for user
9986 * @ingroup Elm_Gesture_Layer
9988 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
9991 * @struct _Elm_Gesture_Momentum_Info
9992 * Struct holds momentum info for user
9993 * x1 and y1 are not necessarily in sync
9994 * x1 holds x value of x direction starting point
9995 * and same holds for y1.
9996 * This is noticeable when doing V-shape movement
9997 * @ingroup Elm_Gesture_Layer
9999 struct _Elm_Gesture_Momentum_Info
10000 { /* Report line ends, timestamps, and momentum computed */
10001 Evas_Coord x1; /**< Final-swipe direction starting point on X */
10002 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
10003 Evas_Coord x2; /**< Final-swipe direction ending point on X */
10004 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
10006 unsigned int tx; /**< Timestamp of start of final x-swipe */
10007 unsigned int ty; /**< Timestamp of start of final y-swipe */
10009 Evas_Coord mx; /**< Momentum on X */
10010 Evas_Coord my; /**< Momentum on Y */
10014 * @typedef Elm_Gesture_Momentum_Info
10015 * holds momentum info for user
10016 * @ingroup Elm_Gesture_Layer
10018 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10021 * @struct _Elm_Gesture_Line_Info
10022 * Struct holds line info for user
10023 * @ingroup Elm_Gesture_Layer
10025 struct _Elm_Gesture_Line_Info
10026 { /* Report line ends, timestamps, and momentum computed */
10027 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10028 unsigned int n; /**< Number of fingers (lines) */
10029 /* FIXME should be radians, bot degrees */
10030 double angle; /**< Angle (direction) of lines */
10034 * @typedef Elm_Gesture_Line_Info
10035 * Holds line info for user
10036 * @ingroup Elm_Gesture_Layer
10038 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10041 * @struct _Elm_Gesture_Zoom_Info
10042 * Struct holds zoom info for user
10043 * @ingroup Elm_Gesture_Layer
10045 struct _Elm_Gesture_Zoom_Info
10047 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10048 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10049 double zoom; /**< Zoom value: 1.0 means no zoom */
10050 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10054 * @typedef Elm_Gesture_Zoom_Info
10055 * Holds zoom info for user
10056 * @ingroup Elm_Gesture_Layer
10058 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10061 * @struct _Elm_Gesture_Rotate_Info
10062 * Struct holds rotation info for user
10063 * @ingroup Elm_Gesture_Layer
10065 struct _Elm_Gesture_Rotate_Info
10067 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10068 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10069 double base_angle; /**< Holds start-angle */
10070 double angle; /**< Rotation value: 0.0 means no rotation */
10071 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10075 * @typedef Elm_Gesture_Rotate_Info
10076 * Holds rotation info for user
10077 * @ingroup Elm_Gesture_Layer
10079 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10082 * @typedef Elm_Gesture_Event_Cb
10083 * User callback used to stream gesture info from gesture layer
10084 * @param data user data
10085 * @param event_info gesture report info
10086 * Returns a flag field to be applied on the causing event.
10087 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10088 * upon the event, in an irreversible way.
10090 * @ingroup Elm_Gesture_Layer
10092 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10095 * Use function to set callbacks to be notified about
10096 * change of state of gesture.
10097 * When a user registers a callback with this function
10098 * this means this gesture has to be tested.
10100 * When ALL callbacks for a gesture are set to NULL
10101 * it means user isn't interested in gesture-state
10102 * and it will not be tested.
10104 * @param obj Pointer to gesture-layer.
10105 * @param idx The gesture you would like to track its state.
10106 * @param cb callback function pointer.
10107 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10108 * @param data user info to be sent to callback (usually, Smart Data)
10110 * @ingroup Elm_Gesture_Layer
10112 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);
10115 * Call this function to get repeat-events settings.
10117 * @param obj Pointer to gesture-layer.
10119 * @return repeat events settings.
10120 * @see elm_gesture_layer_hold_events_set()
10121 * @ingroup Elm_Gesture_Layer
10123 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10126 * This function called in order to make gesture-layer repeat events.
10127 * Set this of you like to get the raw events only if gestures were not detected.
10128 * Clear this if you like gesture layer to fwd events as testing gestures.
10130 * @param obj Pointer to gesture-layer.
10131 * @param r Repeat: TRUE/FALSE
10133 * @ingroup Elm_Gesture_Layer
10135 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10138 * This function sets step-value for zoom action.
10139 * Set step to any positive value.
10140 * Cancel step setting by setting to 0.0
10142 * @param obj Pointer to gesture-layer.
10143 * @param s new zoom step value.
10145 * @ingroup Elm_Gesture_Layer
10147 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10150 * This function sets step-value for rotate action.
10151 * Set step to any positive value.
10152 * Cancel step setting by setting to 0.0
10154 * @param obj Pointer to gesture-layer.
10155 * @param s new roatate step value.
10157 * @ingroup Elm_Gesture_Layer
10159 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10162 * This function called to attach gesture-layer to an Evas_Object.
10163 * @param obj Pointer to gesture-layer.
10164 * @param t Pointer to underlying object (AKA Target)
10166 * @return TRUE, FALSE on success, failure.
10168 * @ingroup Elm_Gesture_Layer
10170 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10173 * Call this function to construct a new gesture-layer object.
10174 * This does not activate the gesture layer. You have to
10175 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10177 * @param parent the parent object.
10179 * @return Pointer to new gesture-layer object.
10181 * @ingroup Elm_Gesture_Layer
10183 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10186 * @defgroup Thumb Thumb
10188 * @image html img/widget/thumb/preview-00.png
10189 * @image latex img/widget/thumb/preview-00.eps
10191 * A thumb object is used for displaying the thumbnail of an image or video.
10192 * You must have compiled Elementary with Ethumb_Client support and the DBus
10193 * service must be present and auto-activated in order to have thumbnails to
10196 * Once the thumbnail object becomes visible, it will check if there is a
10197 * previously generated thumbnail image for the file set on it. If not, it
10198 * will start generating this thumbnail.
10200 * Different config settings will cause different thumbnails to be generated
10201 * even on the same file.
10203 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10204 * Ethumb documentation to change this path, and to see other configuration
10207 * Signals that you can add callbacks for are:
10209 * - "clicked" - This is called when a user has clicked the thumb without dragging
10211 * - "clicked,double" - This is called when a user has double-clicked the thumb.
10212 * - "press" - This is called when a user has pressed down the thumb.
10213 * - "generate,start" - The thumbnail generation started.
10214 * - "generate,stop" - The generation process stopped.
10215 * - "generate,error" - The generation failed.
10216 * - "load,error" - The thumbnail image loading failed.
10218 * available styles:
10222 * An example of use of thumbnail:
10224 * - @ref thumb_example_01
10228 * @addtogroup Thumb
10233 * @enum _Elm_Thumb_Animation_Setting
10234 * @typedef Elm_Thumb_Animation_Setting
10236 * Used to set if a video thumbnail is animating or not.
10240 typedef enum _Elm_Thumb_Animation_Setting
10242 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10243 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
10244 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
10245 ELM_THUMB_ANIMATION_LAST
10246 } Elm_Thumb_Animation_Setting;
10249 * Add a new thumb object to the parent.
10251 * @param parent The parent object.
10252 * @return The new object or NULL if it cannot be created.
10254 * @see elm_thumb_file_set()
10255 * @see elm_thumb_ethumb_client_get()
10259 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10261 * Reload thumbnail if it was generated before.
10263 * @param obj The thumb object to reload
10265 * This is useful if the ethumb client configuration changed, like its
10266 * size, aspect or any other property one set in the handle returned
10267 * by elm_thumb_ethumb_client_get().
10269 * If the options didn't change, the thumbnail won't be generated again, but
10270 * the old one will still be used.
10272 * @see elm_thumb_file_set()
10276 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10278 * Set the file that will be used as thumbnail.
10280 * @param obj The thumb object.
10281 * @param file The path to file that will be used as thumb.
10282 * @param key The key used in case of an EET file.
10284 * The file can be an image or a video (in that case, acceptable extensions are:
10285 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10286 * function elm_thumb_animate().
10288 * @see elm_thumb_file_get()
10289 * @see elm_thumb_reload()
10290 * @see elm_thumb_animate()
10294 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10296 * Get the image or video path and key used to generate the thumbnail.
10298 * @param obj The thumb object.
10299 * @param file Pointer to filename.
10300 * @param key Pointer to key.
10302 * @see elm_thumb_file_set()
10303 * @see elm_thumb_path_get()
10307 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10309 * Get the path and key to the image or video generated by ethumb.
10311 * One just need to make sure that the thumbnail was generated before getting
10312 * its path; otherwise, the path will be NULL. One way to do that is by asking
10313 * for the path when/after the "generate,stop" smart callback is called.
10315 * @param obj The thumb object.
10316 * @param file Pointer to thumb path.
10317 * @param key Pointer to thumb key.
10319 * @see elm_thumb_file_get()
10323 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10325 * Set the animation state for the thumb object. If its content is an animated
10326 * video, you may start/stop the animation or tell it to play continuously and
10329 * @param obj The thumb object.
10330 * @param setting The animation setting.
10332 * @see elm_thumb_file_set()
10336 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10338 * Get the animation state for the thumb object.
10340 * @param obj The thumb object.
10341 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10344 * @see elm_thumb_animate_set()
10348 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10350 * Get the ethumb_client handle so custom configuration can be made.
10352 * @return Ethumb_Client instance or NULL.
10354 * This must be called before the objects are created to be sure no object is
10355 * visible and no generation started.
10357 * Example of usage:
10360 * #include <Elementary.h>
10361 * #ifndef ELM_LIB_QUICKLAUNCH
10363 * elm_main(int argc, char **argv)
10365 * Ethumb_Client *client;
10367 * elm_need_ethumb();
10371 * client = elm_thumb_ethumb_client_get();
10374 * ERR("could not get ethumb_client");
10377 * ethumb_client_size_set(client, 100, 100);
10378 * ethumb_client_crop_align_set(client, 0.5, 0.5);
10381 * // Create elm_thumb objects here
10391 * @note There's only one client handle for Ethumb, so once a configuration
10392 * change is done to it, any other request for thumbnails (for any thumbnail
10393 * object) will use that configuration. Thus, this configuration is global.
10397 EAPI void *elm_thumb_ethumb_client_get(void);
10399 * Get the ethumb_client connection state.
10401 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10404 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
10406 * Make the thumbnail 'editable'.
10408 * @param obj Thumb object.
10409 * @param set Turn on or off editability. Default is @c EINA_FALSE.
10411 * This means the thumbnail is a valid drag target for drag and drop, and can be
10412 * cut or pasted too.
10414 * @see elm_thumb_editable_get()
10418 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10420 * Make the thumbnail 'editable'.
10422 * @param obj Thumb object.
10423 * @return Editability.
10425 * This means the thumbnail is a valid drag target for drag and drop, and can be
10426 * cut or pasted too.
10428 * @see elm_thumb_editable_set()
10432 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10439 * @defgroup Hoversel Hoversel
10441 * @image html img/widget/hoversel/preview-00.png
10442 * @image latex img/widget/hoversel/preview-00.eps
10444 * A hoversel is a button that pops up a list of items (automatically
10445 * choosing the direction to display) that have a label and, optionally, an
10446 * icon to select from. It is a convenience widget to avoid the need to do
10447 * all the piecing together yourself. It is intended for a small number of
10448 * items in the hoversel menu (no more than 8), though is capable of many
10451 * Signals that you can add callbacks for are:
10452 * "clicked" - the user clicked the hoversel button and popped up the sel
10453 * "selected" - an item in the hoversel list is selected. event_info is the item
10454 * "dismissed" - the hover is dismissed
10456 * See @ref tutorial_hoversel for an example.
10459 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10461 * @brief Add a new Hoversel object
10463 * @param parent The parent object
10464 * @return The new object or NULL if it cannot be created
10466 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10468 * @brief This sets the hoversel to expand horizontally.
10470 * @param obj The hoversel object
10471 * @param horizontal If true, the hover will expand horizontally to the
10474 * @note The initial button will display horizontally regardless of this
10477 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10479 * @brief This returns whether the hoversel is set to expand horizontally.
10481 * @param obj The hoversel object
10482 * @return If true, the hover will expand horizontally to the right.
10484 * @see elm_hoversel_horizontal_set()
10486 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10488 * @brief Set the Hover parent
10490 * @param obj The hoversel object
10491 * @param parent The parent to use
10493 * Sets the hover parent object, the area that will be darkened when the
10494 * hoversel is clicked. Should probably be the window that the hoversel is
10495 * in. See @ref Hover objects for more information.
10497 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10499 * @brief Get the Hover parent
10501 * @param obj The hoversel object
10502 * @return The used parent
10504 * Gets the hover parent object.
10506 * @see elm_hoversel_hover_parent_set()
10508 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10510 * @brief Set the hoversel button label
10512 * @param obj The hoversel object
10513 * @param label The label text.
10515 * This sets the label of the button that is always visible (before it is
10516 * clicked and expanded).
10518 * @deprecated elm_object_text_set()
10520 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10522 * @brief Get the hoversel button label
10524 * @param obj The hoversel object
10525 * @return The label text.
10527 * @deprecated elm_object_text_get()
10529 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10531 * @brief Set the icon of the hoversel button
10533 * @param obj The hoversel object
10534 * @param icon The icon object
10536 * Sets the icon of the button that is always visible (before it is clicked
10537 * and expanded). Once the icon object is set, a previously set one will be
10538 * deleted, if you want to keep that old content object, use the
10539 * elm_hoversel_icon_unset() function.
10541 * @see elm_button_icon_set()
10543 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10545 * @brief Get the icon of the hoversel button
10547 * @param obj The hoversel object
10548 * @return The icon object
10550 * Get the icon of the button that is always visible (before it is clicked
10551 * and expanded). Also see elm_button_icon_get().
10553 * @see elm_hoversel_icon_set()
10555 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10557 * @brief Get and unparent the icon of the hoversel button
10559 * @param obj The hoversel object
10560 * @return The icon object that was being used
10562 * Unparent and return the icon of the button that is always visible
10563 * (before it is clicked and expanded).
10565 * @see elm_hoversel_icon_set()
10566 * @see elm_button_icon_unset()
10568 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10570 * @brief This triggers the hoversel popup from code, the same as if the user
10571 * had clicked the button.
10573 * @param obj The hoversel object
10575 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10577 * @brief This dismisses the hoversel popup as if the user had clicked
10578 * outside the hover.
10580 * @param obj The hoversel object
10582 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10584 * @brief Returns whether the hoversel is expanded.
10586 * @param obj The hoversel object
10587 * @return This will return EINA_TRUE if the hoversel is expanded or
10588 * EINA_FALSE if it is not expanded.
10590 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10592 * @brief This will remove all the children items from the hoversel.
10594 * @param obj The hoversel object
10596 * @warning Should @b not be called while the hoversel is active; use
10597 * elm_hoversel_expanded_get() to check first.
10599 * @see elm_hoversel_item_del_cb_set()
10600 * @see elm_hoversel_item_del()
10602 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10604 * @brief Get the list of items within the given hoversel.
10606 * @param obj The hoversel object
10607 * @return Returns a list of Elm_Hoversel_Item*
10609 * @see elm_hoversel_item_add()
10611 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10613 * @brief Add an item to the hoversel button
10615 * @param obj The hoversel object
10616 * @param label The text label to use for the item (NULL if not desired)
10617 * @param icon_file An image file path on disk to use for the icon or standard
10618 * icon name (NULL if not desired)
10619 * @param icon_type The icon type if relevant
10620 * @param func Convenience function to call when this item is selected
10621 * @param data Data to pass to item-related functions
10622 * @return A handle to the item added.
10624 * This adds an item to the hoversel to show when it is clicked. Note: if you
10625 * need to use an icon from an edje file then use
10626 * elm_hoversel_item_icon_set() right after the this function, and set
10627 * icon_file to NULL here.
10629 * For more information on what @p icon_file and @p icon_type are see the
10630 * @ref Icon "icon documentation".
10632 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);
10634 * @brief Delete an item from the hoversel
10636 * @param item The item to delete
10638 * This deletes the item from the hoversel (should not be called while the
10639 * hoversel is active; use elm_hoversel_expanded_get() to check first).
10641 * @see elm_hoversel_item_add()
10642 * @see elm_hoversel_item_del_cb_set()
10644 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10646 * @brief Set the function to be called when an item from the hoversel is
10649 * @param item The item to set the callback on
10650 * @param func The function called
10652 * That function will receive these parameters:
10653 * @li void *item_data
10654 * @li Evas_Object *the_item_object
10655 * @li Elm_Hoversel_Item *the_object_struct
10657 * @see elm_hoversel_item_add()
10659 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10661 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10662 * that will be passed to associated function callbacks.
10664 * @param item The item to get the data from
10665 * @return The data pointer set with elm_hoversel_item_add()
10667 * @see elm_hoversel_item_add()
10669 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10671 * @brief This returns the label text of the given hoversel item.
10673 * @param item The item to get the label
10674 * @return The label text of the hoversel item
10676 * @see elm_hoversel_item_add()
10678 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10680 * @brief This sets the icon for the given hoversel item.
10682 * @param item The item to set the icon
10683 * @param icon_file An image file path on disk to use for the icon or standard
10685 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10686 * to NULL if the icon is not an edje file
10687 * @param icon_type The icon type
10689 * The icon can be loaded from the standard set, from an image file, or from
10692 * @see elm_hoversel_item_add()
10694 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);
10696 * @brief Get the icon object of the hoversel item
10698 * @param item The item to get the icon from
10699 * @param icon_file The image file path on disk used for the icon or standard
10701 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10702 * if the icon is not an edje file
10703 * @param icon_type The icon type
10705 * @see elm_hoversel_item_icon_set()
10706 * @see elm_hoversel_item_add()
10708 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);
10714 * @defgroup Toolbar Toolbar
10715 * @ingroup Elementary
10717 * @image html img/widget/toolbar/preview-00.png
10718 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10720 * @image html img/toolbar.png
10721 * @image latex img/toolbar.eps width=\textwidth
10723 * A toolbar is a widget that displays a list of items inside
10724 * a box. It can be scrollable, show a menu with items that don't fit
10725 * to toolbar size or even crop them.
10727 * Only one item can be selected at a time.
10729 * Items can have multiple states, or show menus when selected by the user.
10731 * Smart callbacks one can listen to:
10732 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10734 * Available styles for it:
10736 * - @c "transparent" - no background or shadow, just show the content
10738 * List of examples:
10739 * @li @ref toolbar_example_01
10740 * @li @ref toolbar_example_02
10741 * @li @ref toolbar_example_03
10745 * @addtogroup Toolbar
10750 * @enum _Elm_Toolbar_Shrink_Mode
10751 * @typedef Elm_Toolbar_Shrink_Mode
10753 * Set toolbar's items display behavior, it can be scrollabel,
10754 * show a menu with exceeding items, or simply hide them.
10756 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
10759 * Values <b> don't </b> work as bitmask, only one can be choosen.
10761 * @see elm_toolbar_mode_shrink_set()
10762 * @see elm_toolbar_mode_shrink_get()
10766 typedef enum _Elm_Toolbar_Shrink_Mode
10768 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
10769 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
10770 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
10771 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
10772 } Elm_Toolbar_Shrink_Mode;
10774 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(). */
10776 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(). */
10779 * Add a new toolbar widget to the given parent Elementary
10780 * (container) object.
10782 * @param parent The parent object.
10783 * @return a new toolbar widget handle or @c NULL, on errors.
10785 * This function inserts a new toolbar widget on the canvas.
10789 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10792 * Set the icon size, in pixels, to be used by toolbar items.
10794 * @param obj The toolbar object
10795 * @param icon_size The icon size in pixels
10797 * @note Default value is @c 32. It reads value from elm config.
10799 * @see elm_toolbar_icon_size_get()
10803 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
10806 * Get the icon size, in pixels, to be used by toolbar items.
10808 * @param obj The toolbar object.
10809 * @return The icon size in pixels.
10811 * @see elm_toolbar_icon_size_set() for details.
10815 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10818 * Sets icon lookup order, for toolbar items' icons.
10820 * @param obj The toolbar object.
10821 * @param order The icon lookup order.
10823 * Icons added before calling this function will not be affected.
10824 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
10826 * @see elm_toolbar_icon_order_lookup_get()
10830 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
10833 * Gets the icon lookup order.
10835 * @param obj The toolbar object.
10836 * @return The icon lookup order.
10838 * @see elm_toolbar_icon_order_lookup_set() for details.
10842 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10845 * Set whether the toolbar items' should be selected by the user or not.
10847 * @param obj The toolbar object.
10848 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
10851 * This will turn off the ability to select items entirely and they will
10852 * neither appear selected nor emit selected signals. The clicked
10853 * callback function will still be called.
10855 * Selection is enabled by default.
10857 * @see elm_toolbar_no_select_mode_get().
10861 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
10864 * Set whether the toolbar items' should be selected by the user or not.
10866 * @param obj The toolbar object.
10867 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
10868 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
10870 * @see elm_toolbar_no_select_mode_set() for details.
10874 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10877 * Append item to the toolbar.
10879 * @param obj The toolbar object.
10880 * @param icon A string with icon name or the absolute path of an image file.
10881 * @param label The label of the item.
10882 * @param func The function to call when the item is clicked.
10883 * @param data The data to associate with the item for related callbacks.
10884 * @return The created item or @c NULL upon failure.
10886 * A new item will be created and appended to the toolbar, i.e., will
10887 * be set as @b last item.
10889 * Items created with this method can be deleted with
10890 * elm_toolbar_item_del().
10892 * Associated @p data can be properly freed when item is deleted if a
10893 * callback function is set with elm_toolbar_item_del_cb_set().
10895 * If a function is passed as argument, it will be called everytime this item
10896 * is selected, i.e., the user clicks over an unselected item.
10897 * If such function isn't needed, just passing
10898 * @c NULL as @p func is enough. The same should be done for @p data.
10900 * Toolbar will load icon image from fdo or current theme.
10901 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10902 * If an absolute path is provided it will load it direct from a file.
10904 * @see elm_toolbar_item_icon_set()
10905 * @see elm_toolbar_item_del()
10906 * @see elm_toolbar_item_del_cb_set()
10910 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);
10913 * Prepend item to the toolbar.
10915 * @param obj The toolbar object.
10916 * @param icon A string with icon name or the absolute path of an image file.
10917 * @param label The label of the item.
10918 * @param func The function to call when the item is clicked.
10919 * @param data The data to associate with the item for related callbacks.
10920 * @return The created item or @c NULL upon failure.
10922 * A new item will be created and prepended to the toolbar, i.e., will
10923 * be set as @b first item.
10925 * Items created with this method can be deleted with
10926 * elm_toolbar_item_del().
10928 * Associated @p data can be properly freed when item is deleted if a
10929 * callback function is set with elm_toolbar_item_del_cb_set().
10931 * If a function is passed as argument, it will be called everytime this item
10932 * is selected, i.e., the user clicks over an unselected item.
10933 * If such function isn't needed, just passing
10934 * @c NULL as @p func is enough. The same should be done for @p data.
10936 * Toolbar will load icon image from fdo or current theme.
10937 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10938 * If an absolute path is provided it will load it direct from a file.
10940 * @see elm_toolbar_item_icon_set()
10941 * @see elm_toolbar_item_del()
10942 * @see elm_toolbar_item_del_cb_set()
10946 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);
10949 * Insert a new item into the toolbar object before item @p before.
10951 * @param obj The toolbar object.
10952 * @param before The toolbar item to insert before.
10953 * @param icon A string with icon name or the absolute path of an image file.
10954 * @param label The label of the item.
10955 * @param func The function to call when the item is clicked.
10956 * @param data The data to associate with the item for related callbacks.
10957 * @return The created item or @c NULL upon failure.
10959 * A new item will be created and added to the toolbar. Its position in
10960 * this toolbar will be just before item @p before.
10962 * Items created with this method can be deleted with
10963 * elm_toolbar_item_del().
10965 * Associated @p data can be properly freed when item is deleted if a
10966 * callback function is set with elm_toolbar_item_del_cb_set().
10968 * If a function is passed as argument, it will be called everytime this item
10969 * is selected, i.e., the user clicks over an unselected item.
10970 * If such function isn't needed, just passing
10971 * @c NULL as @p func is enough. The same should be done for @p data.
10973 * Toolbar will load icon image from fdo or current theme.
10974 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10975 * If an absolute path is provided it will load it direct from a file.
10977 * @see elm_toolbar_item_icon_set()
10978 * @see elm_toolbar_item_del()
10979 * @see elm_toolbar_item_del_cb_set()
10983 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);
10986 * Insert a new item into the toolbar object after item @p after.
10988 * @param obj The toolbar object.
10989 * @param before The toolbar item to insert before.
10990 * @param icon A string with icon name or the absolute path of an image file.
10991 * @param label The label of the item.
10992 * @param func The function to call when the item is clicked.
10993 * @param data The data to associate with the item for related callbacks.
10994 * @return The created item or @c NULL upon failure.
10996 * A new item will be created and added to the toolbar. Its position in
10997 * this toolbar will be just after item @p after.
10999 * Items created with this method can be deleted with
11000 * elm_toolbar_item_del().
11002 * Associated @p data can be properly freed when item is deleted if a
11003 * callback function is set with elm_toolbar_item_del_cb_set().
11005 * If a function is passed as argument, it will be called everytime this item
11006 * is selected, i.e., the user clicks over an unselected item.
11007 * If such function isn't needed, just passing
11008 * @c NULL as @p func is enough. The same should be done for @p data.
11010 * Toolbar will load icon image from fdo or current theme.
11011 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11012 * If an absolute path is provided it will load it direct from a file.
11014 * @see elm_toolbar_item_icon_set()
11015 * @see elm_toolbar_item_del()
11016 * @see elm_toolbar_item_del_cb_set()
11020 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);
11023 * Get the first item in the given toolbar widget's list of
11026 * @param obj The toolbar object
11027 * @return The first item or @c NULL, if it has no items (and on
11030 * @see elm_toolbar_item_append()
11031 * @see elm_toolbar_last_item_get()
11035 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11038 * Get the last item in the given toolbar widget's list of
11041 * @param obj The toolbar object
11042 * @return The last item or @c NULL, if it has no items (and on
11045 * @see elm_toolbar_item_prepend()
11046 * @see elm_toolbar_first_item_get()
11050 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11053 * Get the item after @p item in toolbar.
11055 * @param item The toolbar item.
11056 * @return The item after @p item, or @c NULL if none or on failure.
11058 * @note If it is the last item, @c NULL will be returned.
11060 * @see elm_toolbar_item_append()
11064 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11067 * Get the item before @p item in toolbar.
11069 * @param item The toolbar item.
11070 * @return The item before @p item, or @c NULL if none or on failure.
11072 * @note If it is the first item, @c NULL will be returned.
11074 * @see elm_toolbar_item_prepend()
11078 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11081 * Get the toolbar object from an item.
11083 * @param item The item.
11084 * @return The toolbar object.
11086 * This returns the toolbar object itself that an item belongs to.
11090 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11093 * Set the priority of a toolbar item.
11095 * @param item The toolbar item.
11096 * @param priority The item priority. The default is zero.
11098 * This is used only when the toolbar shrink mode is set to
11099 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11100 * When space is less than required, items with low priority
11101 * will be removed from the toolbar and added to a dynamically-created menu,
11102 * while items with higher priority will remain on the toolbar,
11103 * with the same order they were added.
11105 * @see elm_toolbar_item_priority_get()
11109 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11112 * Get the priority of a toolbar item.
11114 * @param item The toolbar item.
11115 * @return The @p item priority, or @c 0 on failure.
11117 * @see elm_toolbar_item_priority_set() for details.
11121 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11124 * Get the label of item.
11126 * @param item The item of toolbar.
11127 * @return The label of item.
11129 * The return value is a pointer to the label associated to @p item when
11130 * it was created, with function elm_toolbar_item_append() or similar,
11132 * with function elm_toolbar_item_label_set. If no label
11133 * was passed as argument, it will return @c NULL.
11135 * @see elm_toolbar_item_label_set() for more details.
11136 * @see elm_toolbar_item_append()
11140 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11143 * Set the label of item.
11145 * @param item The item of toolbar.
11146 * @param text The label of item.
11148 * The label to be displayed by the item.
11149 * Label will be placed at icons bottom (if set).
11151 * If a label was passed as argument on item creation, with function
11152 * elm_toolbar_item_append() or similar, it will be already
11153 * displayed by the item.
11155 * @see elm_toolbar_item_label_get()
11156 * @see elm_toolbar_item_append()
11160 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11163 * Return the data associated with a given toolbar widget item.
11165 * @param item The toolbar widget item handle.
11166 * @return The data associated with @p item.
11168 * @see elm_toolbar_item_data_set()
11172 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11175 * Set the data associated with a given toolbar widget item.
11177 * @param item The toolbar widget item handle.
11178 * @param data The new data pointer to set to @p item.
11180 * This sets new item data on @p item.
11182 * @warning The old data pointer won't be touched by this function, so
11183 * the user had better to free that old data himself/herself.
11187 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11190 * Returns a pointer to a toolbar item by its label.
11192 * @param obj The toolbar object.
11193 * @param label The label of the item to find.
11195 * @return The pointer to the toolbar item matching @p label or @c NULL
11200 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11203 * Get whether the @p item is selected or not.
11205 * @param item The toolbar item.
11206 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11207 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11209 * @see elm_toolbar_selected_item_set() for details.
11210 * @see elm_toolbar_item_selected_get()
11214 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11217 * Set the selected state of an item.
11219 * @param item The toolbar item
11220 * @param selected The selected state
11222 * This sets the selected state of the given item @p it.
11223 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11225 * If a new item is selected the previosly selected will be unselected.
11226 * Previoulsy selected item can be get with function
11227 * elm_toolbar_selected_item_get().
11229 * Selected items will be highlighted.
11231 * @see elm_toolbar_item_selected_get()
11232 * @see elm_toolbar_selected_item_get()
11236 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11239 * Get the selected item.
11241 * @param obj The toolbar object.
11242 * @return The selected toolbar item.
11244 * The selected item can be unselected with function
11245 * elm_toolbar_item_selected_set().
11247 * The selected item always will be highlighted on toolbar.
11249 * @see elm_toolbar_selected_items_get()
11253 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11256 * Set the icon associated with @p item.
11258 * @param obj The parent of this item.
11259 * @param item The toolbar item.
11260 * @param icon A string with icon name or the absolute path of an image file.
11262 * Toolbar will load icon image from fdo or current theme.
11263 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11264 * If an absolute path is provided it will load it direct from a file.
11266 * @see elm_toolbar_icon_order_lookup_set()
11267 * @see elm_toolbar_icon_order_lookup_get()
11271 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11274 * Get the string used to set the icon of @p item.
11276 * @param item The toolbar item.
11277 * @return The string associated with the icon object.
11279 * @see elm_toolbar_item_icon_set() for details.
11283 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11286 * Delete them item from the toolbar.
11288 * @param item The item of toolbar to be deleted.
11290 * @see elm_toolbar_item_append()
11291 * @see elm_toolbar_item_del_cb_set()
11295 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11298 * Set the function called when a toolbar item is freed.
11300 * @param item The item to set the callback on.
11301 * @param func The function called.
11303 * If there is a @p func, then it will be called prior item's memory release.
11304 * That will be called with the following arguments:
11306 * @li item's Evas object;
11309 * This way, a data associated to a toolbar item could be properly freed.
11313 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11316 * Get a value whether toolbar item is disabled or not.
11318 * @param item The item.
11319 * @return The disabled state.
11321 * @see elm_toolbar_item_disabled_set() for more details.
11325 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11328 * Sets the disabled/enabled state of a toolbar item.
11330 * @param item The item.
11331 * @param disabled The disabled state.
11333 * A disabled item cannot be selected or unselected. It will also
11334 * change its appearance (generally greyed out). This sets the
11335 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11340 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11343 * Set or unset item as a separator.
11345 * @param item The toolbar item.
11346 * @param setting @c EINA_TRUE to set item @p item as separator or
11347 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11349 * Items aren't set as separator by default.
11351 * If set as separator it will display separator theme, so won't display
11354 * @see elm_toolbar_item_separator_get()
11358 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11361 * Get a value whether item is a separator or not.
11363 * @param item The toolbar item.
11364 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11365 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11367 * @see elm_toolbar_item_separator_set() for details.
11371 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11374 * Set the shrink state of toolbar @p obj.
11376 * @param obj The toolbar object.
11377 * @param shrink_mode Toolbar's items display behavior.
11379 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11380 * but will enforce a minimun size so all the items will fit, won't scroll
11381 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11382 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11383 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11387 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11390 * Get the shrink mode of toolbar @p obj.
11392 * @param obj The toolbar object.
11393 * @return Toolbar's items display behavior.
11395 * @see elm_toolbar_mode_shrink_set() for details.
11399 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11402 * Enable/disable homogenous mode.
11404 * @param obj The toolbar object
11405 * @param homogeneous Assume the items within the toolbar are of the
11406 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11408 * This will enable the homogeneous mode where items are of the same size.
11409 * @see elm_toolbar_homogeneous_get()
11413 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11416 * Get whether the homogenous mode is enabled.
11418 * @param obj The toolbar object.
11419 * @return Assume the items within the toolbar are of the same height
11420 * and width (EINA_TRUE = on, EINA_FALSE = off).
11422 * @see elm_toolbar_homogeneous_set()
11426 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11429 * Enable/disable homogenous mode.
11431 * @param obj The toolbar object
11432 * @param homogeneous Assume the items within the toolbar are of the
11433 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11435 * This will enable the homogeneous mode where items are of the same size.
11436 * @see elm_toolbar_homogeneous_get()
11438 * @deprecated use elm_toolbar_homogeneous_set() instead.
11442 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11445 * Get whether the homogenous mode is enabled.
11447 * @param obj The toolbar object.
11448 * @return Assume the items within the toolbar are of the same height
11449 * and width (EINA_TRUE = on, EINA_FALSE = off).
11451 * @see elm_toolbar_homogeneous_set()
11452 * @deprecated use elm_toolbar_homogeneous_get() instead.
11456 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11459 * Set the parent object of the toolbar items' menus.
11461 * @param obj The toolbar object.
11462 * @param parent The parent of the menu objects.
11464 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11466 * For more details about setting the parent for toolbar menus, see
11467 * elm_menu_parent_set().
11469 * @see elm_menu_parent_set() for details.
11470 * @see elm_toolbar_item_menu_set() for details.
11474 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11477 * Get the parent object of the toolbar items' menus.
11479 * @param obj The toolbar object.
11480 * @return The parent of the menu objects.
11482 * @see elm_toolbar_menu_parent_set() for details.
11486 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11489 * Set the alignment of the items.
11491 * @param obj The toolbar object.
11492 * @param align The new alignment, a float between <tt> 0.0 </tt>
11493 * and <tt> 1.0 </tt>.
11495 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11496 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11499 * Centered items by default.
11501 * @see elm_toolbar_align_get()
11505 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11508 * Get the alignment of the items.
11510 * @param obj The toolbar object.
11511 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11514 * @see elm_toolbar_align_set() for details.
11518 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11521 * Set whether the toolbar item opens a menu.
11523 * @param item The toolbar item.
11524 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11526 * A toolbar item can be set to be a menu, using this function.
11528 * Once it is set to be a menu, it can be manipulated through the
11529 * menu-like function elm_toolbar_menu_parent_set() and the other
11530 * elm_menu functions, using the Evas_Object @c menu returned by
11531 * elm_toolbar_item_menu_get().
11533 * So, items to be displayed in this item's menu should be added with
11534 * elm_menu_item_add().
11536 * The following code exemplifies the most basic usage:
11538 * tb = elm_toolbar_add(win)
11539 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11540 * elm_toolbar_item_menu_set(item, EINA_TRUE);
11541 * elm_toolbar_menu_parent_set(tb, win);
11542 * menu = elm_toolbar_item_menu_get(item);
11543 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11544 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11548 * @see elm_toolbar_item_menu_get()
11552 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11555 * Get toolbar item's menu.
11557 * @param item The toolbar item.
11558 * @return Item's menu object or @c NULL on failure.
11560 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11561 * this function will set it.
11563 * @see elm_toolbar_item_menu_set() for details.
11567 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11570 * Add a new state to @p item.
11572 * @param item The item.
11573 * @param icon A string with icon name or the absolute path of an image file.
11574 * @param label The label of the new state.
11575 * @param func The function to call when the item is clicked when this
11576 * state is selected.
11577 * @param data The data to associate with the state.
11578 * @return The toolbar item state, or @c NULL upon failure.
11580 * Toolbar will load icon image from fdo or current theme.
11581 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11582 * If an absolute path is provided it will load it direct from a file.
11584 * States created with this function can be removed with
11585 * elm_toolbar_item_state_del().
11587 * @see elm_toolbar_item_state_del()
11588 * @see elm_toolbar_item_state_sel()
11589 * @see elm_toolbar_item_state_get()
11593 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);
11596 * Delete a previoulsy added state to @p item.
11598 * @param item The toolbar item.
11599 * @param state The state to be deleted.
11600 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11602 * @see elm_toolbar_item_state_add()
11604 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11607 * Set @p state as the current state of @p it.
11609 * @param it The item.
11610 * @param state The state to use.
11611 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11613 * If @p state is @c NULL, it won't select any state and the default item's
11614 * icon and label will be used. It's the same behaviour than
11615 * elm_toolbar_item_state_unser().
11617 * @see elm_toolbar_item_state_unset()
11621 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11624 * Unset the state of @p it.
11626 * @param it The item.
11628 * The default icon and label from this item will be displayed.
11630 * @see elm_toolbar_item_state_set() for more details.
11634 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11637 * Get the current state of @p it.
11639 * @param item The item.
11640 * @return The selected state or @c NULL if none is selected or on failure.
11642 * @see elm_toolbar_item_state_set() for details.
11643 * @see elm_toolbar_item_state_unset()
11644 * @see elm_toolbar_item_state_add()
11648 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11651 * Get the state after selected state in toolbar's @p item.
11653 * @param it The toolbar item to change state.
11654 * @return The state after current state, or @c NULL on failure.
11656 * If last state is selected, this function will return first state.
11658 * @see elm_toolbar_item_state_set()
11659 * @see elm_toolbar_item_state_add()
11663 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11666 * Get the state before selected state in toolbar's @p item.
11668 * @param it The toolbar item to change state.
11669 * @return The state before current state, or @c NULL on failure.
11671 * If first state is selected, this function will return last state.
11673 * @see elm_toolbar_item_state_set()
11674 * @see elm_toolbar_item_state_add()
11678 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11681 * Set the text to be shown in a given toolbar item's tooltips.
11683 * @param item Target item.
11684 * @param text The text to set in the content.
11686 * Setup the text as tooltip to object. The item can have only one tooltip,
11687 * so any previous tooltip data - set with this function or
11688 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11690 * @see elm_object_tooltip_text_set() for more details.
11694 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11697 * Set the content to be shown in the tooltip item.
11699 * Setup the tooltip to item. The item can have only one tooltip,
11700 * so any previous tooltip data is removed. @p func(with @p data) will
11701 * be called every time that need show the tooltip and it should
11702 * return a valid Evas_Object. This object is then managed fully by
11703 * tooltip system and is deleted when the tooltip is gone.
11705 * @param item the toolbar item being attached a tooltip.
11706 * @param func the function used to create the tooltip contents.
11707 * @param data what to provide to @a func as callback data/context.
11708 * @param del_cb called when data is not needed anymore, either when
11709 * another callback replaces @a func, the tooltip is unset with
11710 * elm_toolbar_item_tooltip_unset() or the owner @a item
11711 * dies. This callback receives as the first parameter the
11712 * given @a data, and @c event_info is the item.
11714 * @see elm_object_tooltip_content_cb_set() for more details.
11718 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);
11721 * Unset tooltip from item.
11723 * @param item toolbar item to remove previously set tooltip.
11725 * Remove tooltip from item. The callback provided as del_cb to
11726 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11727 * it is not used anymore.
11729 * @see elm_object_tooltip_unset() for more details.
11730 * @see elm_toolbar_item_tooltip_content_cb_set()
11734 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11737 * Sets a different style for this item tooltip.
11739 * @note before you set a style you should define a tooltip with
11740 * elm_toolbar_item_tooltip_content_cb_set() or
11741 * elm_toolbar_item_tooltip_text_set()
11743 * @param item toolbar item with tooltip already set.
11744 * @param style the theme style to use (default, transparent, ...)
11746 * @see elm_object_tooltip_style_set() for more details.
11750 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11753 * Get the style for this item tooltip.
11755 * @param item toolbar item with tooltip already set.
11756 * @return style the theme style in use, defaults to "default". If the
11757 * object does not have a tooltip set, then NULL is returned.
11759 * @see elm_object_tooltip_style_get() for more details.
11760 * @see elm_toolbar_item_tooltip_style_set()
11764 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11767 * Set the type of mouse pointer/cursor decoration to be shown,
11768 * when the mouse pointer is over the given toolbar widget item
11770 * @param item toolbar item to customize cursor on
11771 * @param cursor the cursor type's name
11773 * This function works analogously as elm_object_cursor_set(), but
11774 * here the cursor's changing area is restricted to the item's
11775 * area, and not the whole widget's. Note that that item cursors
11776 * have precedence over widget cursors, so that a mouse over an
11777 * item with custom cursor set will always show @b that cursor.
11779 * If this function is called twice for an object, a previously set
11780 * cursor will be unset on the second call.
11782 * @see elm_object_cursor_set()
11783 * @see elm_toolbar_item_cursor_get()
11784 * @see elm_toolbar_item_cursor_unset()
11788 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
11791 * Get the type of mouse pointer/cursor decoration set to be shown,
11792 * when the mouse pointer is over the given toolbar widget item
11794 * @param item toolbar item with custom cursor set
11795 * @return the cursor type's name or @c NULL, if no custom cursors
11796 * were set to @p item (and on errors)
11798 * @see elm_object_cursor_get()
11799 * @see elm_toolbar_item_cursor_set()
11800 * @see elm_toolbar_item_cursor_unset()
11804 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11807 * Unset any custom mouse pointer/cursor decoration set to be
11808 * shown, when the mouse pointer is over the given toolbar widget
11809 * item, thus making it show the @b default cursor again.
11811 * @param item a toolbar item
11813 * Use this call to undo any custom settings on this item's cursor
11814 * decoration, bringing it back to defaults (no custom style set).
11816 * @see elm_object_cursor_unset()
11817 * @see elm_toolbar_item_cursor_set()
11821 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11824 * Set a different @b style for a given custom cursor set for a
11827 * @param item toolbar item with custom cursor set
11828 * @param style the <b>theme style</b> to use (e.g. @c "default",
11829 * @c "transparent", etc)
11831 * This function only makes sense when one is using custom mouse
11832 * cursor decorations <b>defined in a theme file</b>, which can have,
11833 * given a cursor name/type, <b>alternate styles</b> on it. It
11834 * works analogously as elm_object_cursor_style_set(), but here
11835 * applyed only to toolbar item objects.
11837 * @warning Before you set a cursor style you should have definen a
11838 * custom cursor previously on the item, with
11839 * elm_toolbar_item_cursor_set()
11841 * @see elm_toolbar_item_cursor_engine_only_set()
11842 * @see elm_toolbar_item_cursor_style_get()
11846 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11849 * Get the current @b style set for a given toolbar item's custom
11852 * @param item toolbar item with custom cursor set.
11853 * @return style the cursor style in use. If the object does not
11854 * have a cursor set, then @c NULL is returned.
11856 * @see elm_toolbar_item_cursor_style_set() for more details
11860 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11863 * Set if the (custom)cursor for a given toolbar item should be
11864 * searched in its theme, also, or should only rely on the
11865 * rendering engine.
11867 * @param item item with custom (custom) cursor already set on
11868 * @param engine_only Use @c EINA_TRUE to have cursors looked for
11869 * only on those provided by the rendering engine, @c EINA_FALSE to
11870 * have them searched on the widget's theme, as well.
11872 * @note This call is of use only if you've set a custom cursor
11873 * for toolbar items, with elm_toolbar_item_cursor_set().
11875 * @note By default, cursors will only be looked for between those
11876 * provided by the rendering engine.
11880 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11883 * Get if the (custom) cursor for a given toolbar item is being
11884 * searched in its theme, also, or is only relying on the rendering
11887 * @param item a toolbar item
11888 * @return @c EINA_TRUE, if cursors are being looked for only on
11889 * those provided by the rendering engine, @c EINA_FALSE if they
11890 * are being searched on the widget's theme, as well.
11892 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
11896 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11903 EAPI double elm_tooltip_delay_get(void);
11904 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
11905 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
11906 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
11907 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
11908 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);
11909 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11910 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11911 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11912 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
11913 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11914 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11915 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11916 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11917 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11918 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11919 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
11920 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
11923 EAPI int elm_cursor_engine_only_get(void);
11924 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
11927 * @defgroup Menu Menu
11929 * @image html img/widget/menu/preview-00.png
11930 * @image latex img/widget/menu/preview-00.eps
11932 * A menu is a list of items displayed above its parent. When the menu is
11933 * showing its parent is darkened. Each item can have a sub-menu. The menu
11934 * object can be used to display a menu on a right click event, in a toolbar,
11937 * Signals that you can add callbacks for are:
11938 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
11939 * event_info is NULL.
11941 * @see @ref tutorial_menu
11944 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
11946 * @brief Add a new menu to the parent
11948 * @param parent The parent object.
11949 * @return The new object or NULL if it cannot be created.
11951 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11953 * @brief Set the parent for the given menu widget
11955 * @param obj The menu object.
11956 * @param parent The new parent.
11958 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11960 * @brief Get the parent for the given menu widget
11962 * @param obj The menu object.
11963 * @return The parent.
11965 * @see elm_menu_parent_set()
11967 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11969 * @brief Move the menu to a new position
11971 * @param obj The menu object.
11972 * @param x The new position.
11973 * @param y The new position.
11975 * Sets the top-left position of the menu to (@p x,@p y).
11977 * @note @p x and @p y coordinates are relative to parent.
11979 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
11981 * @brief Close a opened menu
11983 * @param obj the menu object
11986 * Hides the menu and all it's sub-menus.
11988 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
11990 * @brief Returns a list of @p item's items.
11992 * @param obj The menu object
11993 * @return An Eina_List* of @p item's items
11995 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11997 * @brief Get the Evas_Object of an Elm_Menu_Item
11999 * @param item The menu item object.
12000 * @return The edje object containing the swallowed content
12002 * @warning Don't manipulate this object!
12004 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12006 * @brief Add an item at the end of the given menu widget
12008 * @param obj The menu object.
12009 * @param parent The parent menu item (optional)
12010 * @param icon A icon display on the item. The icon will be destryed by the menu.
12011 * @param label The label of the item.
12012 * @param func Function called when the user select the item.
12013 * @param data Data sent by the callback.
12014 * @return Returns the new item.
12016 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);
12018 * @brief Add an object swallowed in an item at the end of the given menu
12021 * @param obj The menu object.
12022 * @param parent The parent menu item (optional)
12023 * @param subobj The object to swallow
12024 * @param func Function called when the user select the item.
12025 * @param data Data sent by the callback.
12026 * @return Returns the new item.
12028 * Add an evas object as an item to the menu.
12030 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);
12032 * @brief Set the label of a menu item
12034 * @param item The menu item object.
12035 * @param label The label to set for @p item
12037 * @warning Don't use this funcion on items created with
12038 * elm_menu_item_add_object() or elm_menu_item_separator_add().
12040 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12042 * @brief Get the label of a menu item
12044 * @param item The menu item object.
12045 * @return The label of @p item
12047 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12049 * @brief Set the icon of a menu item to the standard icon with name @p icon
12051 * @param item The menu item object.
12052 * @param icon The icon object to set for the content of @p item
12054 * Once this icon is set, any previously set icon will be deleted.
12056 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12058 * @brief Get the string representation from the icon of a menu item
12060 * @param item The menu item object.
12061 * @return The string representation of @p item's icon or NULL
12063 * @see elm_menu_item_object_icon_name_set()
12065 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12067 * @deprecated Use elm_menu_item_object_icon_name_set()
12069 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2) EINA_DEPRECATED;
12071 * @deprecated Use elm_menu_item_object_icon_name_get()
12073 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12075 * @brief Set the content object of a menu item
12077 * @param item The menu item object
12078 * @param The content object or NULL
12079 * @return EINA_TRUE on success, else EINA_FALSE
12081 * Use this function to change the object swallowed by a menu item, deleting
12082 * any previously swallowed object.
12084 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12086 * @brief Get the content object of a menu item
12088 * @param item The menu item object
12089 * @return The content object or NULL
12090 * @note If @p item was added with elm_menu_item_add_object, this
12091 * function will return the object passed, else it will return the
12094 * @see elm_menu_item_object_content_set()
12096 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12098 * @deprecated Use elm_menu_item_object_content_get() instead.
12100 EAPI Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12102 * @brief Set the selected state of @p item.
12104 * @param item The menu item object.
12105 * @param selected The selected/unselected state of the item
12107 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12109 * @brief Get the selected state of @p item.
12111 * @param item The menu item object.
12112 * @return The selected/unselected state of the item
12114 * @see elm_menu_item_selected_set()
12116 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12118 * @brief Set the disabled state of @p item.
12120 * @param item The menu item object.
12121 * @param disabled The enabled/disabled state of the item
12123 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12125 * @brief Get the disabled state of @p item.
12127 * @param item The menu item object.
12128 * @return The enabled/disabled state of the item
12130 * @see elm_menu_item_disabled_set()
12132 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12134 * @brief Add a separator item to menu @p obj under @p parent.
12136 * @param obj The menu object
12137 * @param parent The item to add the separator under
12138 * @return The created item or NULL on failure
12140 * This is item is a @ref Separator.
12142 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12144 * @brief Returns whether @p item is a separator.
12146 * @param item The item to check
12147 * @return If true, @p item is a separator
12149 * @see elm_menu_item_separator_add()
12151 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12153 * @brief Deletes an item from the menu.
12155 * @param item The item to delete.
12157 * @see elm_menu_item_add()
12159 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12161 * @brief Set the function called when a menu item is deleted.
12163 * @param item The item to set the callback on
12164 * @param func The function called
12166 * @see elm_menu_item_add()
12167 * @see elm_menu_item_del()
12169 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12171 * @brief Returns the data associated with menu item @p item.
12173 * @param item The item
12174 * @return The data associated with @p item or NULL if none was set.
12176 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12178 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12180 * @brief Sets the data to be associated with menu item @p item.
12182 * @param item The item
12183 * @param data The data to be associated with @p item
12185 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12187 * @brief Returns a list of @p item's subitems.
12189 * @param item The item
12190 * @return An Eina_List* of @p item's subitems
12192 * @see elm_menu_add()
12194 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12196 * @brief Get the position of a menu item
12198 * @param item The menu item
12199 * @return The item's index
12201 * This function returns the index position of a menu item in a menu.
12202 * For a sub-menu, this number is relative to the first item in the sub-menu.
12204 * @note Index values begin with 0
12206 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12208 * @brief @brief Return a menu item's owner menu
12210 * @param item The menu item
12211 * @return The menu object owning @p item, or NULL on failure
12213 * Use this function to get the menu object owning an item.
12215 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12217 * @brief Get the selected item in the menu
12219 * @param obj The menu object
12220 * @return The selected item, or NULL if none
12222 * @see elm_menu_item_selected_get()
12223 * @see elm_menu_item_selected_set()
12225 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12227 * @brief Get the last item in the menu
12229 * @param obj The menu object
12230 * @return The last item, or NULL if none
12232 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12234 * @brief Get the first item in the menu
12236 * @param obj The menu object
12237 * @return The first item, or NULL if none
12239 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12241 * @brief Get the next item in the menu.
12243 * @param item The menu item object.
12244 * @return The item after it, or NULL if none
12246 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12248 * @brief Get the previous item in the menu.
12250 * @param item The menu item object.
12251 * @return The item before it, or NULL if none
12253 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12259 * @defgroup List List
12260 * @ingroup Elementary
12262 * @image html img/widget/list/preview-00.png
12263 * @image latex img/widget/list/preview-00.eps width=\textwidth
12265 * @image html img/list.png
12266 * @image latex img/list.eps width=\textwidth
12268 * A list widget is a container whose children are displayed vertically or
12269 * horizontally, in order, and can be selected.
12270 * The list can accept only one or multiple items selection. Also has many
12271 * modes of items displaying.
12273 * A list is a very simple type of list widget. For more robust
12274 * lists, @ref Genlist should probably be used.
12276 * Smart callbacks one can listen to:
12277 * - @c "activated" - The user has double-clicked or pressed
12278 * (enter|return|spacebar) on an item. The @c event_info parameter
12279 * is the item that was activated.
12280 * - @c "clicked,double" - The user has double-clicked an item.
12281 * The @c event_info parameter is the item that was double-clicked.
12282 * - "selected" - when the user selected an item
12283 * - "unselected" - when the user unselected an item
12284 * - "longpressed" - an item in the list is long-pressed
12285 * - "scroll,edge,top" - the list is scrolled until the top edge
12286 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12287 * - "scroll,edge,left" - the list is scrolled until the left edge
12288 * - "scroll,edge,right" - the list is scrolled until the right edge
12290 * Available styles for it:
12293 * List of examples:
12294 * @li @ref list_example_01
12295 * @li @ref list_example_02
12296 * @li @ref list_example_03
12305 * @enum _Elm_List_Mode
12306 * @typedef Elm_List_Mode
12308 * Set list's resize behavior, transverse axis scroll and
12309 * items cropping. See each mode's description for more details.
12311 * @note Default value is #ELM_LIST_SCROLL.
12313 * Values <b> don't </b> work as bitmask, only one can be choosen.
12315 * @see elm_list_mode_set()
12316 * @see elm_list_mode_get()
12320 typedef enum _Elm_List_Mode
12322 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. */
12323 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). */
12324 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. */
12325 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. */
12326 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12329 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(). */
12332 * Add a new list widget to the given parent Elementary
12333 * (container) object.
12335 * @param parent The parent object.
12336 * @return a new list widget handle or @c NULL, on errors.
12338 * This function inserts a new list widget on the canvas.
12342 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12347 * @param obj The list object
12349 * @note Call before running show() on the list object.
12350 * @warning If not called, it won't display the list properly.
12353 * li = elm_list_add(win);
12354 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12355 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12357 * evas_object_show(li);
12362 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12365 * Enable or disable multiple items selection on the list object.
12367 * @param obj The list object
12368 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12371 * Disabled by default. If disabled, the user can select a single item of
12372 * the list each time. Selected items are highlighted on list.
12373 * If enabled, many items can be selected.
12375 * If a selected item is selected again, it will be unselected.
12377 * @see elm_list_multi_select_get()
12381 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12384 * Get a value whether multiple items selection is enabled or not.
12386 * @see elm_list_multi_select_set() for details.
12388 * @param obj The list object.
12389 * @return @c EINA_TRUE means multiple items selection is enabled.
12390 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12391 * @c EINA_FALSE is returned.
12395 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12398 * Set which mode to use for the list object.
12400 * @param obj The list object
12401 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12402 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12404 * Set list's resize behavior, transverse axis scroll and
12405 * items cropping. See each mode's description for more details.
12407 * @note Default value is #ELM_LIST_SCROLL.
12409 * Only one can be set, if a previous one was set, it will be changed
12410 * by the new mode set. Bitmask won't work as well.
12412 * @see elm_list_mode_get()
12416 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12419 * Get the mode the list is at.
12421 * @param obj The list object
12422 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12423 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12425 * @note see elm_list_mode_set() for more information.
12429 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12432 * Enable or disable horizontal mode on the list object.
12434 * @param obj The list object.
12435 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12436 * disable it, i.e., to enable vertical mode.
12438 * @note Vertical mode is set by default.
12440 * On horizontal mode items are displayed on list from left to right,
12441 * instead of from top to bottom. Also, the list will scroll horizontally.
12442 * Each item will presents left icon on top and right icon, or end, at
12445 * @see elm_list_horizontal_get()
12449 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12452 * Get a value whether horizontal mode is enabled or not.
12454 * @param obj The list object.
12455 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12456 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12457 * @c EINA_FALSE is returned.
12459 * @see elm_list_horizontal_set() for details.
12463 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12466 * Enable or disable always select mode on the list object.
12468 * @param obj The list object
12469 * @param always_select @c EINA_TRUE to enable always select mode or
12470 * @c EINA_FALSE to disable it.
12472 * @note Always select mode is disabled by default.
12474 * Default behavior of list items is to only call its callback function
12475 * the first time it's pressed, i.e., when it is selected. If a selected
12476 * item is pressed again, and multi-select is disabled, it won't call
12477 * this function (if multi-select is enabled it will unselect the item).
12479 * If always select is enabled, it will call the callback function
12480 * everytime a item is pressed, so it will call when the item is selected,
12481 * and again when a selected item is pressed.
12483 * @see elm_list_always_select_mode_get()
12484 * @see elm_list_multi_select_set()
12488 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12491 * Get a value whether always select mode is enabled or not, meaning that
12492 * an item will always call its callback function, even if already selected.
12494 * @param obj The list object
12495 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12496 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12497 * @c EINA_FALSE is returned.
12499 * @see elm_list_always_select_mode_set() for details.
12503 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12506 * Set bouncing behaviour when the scrolled content reaches an edge.
12508 * Tell the internal scroller object whether it should bounce or not
12509 * when it reaches the respective edges for each axis.
12511 * @param obj The list object
12512 * @param h_bounce Whether to bounce or not in the horizontal axis.
12513 * @param v_bounce Whether to bounce or not in the vertical axis.
12515 * @see elm_scroller_bounce_set()
12519 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12522 * Get the bouncing behaviour of the internal scroller.
12524 * Get whether the internal scroller should bounce when the edge of each
12525 * axis is reached scrolling.
12527 * @param obj The list object.
12528 * @param h_bounce Pointer where to store the bounce state of the horizontal
12530 * @param v_bounce Pointer where to store the bounce state of the vertical
12533 * @see elm_scroller_bounce_get()
12534 * @see elm_list_bounce_set()
12538 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12541 * Set the scrollbar policy.
12543 * @param obj The list object
12544 * @param policy_h Horizontal scrollbar policy.
12545 * @param policy_v Vertical scrollbar policy.
12547 * This sets the scrollbar visibility policy for the given scroller.
12548 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12549 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12550 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12551 * This applies respectively for the horizontal and vertical scrollbars.
12553 * The both are disabled by default, i.e., are set to
12554 * #ELM_SCROLLER_POLICY_OFF.
12558 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12561 * Get the scrollbar policy.
12563 * @see elm_list_scroller_policy_get() for details.
12565 * @param obj The list object.
12566 * @param policy_h Pointer where to store horizontal scrollbar policy.
12567 * @param policy_v Pointer where to store vertical scrollbar policy.
12571 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);
12574 * Append a new item to the list object.
12576 * @param obj The list object.
12577 * @param label The label of the list item.
12578 * @param icon The icon object to use for the left side of the item. An
12579 * icon can be any Evas object, but usually it is an icon created
12580 * with elm_icon_add().
12581 * @param end The icon object to use for the right side of the item. An
12582 * icon can be any Evas object.
12583 * @param func The function to call when the item is clicked.
12584 * @param data The data to associate with the item for related callbacks.
12586 * @return The created item or @c NULL upon failure.
12588 * A new item will be created and appended to the list, i.e., will
12589 * be set as @b last item.
12591 * Items created with this method can be deleted with
12592 * elm_list_item_del().
12594 * Associated @p data can be properly freed when item is deleted if a
12595 * callback function is set with elm_list_item_del_cb_set().
12597 * If a function is passed as argument, it will be called everytime this item
12598 * is selected, i.e., the user clicks over an unselected item.
12599 * If always select is enabled it will call this function every time
12600 * user clicks over an item (already selected or not).
12601 * If such function isn't needed, just passing
12602 * @c NULL as @p func is enough. The same should be done for @p data.
12604 * Simple example (with no function callback or data associated):
12606 * li = elm_list_add(win);
12607 * ic = elm_icon_add(win);
12608 * elm_icon_file_set(ic, "path/to/image", NULL);
12609 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12610 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12612 * evas_object_show(li);
12615 * @see elm_list_always_select_mode_set()
12616 * @see elm_list_item_del()
12617 * @see elm_list_item_del_cb_set()
12618 * @see elm_list_clear()
12619 * @see elm_icon_add()
12623 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);
12626 * Prepend a new item to the list object.
12628 * @param obj The list object.
12629 * @param label The label of the list item.
12630 * @param icon The icon object to use for the left side of the item. An
12631 * icon can be any Evas object, but usually it is an icon created
12632 * with elm_icon_add().
12633 * @param end The icon object to use for the right side of the item. An
12634 * icon can be any Evas object.
12635 * @param func The function to call when the item is clicked.
12636 * @param data The data to associate with the item for related callbacks.
12638 * @return The created item or @c NULL upon failure.
12640 * A new item will be created and prepended to the list, i.e., will
12641 * be set as @b first item.
12643 * Items created with this method can be deleted with
12644 * elm_list_item_del().
12646 * Associated @p data can be properly freed when item is deleted if a
12647 * callback function is set with elm_list_item_del_cb_set().
12649 * If a function is passed as argument, it will be called everytime this item
12650 * is selected, i.e., the user clicks over an unselected item.
12651 * If always select is enabled it will call this function every time
12652 * user clicks over an item (already selected or not).
12653 * If such function isn't needed, just passing
12654 * @c NULL as @p func is enough. The same should be done for @p data.
12656 * @see elm_list_item_append() for a simple code example.
12657 * @see elm_list_always_select_mode_set()
12658 * @see elm_list_item_del()
12659 * @see elm_list_item_del_cb_set()
12660 * @see elm_list_clear()
12661 * @see elm_icon_add()
12665 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);
12668 * Insert a new item into the list object before item @p before.
12670 * @param obj The list object.
12671 * @param before The list item to insert before.
12672 * @param label The label of the list item.
12673 * @param icon The icon object to use for the left side of the item. An
12674 * icon can be any Evas object, but usually it is an icon created
12675 * with elm_icon_add().
12676 * @param end The icon object to use for the right side of the item. An
12677 * icon can be any Evas object.
12678 * @param func The function to call when the item is clicked.
12679 * @param data The data to associate with the item for related callbacks.
12681 * @return The created item or @c NULL upon failure.
12683 * A new item will be created and added to the list. Its position in
12684 * this list will be just before item @p before.
12686 * Items created with this method can be deleted with
12687 * elm_list_item_del().
12689 * Associated @p data can be properly freed when item is deleted if a
12690 * callback function is set with elm_list_item_del_cb_set().
12692 * If a function is passed as argument, it will be called everytime this item
12693 * is selected, i.e., the user clicks over an unselected item.
12694 * If always select is enabled it will call this function every time
12695 * user clicks over an item (already selected or not).
12696 * If such function isn't needed, just passing
12697 * @c NULL as @p func is enough. The same should be done for @p data.
12699 * @see elm_list_item_append() for a simple code example.
12700 * @see elm_list_always_select_mode_set()
12701 * @see elm_list_item_del()
12702 * @see elm_list_item_del_cb_set()
12703 * @see elm_list_clear()
12704 * @see elm_icon_add()
12708 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);
12711 * Insert a new item into the list object after item @p after.
12713 * @param obj The list object.
12714 * @param after The list item to insert after.
12715 * @param label The label of the list item.
12716 * @param icon The icon object to use for the left side of the item. An
12717 * icon can be any Evas object, but usually it is an icon created
12718 * with elm_icon_add().
12719 * @param end The icon object to use for the right side of the item. An
12720 * icon can be any Evas object.
12721 * @param func The function to call when the item is clicked.
12722 * @param data The data to associate with the item for related callbacks.
12724 * @return The created item or @c NULL upon failure.
12726 * A new item will be created and added to the list. Its position in
12727 * this list will be just after item @p after.
12729 * Items created with this method can be deleted with
12730 * elm_list_item_del().
12732 * Associated @p data can be properly freed when item is deleted if a
12733 * callback function is set with elm_list_item_del_cb_set().
12735 * If a function is passed as argument, it will be called everytime this item
12736 * is selected, i.e., the user clicks over an unselected item.
12737 * If always select is enabled it will call this function every time
12738 * user clicks over an item (already selected or not).
12739 * If such function isn't needed, just passing
12740 * @c NULL as @p func is enough. The same should be done for @p data.
12742 * @see elm_list_item_append() for a simple code example.
12743 * @see elm_list_always_select_mode_set()
12744 * @see elm_list_item_del()
12745 * @see elm_list_item_del_cb_set()
12746 * @see elm_list_clear()
12747 * @see elm_icon_add()
12751 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);
12754 * Insert a new item into the sorted list object.
12756 * @param obj The list object.
12757 * @param label The label of the list item.
12758 * @param icon The icon object to use for the left side of the item. An
12759 * icon can be any Evas object, but usually it is an icon created
12760 * with elm_icon_add().
12761 * @param end The icon object to use for the right side of the item. An
12762 * icon can be any Evas object.
12763 * @param func The function to call when the item is clicked.
12764 * @param data The data to associate with the item for related callbacks.
12765 * @param cmp_func The comparing function to be used to sort list
12766 * items <b>by #Elm_List_Item item handles</b>. This function will
12767 * receive two items and compare them, returning a non-negative integer
12768 * if the second item should be place after the first, or negative value
12769 * if should be placed before.
12771 * @return The created item or @c NULL upon failure.
12773 * @note This function inserts values into a list object assuming it was
12774 * sorted and the result will be sorted.
12776 * A new item will be created and added to the list. Its position in
12777 * this list will be found comparing the new item with previously inserted
12778 * items using function @p cmp_func.
12780 * Items created with this method can be deleted with
12781 * elm_list_item_del().
12783 * Associated @p data can be properly freed when item is deleted if a
12784 * callback function is set with elm_list_item_del_cb_set().
12786 * If a function is passed as argument, it will be called everytime this item
12787 * is selected, i.e., the user clicks over an unselected item.
12788 * If always select is enabled it will call this function every time
12789 * user clicks over an item (already selected or not).
12790 * If such function isn't needed, just passing
12791 * @c NULL as @p func is enough. The same should be done for @p data.
12793 * @see elm_list_item_append() for a simple code example.
12794 * @see elm_list_always_select_mode_set()
12795 * @see elm_list_item_del()
12796 * @see elm_list_item_del_cb_set()
12797 * @see elm_list_clear()
12798 * @see elm_icon_add()
12802 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);
12805 * Remove all list's items.
12807 * @param obj The list object
12809 * @see elm_list_item_del()
12810 * @see elm_list_item_append()
12814 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12817 * Get a list of all the list items.
12819 * @param obj The list object
12820 * @return An @c Eina_List of list items, #Elm_List_Item,
12821 * or @c NULL on failure.
12823 * @see elm_list_item_append()
12824 * @see elm_list_item_del()
12825 * @see elm_list_clear()
12829 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12832 * Get the selected item.
12834 * @param obj The list object.
12835 * @return The selected list item.
12837 * The selected item can be unselected with function
12838 * elm_list_item_selected_set().
12840 * The selected item always will be highlighted on list.
12842 * @see elm_list_selected_items_get()
12846 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12849 * Return a list of the currently selected list items.
12851 * @param obj The list object.
12852 * @return An @c Eina_List of list items, #Elm_List_Item,
12853 * or @c NULL on failure.
12855 * Multiple items can be selected if multi select is enabled. It can be
12856 * done with elm_list_multi_select_set().
12858 * @see elm_list_selected_item_get()
12859 * @see elm_list_multi_select_set()
12863 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12866 * Set the selected state of an item.
12868 * @param item The list item
12869 * @param selected The selected state
12871 * This sets the selected state of the given item @p it.
12872 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
12874 * If a new item is selected the previosly selected will be unselected,
12875 * unless multiple selection is enabled with elm_list_multi_select_set().
12876 * Previoulsy selected item can be get with function
12877 * elm_list_selected_item_get().
12879 * Selected items will be highlighted.
12881 * @see elm_list_item_selected_get()
12882 * @see elm_list_selected_item_get()
12883 * @see elm_list_multi_select_set()
12887 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12890 * Get whether the @p item is selected or not.
12892 * @param item The list item.
12893 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
12894 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
12896 * @see elm_list_selected_item_set() for details.
12897 * @see elm_list_item_selected_get()
12901 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12904 * Set or unset item as a separator.
12906 * @param it The list item.
12907 * @param setting @c EINA_TRUE to set item @p it as separator or
12908 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
12910 * Items aren't set as separator by default.
12912 * If set as separator it will display separator theme, so won't display
12915 * @see elm_list_item_separator_get()
12919 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
12922 * Get a value whether item is a separator or not.
12924 * @see elm_list_item_separator_set() for details.
12926 * @param it The list item.
12927 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
12928 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
12932 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
12935 * Show @p item in the list view.
12937 * @param item The list item to be shown.
12939 * It won't animate list until item is visible. If such behavior is wanted,
12940 * use elm_list_bring_in() intead.
12944 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12947 * Bring in the given item to list view.
12949 * @param item The item.
12951 * This causes list to jump to the given item @p item and show it
12952 * (by scrolling), if it is not fully visible.
12954 * This may use animation to do so and take a period of time.
12956 * If animation isn't wanted, elm_list_item_show() can be used.
12960 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12963 * Delete them item from the list.
12965 * @param item The item of list to be deleted.
12967 * If deleting all list items is required, elm_list_clear()
12968 * should be used instead of getting items list and deleting each one.
12970 * @see elm_list_clear()
12971 * @see elm_list_item_append()
12972 * @see elm_list_item_del_cb_set()
12976 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12979 * Set the function called when a list item is freed.
12981 * @param item The item to set the callback on
12982 * @param func The function called
12984 * If there is a @p func, then it will be called prior item's memory release.
12985 * That will be called with the following arguments:
12987 * @li item's Evas object;
12990 * This way, a data associated to a list item could be properly freed.
12994 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12997 * Get the data associated to the item.
12999 * @param item The list item
13000 * @return The data associated to @p item
13002 * The return value is a pointer to data associated to @p item when it was
13003 * created, with function elm_list_item_append() or similar. If no data
13004 * was passed as argument, it will return @c NULL.
13006 * @see elm_list_item_append()
13010 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13013 * Get the left side icon associated to the item.
13015 * @param item The list item
13016 * @return The left side icon associated to @p item
13018 * The return value is a pointer to the icon associated to @p item when
13020 * created, with function elm_list_item_append() or similar, or later
13021 * with function elm_list_item_icon_set(). If no icon
13022 * was passed as argument, it will return @c NULL.
13024 * @see elm_list_item_append()
13025 * @see elm_list_item_icon_set()
13029 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13032 * Set the left side icon associated to the item.
13034 * @param item The list item
13035 * @param icon The left side icon object to associate with @p item
13037 * The icon object to use at left side of the item. An
13038 * icon can be any Evas object, but usually it is an icon created
13039 * with elm_icon_add().
13041 * Once the icon object is set, a previously set one will be deleted.
13042 * @warning Setting the same icon for two items will cause the icon to
13043 * dissapear from the first item.
13045 * If an icon was passed as argument on item creation, with function
13046 * elm_list_item_append() or similar, it will be already
13047 * associated to the item.
13049 * @see elm_list_item_append()
13050 * @see elm_list_item_icon_get()
13054 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13057 * Get the right side icon associated to the item.
13059 * @param item The list item
13060 * @return The right side icon associated to @p item
13062 * The return value is a pointer to the icon associated to @p item when
13064 * created, with function elm_list_item_append() or similar, or later
13065 * with function elm_list_item_icon_set(). If no icon
13066 * was passed as argument, it will return @c NULL.
13068 * @see elm_list_item_append()
13069 * @see elm_list_item_icon_set()
13073 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13076 * Set the right side icon associated to the item.
13078 * @param item The list item
13079 * @param end The right side icon object to associate with @p item
13081 * The icon object to use at right side of the item. An
13082 * icon can be any Evas object, but usually it is an icon created
13083 * with elm_icon_add().
13085 * Once the icon object is set, a previously set one will be deleted.
13086 * @warning Setting the same icon for two items will cause the icon to
13087 * dissapear from the first item.
13089 * If an icon was passed as argument on item creation, with function
13090 * elm_list_item_append() or similar, it will be already
13091 * associated to the item.
13093 * @see elm_list_item_append()
13094 * @see elm_list_item_end_get()
13098 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13101 * Gets the base object of the item.
13103 * @param item The list item
13104 * @return The base object associated with @p item
13106 * Base object is the @c Evas_Object that represents that item.
13110 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13113 * Get the label of item.
13115 * @param item The item of list.
13116 * @return The label of item.
13118 * The return value is a pointer to the label associated to @p item when
13119 * it was created, with function elm_list_item_append(), or later
13120 * with function elm_list_item_label_set. If no label
13121 * was passed as argument, it will return @c NULL.
13123 * @see elm_list_item_label_set() for more details.
13124 * @see elm_list_item_append()
13128 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13131 * Set the label of item.
13133 * @param item The item of list.
13134 * @param text The label of item.
13136 * The label to be displayed by the item.
13137 * Label will be placed between left and right side icons (if set).
13139 * If a label was passed as argument on item creation, with function
13140 * elm_list_item_append() or similar, it will be already
13141 * displayed by the item.
13143 * @see elm_list_item_label_get()
13144 * @see elm_list_item_append()
13148 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13152 * Get the item before @p it in list.
13154 * @param it The list item.
13155 * @return The item before @p it, or @c NULL if none or on failure.
13157 * @note If it is the first item, @c NULL will be returned.
13159 * @see elm_list_item_append()
13160 * @see elm_list_items_get()
13164 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13167 * Get the item after @p it in list.
13169 * @param it The list item.
13170 * @return The item after @p it, or @c NULL if none or on failure.
13172 * @note If it is the last item, @c NULL will be returned.
13174 * @see elm_list_item_append()
13175 * @see elm_list_items_get()
13179 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13182 * Sets the disabled/enabled state of a list item.
13184 * @param it The item.
13185 * @param disabled The disabled state.
13187 * A disabled item cannot be selected or unselected. It will also
13188 * change its appearance (generally greyed out). This sets the
13189 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13194 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13197 * Get a value whether list item is disabled or not.
13199 * @param it The item.
13200 * @return The disabled state.
13202 * @see elm_list_item_disabled_set() for more details.
13206 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13209 * Set the text to be shown in a given list item's tooltips.
13211 * @param item Target item.
13212 * @param text The text to set in the content.
13214 * Setup the text as tooltip to object. The item can have only one tooltip,
13215 * so any previous tooltip data - set with this function or
13216 * elm_list_item_tooltip_content_cb_set() - is removed.
13218 * @see elm_object_tooltip_text_set() for more details.
13222 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13226 * @brief Disable size restrictions on an object's tooltip
13227 * @param item The tooltip's anchor object
13228 * @param disable If EINA_TRUE, size restrictions are disabled
13229 * @return EINA_FALSE on failure, EINA_TRUE on success
13231 * This function allows a tooltip to expand beyond its parant window's canvas.
13232 * It will instead be limited only by the size of the display.
13234 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13236 * @brief Retrieve size restriction state of an object's tooltip
13237 * @param obj The tooltip's anchor object
13238 * @return If EINA_TRUE, size restrictions are disabled
13240 * This function returns whether a tooltip is allowed to expand beyond
13241 * its parant window's canvas.
13242 * It will instead be limited only by the size of the display.
13244 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13247 * Set the content to be shown in the tooltip item.
13249 * Setup the tooltip to item. The item can have only one tooltip,
13250 * so any previous tooltip data is removed. @p func(with @p data) will
13251 * be called every time that need show the tooltip and it should
13252 * return a valid Evas_Object. This object is then managed fully by
13253 * tooltip system and is deleted when the tooltip is gone.
13255 * @param item the list item being attached a tooltip.
13256 * @param func the function used to create the tooltip contents.
13257 * @param data what to provide to @a func as callback data/context.
13258 * @param del_cb called when data is not needed anymore, either when
13259 * another callback replaces @a func, the tooltip is unset with
13260 * elm_list_item_tooltip_unset() or the owner @a item
13261 * dies. This callback receives as the first parameter the
13262 * given @a data, and @c event_info is the item.
13264 * @see elm_object_tooltip_content_cb_set() for more details.
13268 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);
13271 * Unset tooltip from item.
13273 * @param item list item to remove previously set tooltip.
13275 * Remove tooltip from item. The callback provided as del_cb to
13276 * elm_list_item_tooltip_content_cb_set() will be called to notify
13277 * it is not used anymore.
13279 * @see elm_object_tooltip_unset() for more details.
13280 * @see elm_list_item_tooltip_content_cb_set()
13284 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13287 * Sets a different style for this item tooltip.
13289 * @note before you set a style you should define a tooltip with
13290 * elm_list_item_tooltip_content_cb_set() or
13291 * elm_list_item_tooltip_text_set()
13293 * @param item list item with tooltip already set.
13294 * @param style the theme style to use (default, transparent, ...)
13296 * @see elm_object_tooltip_style_set() for more details.
13300 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13303 * Get the style for this item tooltip.
13305 * @param item list item with tooltip already set.
13306 * @return style the theme style in use, defaults to "default". If the
13307 * object does not have a tooltip set, then NULL is returned.
13309 * @see elm_object_tooltip_style_get() for more details.
13310 * @see elm_list_item_tooltip_style_set()
13314 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13317 * Set the type of mouse pointer/cursor decoration to be shown,
13318 * when the mouse pointer is over the given list widget item
13320 * @param item list item to customize cursor on
13321 * @param cursor the cursor type's name
13323 * This function works analogously as elm_object_cursor_set(), but
13324 * here the cursor's changing area is restricted to the item's
13325 * area, and not the whole widget's. Note that that item cursors
13326 * have precedence over widget cursors, so that a mouse over an
13327 * item with custom cursor set will always show @b that cursor.
13329 * If this function is called twice for an object, a previously set
13330 * cursor will be unset on the second call.
13332 * @see elm_object_cursor_set()
13333 * @see elm_list_item_cursor_get()
13334 * @see elm_list_item_cursor_unset()
13338 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13341 * Get the type of mouse pointer/cursor decoration set to be shown,
13342 * when the mouse pointer is over the given list widget item
13344 * @param item list item with custom cursor set
13345 * @return the cursor type's name or @c NULL, if no custom cursors
13346 * were set to @p item (and on errors)
13348 * @see elm_object_cursor_get()
13349 * @see elm_list_item_cursor_set()
13350 * @see elm_list_item_cursor_unset()
13354 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13357 * Unset any custom mouse pointer/cursor decoration set to be
13358 * shown, when the mouse pointer is over the given list widget
13359 * item, thus making it show the @b default cursor again.
13361 * @param item a list item
13363 * Use this call to undo any custom settings on this item's cursor
13364 * decoration, bringing it back to defaults (no custom style set).
13366 * @see elm_object_cursor_unset()
13367 * @see elm_list_item_cursor_set()
13371 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13374 * Set a different @b style for a given custom cursor set for a
13377 * @param item list item with custom cursor set
13378 * @param style the <b>theme style</b> to use (e.g. @c "default",
13379 * @c "transparent", etc)
13381 * This function only makes sense when one is using custom mouse
13382 * cursor decorations <b>defined in a theme file</b>, which can have,
13383 * given a cursor name/type, <b>alternate styles</b> on it. It
13384 * works analogously as elm_object_cursor_style_set(), but here
13385 * applyed only to list item objects.
13387 * @warning Before you set a cursor style you should have definen a
13388 * custom cursor previously on the item, with
13389 * elm_list_item_cursor_set()
13391 * @see elm_list_item_cursor_engine_only_set()
13392 * @see elm_list_item_cursor_style_get()
13396 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13399 * Get the current @b style set for a given list item's custom
13402 * @param item list item with custom cursor set.
13403 * @return style the cursor style in use. If the object does not
13404 * have a cursor set, then @c NULL is returned.
13406 * @see elm_list_item_cursor_style_set() for more details
13410 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13413 * Set if the (custom)cursor for a given list item should be
13414 * searched in its theme, also, or should only rely on the
13415 * rendering engine.
13417 * @param item item with custom (custom) cursor already set on
13418 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13419 * only on those provided by the rendering engine, @c EINA_FALSE to
13420 * have them searched on the widget's theme, as well.
13422 * @note This call is of use only if you've set a custom cursor
13423 * for list items, with elm_list_item_cursor_set().
13425 * @note By default, cursors will only be looked for between those
13426 * provided by the rendering engine.
13430 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13433 * Get if the (custom) cursor for a given list item is being
13434 * searched in its theme, also, or is only relying on the rendering
13437 * @param item a list item
13438 * @return @c EINA_TRUE, if cursors are being looked for only on
13439 * those provided by the rendering engine, @c EINA_FALSE if they
13440 * are being searched on the widget's theme, as well.
13442 * @see elm_list_item_cursor_engine_only_set(), for more details
13446 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13453 * @defgroup Slider Slider
13454 * @ingroup Elementary
13456 * @image html img/widget/slider/preview-00.png
13457 * @image latex img/widget/slider/preview-00.eps width=\textwidth
13459 * The slider adds a dragable “slider” widget for selecting the value of
13460 * something within a range.
13462 * A slider can be horizontal or vertical. It can contain an Icon and has a
13463 * primary label as well as a units label (that is formatted with floating
13464 * point values and thus accepts a printf-style format string, like
13465 * “%1.2f units”. There is also an indicator string that may be somewhere
13466 * else (like on the slider itself) that also accepts a format string like
13467 * units. Label, Icon Unit and Indicator strings/objects are optional.
13469 * A slider may be inverted which means values invert, with high vales being
13470 * on the left or top and low values on the right or bottom (as opposed to
13471 * normally being low on the left or top and high on the bottom and right).
13473 * The slider should have its minimum and maximum values set by the
13474 * application with elm_slider_min_max_set() and value should also be set by
13475 * the application before use with elm_slider_value_set(). The span of the
13476 * slider is its length (horizontally or vertically). This will be scaled by
13477 * the object or applications scaling factor. At any point code can query the
13478 * slider for its value with elm_slider_value_get().
13480 * Smart callbacks one can listen to:
13481 * - "changed" - Whenever the slider value is changed by the user.
13482 * - "slider,drag,start" - dragging the slider indicator around has started.
13483 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13484 * - "delay,changed" - A short time after the value is changed by the user.
13485 * This will be called only when the user stops dragging for
13486 * a very short period or when they release their
13487 * finger/mouse, so it avoids possibly expensive reactions to
13488 * the value change.
13490 * Available styles for it:
13493 * Here is an example on its usage:
13494 * @li @ref slider_example
13498 * @addtogroup Slider
13503 * Add a new slider widget to the given parent Elementary
13504 * (container) object.
13506 * @param parent The parent object.
13507 * @return a new slider widget handle or @c NULL, on errors.
13509 * This function inserts a new slider widget on the canvas.
13513 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13516 * Set the label of a given slider widget
13518 * @param obj The progress bar object
13519 * @param label The text label string, in UTF-8
13522 * @deprecated use elm_object_text_set() instead.
13524 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13527 * Get the label of a given slider widget
13529 * @param obj The progressbar object
13530 * @return The text label string, in UTF-8
13533 * @deprecated use elm_object_text_get() instead.
13535 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13538 * Set the icon object of the slider object.
13540 * @param obj The slider object.
13541 * @param icon The icon object.
13543 * On horizontal mode, icon is placed at left, and on vertical mode,
13546 * @note Once the icon object is set, a previously set one will be deleted.
13547 * If you want to keep that old content object, use the
13548 * elm_slider_icon_unset() function.
13550 * @warning If the object being set does not have minimum size hints set,
13551 * it won't get properly displayed.
13555 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13558 * Unset an icon set on a given slider widget.
13560 * @param obj The slider object.
13561 * @return The icon object that was being used, if any was set, or
13562 * @c NULL, otherwise (and on errors).
13564 * On horizontal mode, icon is placed at left, and on vertical mode,
13567 * This call will unparent and return the icon object which was set
13568 * for this widget, previously, on success.
13570 * @see elm_slider_icon_set() for more details
13571 * @see elm_slider_icon_get()
13575 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13578 * Retrieve the icon object set for a given slider widget.
13580 * @param obj The slider object.
13581 * @return The icon object's handle, if @p obj had one set, or @c NULL,
13582 * otherwise (and on errors).
13584 * On horizontal mode, icon is placed at left, and on vertical mode,
13587 * @see elm_slider_icon_set() for more details
13588 * @see elm_slider_icon_unset()
13592 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13595 * Set the end object of the slider object.
13597 * @param obj The slider object.
13598 * @param end The end object.
13600 * On horizontal mode, end is placed at left, and on vertical mode,
13601 * placed at bottom.
13603 * @note Once the icon object is set, a previously set one will be deleted.
13604 * If you want to keep that old content object, use the
13605 * elm_slider_end_unset() function.
13607 * @warning If the object being set does not have minimum size hints set,
13608 * it won't get properly displayed.
13612 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13615 * Unset an end object set on a given slider widget.
13617 * @param obj The slider object.
13618 * @return The end object that was being used, if any was set, or
13619 * @c NULL, otherwise (and on errors).
13621 * On horizontal mode, end is placed at left, and on vertical mode,
13622 * placed at bottom.
13624 * This call will unparent and return the icon object which was set
13625 * for this widget, previously, on success.
13627 * @see elm_slider_end_set() for more details.
13628 * @see elm_slider_end_get()
13632 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13635 * Retrieve the end object set for a given slider widget.
13637 * @param obj The slider object.
13638 * @return The end object's handle, if @p obj had one set, or @c NULL,
13639 * otherwise (and on errors).
13641 * On horizontal mode, icon is placed at right, and on vertical mode,
13642 * placed at bottom.
13644 * @see elm_slider_end_set() for more details.
13645 * @see elm_slider_end_unset()
13649 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13652 * Set the (exact) length of the bar region of a given slider widget.
13654 * @param obj The slider object.
13655 * @param size The length of the slider's bar region.
13657 * This sets the minimum width (when in horizontal mode) or height
13658 * (when in vertical mode) of the actual bar area of the slider
13659 * @p obj. This in turn affects the object's minimum size. Use
13660 * this when you're not setting other size hints expanding on the
13661 * given direction (like weight and alignment hints) and you would
13662 * like it to have a specific size.
13664 * @note Icon, end, label, indicator and unit text around @p obj
13665 * will require their
13666 * own space, which will make @p obj to require more the @p size,
13669 * @see elm_slider_span_size_get()
13673 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13676 * Get the length set for the bar region of a given slider widget
13678 * @param obj The slider object.
13679 * @return The length of the slider's bar region.
13681 * If that size was not set previously, with
13682 * elm_slider_span_size_set(), this call will return @c 0.
13686 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13689 * Set the format string for the unit label.
13691 * @param obj The slider object.
13692 * @param format The format string for the unit display.
13694 * Unit label is displayed all the time, if set, after slider's bar.
13695 * In horizontal mode, at right and in vertical mode, at bottom.
13697 * If @c NULL, unit label won't be visible. If not it sets the format
13698 * string for the label text. To the label text is provided a floating point
13699 * value, so the label text can display up to 1 floating point value.
13700 * Note that this is optional.
13702 * Use a format string such as "%1.2f meters" for example, and it will
13703 * display values like: "3.14 meters" for a value equal to 3.14159.
13705 * Default is unit label disabled.
13707 * @see elm_slider_indicator_format_get()
13711 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13714 * Get the unit label format of the slider.
13716 * @param obj The slider object.
13717 * @return The unit label format string in UTF-8.
13719 * Unit label is displayed all the time, if set, after slider's bar.
13720 * In horizontal mode, at right and in vertical mode, at bottom.
13722 * @see elm_slider_unit_format_set() for more
13723 * information on how this works.
13727 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13730 * Set the format string for the indicator label.
13732 * @param obj The slider object.
13733 * @param indicator The format string for the indicator display.
13735 * The slider may display its value somewhere else then unit label,
13736 * for example, above the slider knob that is dragged around. This function
13737 * sets the format string used for this.
13739 * If @c NULL, indicator label won't be visible. If not it sets the format
13740 * string for the label text. To the label text is provided a floating point
13741 * value, so the label text can display up to 1 floating point value.
13742 * Note that this is optional.
13744 * Use a format string such as "%1.2f meters" for example, and it will
13745 * display values like: "3.14 meters" for a value equal to 3.14159.
13747 * Default is indicator label disabled.
13749 * @see elm_slider_indicator_format_get()
13753 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
13756 * Get the indicator label format of the slider.
13758 * @param obj The slider object.
13759 * @return The indicator label format string in UTF-8.
13761 * The slider may display its value somewhere else then unit label,
13762 * for example, above the slider knob that is dragged around. This function
13763 * gets the format string used for this.
13765 * @see elm_slider_indicator_format_set() for more
13766 * information on how this works.
13770 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13773 * Set the format function pointer for the indicator label
13775 * @param obj The slider object.
13776 * @param func The indicator format function.
13777 * @param free_func The freeing function for the format string.
13779 * Set the callback function to format the indicator string.
13781 * @see elm_slider_indicator_format_set() for more info on how this works.
13785 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);
13788 * Set the format function pointer for the units label
13790 * @param obj The slider object.
13791 * @param func The units format function.
13792 * @param free_func The freeing function for the format string.
13794 * Set the callback function to format the indicator string.
13796 * @see elm_slider_units_format_set() for more info on how this works.
13800 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);
13803 * Set the orientation of a given slider widget.
13805 * @param obj The slider object.
13806 * @param horizontal Use @c EINA_TRUE to make @p obj to be
13807 * @b horizontal, @c EINA_FALSE to make it @b vertical.
13809 * Use this function to change how your slider is to be
13810 * disposed: vertically or horizontally.
13812 * By default it's displayed horizontally.
13814 * @see elm_slider_horizontal_get()
13818 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13821 * Retrieve the orientation of a given slider widget
13823 * @param obj The slider object.
13824 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
13825 * @c EINA_FALSE if it's @b vertical (and on errors).
13827 * @see elm_slider_horizontal_set() for more details.
13831 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13834 * Set the minimum and maximum values for the slider.
13836 * @param obj The slider object.
13837 * @param min The minimum value.
13838 * @param max The maximum value.
13840 * Define the allowed range of values to be selected by the user.
13842 * If actual value is less than @p min, it will be updated to @p min. If it
13843 * is bigger then @p max, will be updated to @p max. Actual value can be
13844 * get with elm_slider_value_get().
13846 * By default, min is equal to 0.0, and max is equal to 1.0.
13848 * @warning Maximum must be greater than minimum, otherwise behavior
13851 * @see elm_slider_min_max_get()
13855 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
13858 * Get the minimum and maximum values of the slider.
13860 * @param obj The slider object.
13861 * @param min Pointer where to store the minimum value.
13862 * @param max Pointer where to store the maximum value.
13864 * @note If only one value is needed, the other pointer can be passed
13867 * @see elm_slider_min_max_set() for details.
13871 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
13874 * Set the value the slider displays.
13876 * @param obj The slider object.
13877 * @param val The value to be displayed.
13879 * Value will be presented on the unit label following format specified with
13880 * elm_slider_unit_format_set() and on indicator with
13881 * elm_slider_indicator_format_set().
13883 * @warning The value must to be between min and max values. This values
13884 * are set by elm_slider_min_max_set().
13886 * @see elm_slider_value_get()
13887 * @see elm_slider_unit_format_set()
13888 * @see elm_slider_indicator_format_set()
13889 * @see elm_slider_min_max_set()
13893 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
13896 * Get the value displayed by the spinner.
13898 * @param obj The spinner object.
13899 * @return The value displayed.
13901 * @see elm_spinner_value_set() for details.
13905 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13908 * Invert a given slider widget's displaying values order
13910 * @param obj The slider object.
13911 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
13912 * @c EINA_FALSE to bring it back to default, non-inverted values.
13914 * A slider may be @b inverted, in which state it gets its
13915 * values inverted, with high vales being on the left or top and
13916 * low values on the right or bottom, as opposed to normally have
13917 * the low values on the former and high values on the latter,
13918 * respectively, for horizontal and vertical modes.
13920 * @see elm_slider_inverted_get()
13924 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
13927 * Get whether a given slider widget's displaying values are
13930 * @param obj The slider object.
13931 * @return @c EINA_TRUE, if @p obj has inverted values,
13932 * @c EINA_FALSE otherwise (and on errors).
13934 * @see elm_slider_inverted_set() for more details.
13938 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13941 * Set whether to enlarge slider indicator (augmented knob) or not.
13943 * @param obj The slider object.
13944 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
13945 * let the knob always at default size.
13947 * By default, indicator will be bigger while dragged by the user.
13949 * @warning It won't display values set with
13950 * elm_slider_indicator_format_set() if you disable indicator.
13954 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
13957 * Get whether a given slider widget's enlarging indicator or not.
13959 * @param obj The slider object.
13960 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
13961 * @c EINA_FALSE otherwise (and on errors).
13963 * @see elm_slider_indicator_show_set() for details.
13967 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13974 * @addtogroup Actionslider Actionslider
13976 * @image html img/widget/actionslider/preview-00.png
13977 * @image latex img/widget/actionslider/preview-00.eps
13979 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
13980 * properties. The indicator is the element the user drags to choose a label.
13981 * When the position is set with magnet, when released the indicator will be
13982 * moved to it if it's nearest the magnetized position.
13984 * @note By default all positions are set as enabled.
13986 * Signals that you can add callbacks for are:
13988 * "selected" - when user selects an enabled position (the label is passed
13991 * "pos_changed" - when the indicator reaches any of the positions("left",
13992 * "right" or "center").
13994 * See an example of actionslider usage @ref actionslider_example_page "here"
13997 typedef enum _Elm_Actionslider_Pos
13999 ELM_ACTIONSLIDER_NONE = 0,
14000 ELM_ACTIONSLIDER_LEFT = 1 << 0,
14001 ELM_ACTIONSLIDER_CENTER = 1 << 1,
14002 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
14003 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
14004 } Elm_Actionslider_Pos;
14007 * Add a new actionslider to the parent.
14009 * @param parent The parent object
14010 * @return The new actionslider object or NULL if it cannot be created
14012 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14014 * Set actionslider labels.
14016 * @param obj The actionslider object
14017 * @param left_label The label to be set on the left.
14018 * @param center_label The label to be set on the center.
14019 * @param right_label The label to be set on the right.
14020 * @deprecated use elm_object_text_set() instead.
14022 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);
14024 * Get actionslider labels.
14026 * @param obj The actionslider object
14027 * @param left_label A char** to place the left_label of @p obj into.
14028 * @param center_label A char** to place the center_label of @p obj into.
14029 * @param right_label A char** to place the right_label of @p obj into.
14030 * @deprecated use elm_object_text_set() instead.
14032 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);
14034 * Get actionslider selected label.
14036 * @param obj The actionslider object
14037 * @return The selected label
14039 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14041 * Set actionslider indicator position.
14043 * @param obj The actionslider object.
14044 * @param pos The position of the indicator.
14046 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14048 * Get actionslider indicator position.
14050 * @param obj The actionslider object.
14051 * @return The position of the indicator.
14053 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14055 * Set actionslider magnet position. To make multiple positions magnets @c or
14056 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14058 * @param obj The actionslider object.
14059 * @param pos Bit mask indicating the magnet positions.
14061 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14063 * Get actionslider magnet position.
14065 * @param obj The actionslider object.
14066 * @return The positions with magnet property.
14068 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14070 * Set actionslider enabled position. To set multiple positions as enabled @c or
14071 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14073 * @note All the positions are enabled by default.
14075 * @param obj The actionslider object.
14076 * @param pos Bit mask indicating the enabled positions.
14078 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14080 * Get actionslider enabled position.
14082 * @param obj The actionslider object.
14083 * @return The enabled positions.
14085 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14087 * Set the label used on the indicator.
14089 * @param obj The actionslider object
14090 * @param label The label to be set on the indicator.
14091 * @deprecated use elm_object_text_set() instead.
14093 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14095 * Get the label used on the indicator object.
14097 * @param obj The actionslider object
14098 * @return The indicator label
14099 * @deprecated use elm_object_text_get() instead.
14101 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14107 * @defgroup Genlist Genlist
14109 * @image html img/widget/genlist/preview-00.png
14110 * @image latex img/widget/genlist/preview-00.eps
14111 * @image html img/genlist.png
14112 * @image latex img/genlist.eps
14114 * This widget aims to have more expansive list than the simple list in
14115 * Elementary that could have more flexible items and allow many more entries
14116 * while still being fast and low on memory usage. At the same time it was
14117 * also made to be able to do tree structures. But the price to pay is more
14118 * complexity when it comes to usage. If all you want is a simple list with
14119 * icons and a single label, use the normal @ref List object.
14121 * Genlist has a fairly large API, mostly because it's relatively complex,
14122 * trying to be both expansive, powerful and efficient. First we will begin
14123 * an overview on the theory behind genlist.
14125 * @section Genlist_Item_Class Genlist item classes - creating items
14127 * In order to have the ability to add and delete items on the fly, genlist
14128 * implements a class (callback) system where the application provides a
14129 * structure with information about that type of item (genlist may contain
14130 * multiple different items with different classes, states and styles).
14131 * Genlist will call the functions in this struct (methods) when an item is
14132 * "realized" (i.e., created dynamically, while the user is scrolling the
14133 * grid). All objects will simply be deleted when no longer needed with
14134 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14135 * following members:
14136 * - @c item_style - This is a constant string and simply defines the name
14137 * of the item style. It @b must be specified and the default should be @c
14140 * - @c func - A struct with pointers to functions that will be called when
14141 * an item is going to be actually created. All of them receive a @c data
14142 * parameter that will point to the same data passed to
14143 * elm_genlist_item_append() and related item creation functions, and a @c
14144 * obj parameter that points to the genlist object itself.
14146 * The function pointers inside @c func are @c label_get, @c icon_get, @c
14147 * state_get and @c del. The 3 first functions also receive a @c part
14148 * parameter described below. A brief description of these functions follows:
14150 * - @c label_get - The @c part parameter is the name string of one of the
14151 * existing text parts in the Edje group implementing the item's theme.
14152 * This function @b must return a strdup'()ed string, as the caller will
14153 * free() it when done. See #GenlistItemLabelGetFunc.
14154 * - @c icon_get - The @c part parameter is the name string of one of the
14155 * existing (icon) swallow parts in the Edje group implementing the item's
14156 * theme. It must return @c NULL, when no icon is desired, or a valid
14157 * object handle, otherwise. The object will be deleted by the genlist on
14158 * its deletion or when the item is "unrealized". See
14159 * #GenlistItemIconGetFunc.
14160 * - @c func.state_get - The @c part parameter is the name string of one of
14161 * the state parts in the Edje group implementing the item's theme. Return
14162 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14163 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14164 * and @c "elm" as "emission" and "source" arguments, respectively, when
14165 * the state is true (the default is false), where @c XXX is the name of
14166 * the (state) part. See #GenlistItemStateGetFunc.
14167 * - @c func.del - This is intended for use when genlist items are deleted,
14168 * so any data attached to the item (e.g. its data parameter on creation)
14169 * can be deleted. See #GenlistItemDelFunc.
14171 * available item styles:
14173 * - default_style - The text part is a textblock
14175 * @image html img/widget/genlist/preview-04.png
14176 * @image latex img/widget/genlist/preview-04.eps
14180 * @image html img/widget/genlist/preview-01.png
14181 * @image latex img/widget/genlist/preview-01.eps
14183 * - icon_top_text_bottom
14185 * @image html img/widget/genlist/preview-02.png
14186 * @image latex img/widget/genlist/preview-02.eps
14190 * @image html img/widget/genlist/preview-03.png
14191 * @image latex img/widget/genlist/preview-03.eps
14193 * @section Genlist_Items Structure of items
14195 * An item in a genlist can have 0 or more text labels (they can be regular
14196 * text or textblock Evas objects - that's up to the style to determine), 0
14197 * or more icons (which are simply objects swallowed into the genlist item's
14198 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14199 * behavior left to the user to define. The Edje part names for each of
14200 * these properties will be looked up, in the theme file for the genlist,
14201 * under the Edje (string) data items named @c "labels", @c "icons" and @c
14202 * "states", respectively. For each of those properties, if more than one
14203 * part is provided, they must have names listed separated by spaces in the
14204 * data fields. For the default genlist item theme, we have @b one label
14205 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14206 * "elm.swallow.end") and @b no state parts.
14208 * A genlist item may be at one of several styles. Elementary provides one
14209 * by default - "default", but this can be extended by system or application
14210 * custom themes/overlays/extensions (see @ref Theme "themes" for more
14213 * @section Genlist_Manipulation Editing and Navigating
14215 * Items can be added by several calls. All of them return a @ref
14216 * Elm_Genlist_Item handle that is an internal member inside the genlist.
14217 * They all take a data parameter that is meant to be used for a handle to
14218 * the applications internal data (eg the struct with the original item
14219 * data). The parent parameter is the parent genlist item this belongs to if
14220 * it is a tree or an indexed group, and NULL if there is no parent. The
14221 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14222 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14223 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14224 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
14225 * is set then this item is group index item that is displayed at the top
14226 * until the next group comes. The func parameter is a convenience callback
14227 * that is called when the item is selected and the data parameter will be
14228 * the func_data parameter, obj be the genlist object and event_info will be
14229 * the genlist item.
14231 * elm_genlist_item_append() adds an item to the end of the list, or if
14232 * there is a parent, to the end of all the child items of the parent.
14233 * elm_genlist_item_prepend() is the same but adds to the beginning of
14234 * the list or children list. elm_genlist_item_insert_before() inserts at
14235 * item before another item and elm_genlist_item_insert_after() inserts after
14236 * the indicated item.
14238 * The application can clear the list with elm_genlist_clear() which deletes
14239 * all the items in the list and elm_genlist_item_del() will delete a specific
14240 * item. elm_genlist_item_subitems_clear() will clear all items that are
14241 * children of the indicated parent item.
14243 * To help inspect list items you can jump to the item at the top of the list
14244 * with elm_genlist_first_item_get() which will return the item pointer, and
14245 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14246 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14247 * and previous items respectively relative to the indicated item. Using
14248 * these calls you can walk the entire item list/tree. Note that as a tree
14249 * the items are flattened in the list, so elm_genlist_item_parent_get() will
14250 * let you know which item is the parent (and thus know how to skip them if
14253 * @section Genlist_Muti_Selection Multi-selection
14255 * If the application wants multiple items to be able to be selected,
14256 * elm_genlist_multi_select_set() can enable this. If the list is
14257 * single-selection only (the default), then elm_genlist_selected_item_get()
14258 * will return the selected item, if any, or NULL I none is selected. If the
14259 * list is multi-select then elm_genlist_selected_items_get() will return a
14260 * list (that is only valid as long as no items are modified (added, deleted,
14261 * selected or unselected)).
14263 * @section Genlist_Usage_Hints Usage hints
14265 * There are also convenience functions. elm_genlist_item_genlist_get() will
14266 * return the genlist object the item belongs to. elm_genlist_item_show()
14267 * will make the scroller scroll to show that specific item so its visible.
14268 * elm_genlist_item_data_get() returns the data pointer set by the item
14269 * creation functions.
14271 * If an item changes (state of boolean changes, label or icons change),
14272 * then use elm_genlist_item_update() to have genlist update the item with
14273 * the new state. Genlist will re-realize the item thus call the functions
14274 * in the _Elm_Genlist_Item_Class for that item.
14276 * To programmatically (un)select an item use elm_genlist_item_selected_set().
14277 * To get its selected state use elm_genlist_item_selected_get(). Similarly
14278 * to expand/contract an item and get its expanded state, use
14279 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14280 * again to make an item disabled (unable to be selected and appear
14281 * differently) use elm_genlist_item_disabled_set() to set this and
14282 * elm_genlist_item_disabled_get() to get the disabled state.
14284 * In general to indicate how the genlist should expand items horizontally to
14285 * fill the list area, use elm_genlist_horizontal_mode_set(). Valid modes are
14286 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14287 * mode means that if items are too wide to fit, the scroller will scroll
14288 * horizontally. Otherwise items are expanded to fill the width of the
14289 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14290 * to the viewport width and limited to that size. This can be combined with
14291 * a different style that uses edjes' ellipsis feature (cutting text off like
14294 * Items will only call their selection func and callback when first becoming
14295 * selected. Any further clicks will do nothing, unless you enable always
14296 * select with elm_genlist_always_select_mode_set(). This means even if
14297 * selected, every click will make the selected callbacks be called.
14298 * elm_genlist_no_select_mode_set() will turn off the ability to select
14299 * items entirely and they will neither appear selected nor call selected
14300 * callback functions.
14302 * Remember that you can create new styles and add your own theme augmentation
14303 * per application with elm_theme_extension_add(). If you absolutely must
14304 * have a specific style that overrides any theme the user or system sets up
14305 * you can use elm_theme_overlay_add() to add such a file.
14307 * @section Genlist_Implementation Implementation
14309 * Evas tracks every object you create. Every time it processes an event
14310 * (mouse move, down, up etc.) it needs to walk through objects and find out
14311 * what event that affects. Even worse every time it renders display updates,
14312 * in order to just calculate what to re-draw, it needs to walk through many
14313 * many many objects. Thus, the more objects you keep active, the more
14314 * overhead Evas has in just doing its work. It is advisable to keep your
14315 * active objects to the minimum working set you need. Also remember that
14316 * object creation and deletion carries an overhead, so there is a
14317 * middle-ground, which is not easily determined. But don't keep massive lists
14318 * of objects you can't see or use. Genlist does this with list objects. It
14319 * creates and destroys them dynamically as you scroll around. It groups them
14320 * into blocks so it can determine the visibility etc. of a whole block at
14321 * once as opposed to having to walk the whole list. This 2-level list allows
14322 * for very large numbers of items to be in the list (tests have used up to
14323 * 2,000,000 items). Also genlist employs a queue for adding items. As items
14324 * may be different sizes, every item added needs to be calculated as to its
14325 * size and thus this presents a lot of overhead on populating the list, this
14326 * genlist employs a queue. Any item added is queued and spooled off over
14327 * time, actually appearing some time later, so if your list has many members
14328 * you may find it takes a while for them to all appear, with your process
14329 * consuming a lot of CPU while it is busy spooling.
14331 * Genlist also implements a tree structure, but it does so with callbacks to
14332 * the application, with the application filling in tree structures when
14333 * requested (allowing for efficient building of a very deep tree that could
14334 * even be used for file-management). See the above smart signal callbacks for
14337 * @section Genlist_Smart_Events Genlist smart events
14339 * Signals that you can add callbacks for are:
14340 * - @c "activated" - The user has double-clicked or pressed
14341 * (enter|return|spacebar) on an item. The @c event_info parameter is the
14342 * item that was activated.
14343 * - @c "clicked,double" - The user has double-clicked an item. The @c
14344 * event_info parameter is the item that was double-clicked.
14345 * - @c "selected" - This is called when a user has made an item selected.
14346 * The event_info parameter is the genlist item that was selected.
14347 * - @c "unselected" - This is called when a user has made an item
14348 * unselected. The event_info parameter is the genlist item that was
14350 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14351 * called and the item is now meant to be expanded. The event_info
14352 * parameter is the genlist item that was indicated to expand. It is the
14353 * job of this callback to then fill in the child items.
14354 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14355 * called and the item is now meant to be contracted. The event_info
14356 * parameter is the genlist item that was indicated to contract. It is the
14357 * job of this callback to then delete the child items.
14358 * - @c "expand,request" - This is called when a user has indicated they want
14359 * to expand a tree branch item. The callback should decide if the item can
14360 * expand (has any children) and then call elm_genlist_item_expanded_set()
14361 * appropriately to set the state. The event_info parameter is the genlist
14362 * item that was indicated to expand.
14363 * - @c "contract,request" - This is called when a user has indicated they
14364 * want to contract a tree branch item. The callback should decide if the
14365 * item can contract (has any children) and then call
14366 * elm_genlist_item_expanded_set() appropriately to set the state. The
14367 * event_info parameter is the genlist item that was indicated to contract.
14368 * - @c "realized" - This is called when the item in the list is created as a
14369 * real evas object. event_info parameter is the genlist item that was
14370 * created. The object may be deleted at any time, so it is up to the
14371 * caller to not use the object pointer from elm_genlist_item_object_get()
14372 * in a way where it may point to freed objects.
14373 * - @c "unrealized" - This is called just before an item is unrealized.
14374 * After this call icon objects provided will be deleted and the item
14375 * object itself delete or be put into a floating cache.
14376 * - @c "drag,start,up" - This is called when the item in the list has been
14377 * dragged (not scrolled) up.
14378 * - @c "drag,start,down" - This is called when the item in the list has been
14379 * dragged (not scrolled) down.
14380 * - @c "drag,start,left" - This is called when the item in the list has been
14381 * dragged (not scrolled) left.
14382 * - @c "drag,start,right" - This is called when the item in the list has
14383 * been dragged (not scrolled) right.
14384 * - @c "drag,stop" - This is called when the item in the list has stopped
14386 * - @c "drag" - This is called when the item in the list is being dragged.
14387 * - @c "longpressed" - This is called when the item is pressed for a certain
14388 * amount of time. By default it's 1 second.
14389 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14391 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14392 * until the bottom edge.
14393 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14394 * until the left edge.
14395 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14396 * until the right edge.
14397 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14399 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14401 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14403 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14405 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14406 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
14407 * multi-touch pinched in.
14408 * - @c "swipe" - This is called when the genlist is swiped.
14410 * @section Genlist_Examples Examples
14412 * Here is a list of examples that use the genlist, trying to show some of
14413 * its capabilities:
14414 * - @ref genlist_example_01
14415 * - @ref genlist_example_02
14416 * - @ref genlist_example_03
14417 * - @ref genlist_example_04
14418 * - @ref genlist_example_05
14422 * @addtogroup Genlist
14427 * @enum _Elm_Genlist_Item_Flags
14428 * @typedef Elm_Genlist_Item_Flags
14430 * Defines if the item is of any special type (has subitems or it's the
14431 * index of a group), or is just a simple item.
14435 typedef enum _Elm_Genlist_Item_Flags
14437 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14438 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14439 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14440 } Elm_Genlist_Item_Flags;
14441 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
14442 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14443 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14444 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14445 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
14446 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
14447 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14448 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
14451 * @struct _Elm_Genlist_Item_Class
14453 * Genlist item class definition structs.
14455 * This struct contains the style and fetching functions that will define the
14456 * contents of each item.
14458 * @see @ref Genlist_Item_Class
14460 struct _Elm_Genlist_Item_Class
14462 const char *item_style; /**< style of this class. */
14465 GenlistItemLabelGetFunc label_get; /**< Label fetching class function for genlist item classes.*/
14466 GenlistItemIconGetFunc icon_get; /**< Icon fetching class function for genlist item classes. */
14467 GenlistItemStateGetFunc state_get; /**< State fetching class function for genlist item classes. */
14468 GenlistItemDelFunc del; /**< Deletion class function for genlist item classes. */
14469 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
14471 const char *mode_item_style;
14475 * Add a new genlist widget to the given parent Elementary
14476 * (container) object
14478 * @param parent The parent object
14479 * @return a new genlist widget handle or @c NULL, on errors
14481 * This function inserts a new genlist widget on the canvas.
14483 * @see elm_genlist_item_append()
14484 * @see elm_genlist_item_del()
14485 * @see elm_genlist_clear()
14489 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14491 * Remove all items from a given genlist widget.
14493 * @param obj The genlist object
14495 * This removes (and deletes) all items in @p obj, leaving it empty.
14497 * @see elm_genlist_item_del(), to remove just one item.
14501 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14503 * Enable or disable multi-selection in the genlist
14505 * @param obj The genlist object
14506 * @param multi Multi-select enable/disable. Default is disabled.
14508 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14509 * the list. This allows more than 1 item to be selected. To retrieve the list
14510 * of selected items, use elm_genlist_selected_items_get().
14512 * @see elm_genlist_selected_items_get()
14513 * @see elm_genlist_multi_select_get()
14517 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14519 * Gets if multi-selection in genlist is enabled or disabled.
14521 * @param obj The genlist object
14522 * @return Multi-select enabled/disabled
14523 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14525 * @see elm_genlist_multi_select_set()
14529 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14531 * This sets the horizontal stretching mode.
14533 * @param obj The genlist object
14534 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14536 * This sets the mode used for sizing items horizontally. Valid modes
14537 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14538 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14539 * the scroller will scroll horizontally. Otherwise items are expanded
14540 * to fill the width of the viewport of the scroller. If it is
14541 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14542 * limited to that size.
14544 * @see elm_genlist_horizontal_mode_get()
14548 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14550 * Gets the horizontal stretching mode.
14552 * @param obj The genlist object
14553 * @return The mode to use
14554 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14556 * @see elm_genlist_horizontal_mode_set()
14560 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14562 * Set the always select mode.
14564 * @param obj The genlist object
14565 * @param always_select The always select mode (@c EINA_TRUE = on, @c
14566 * EINA_FALSE = off). Default is @c EINA_FALSE.
14568 * Items will only call their selection func and callback when first
14569 * becoming selected. Any further clicks will do nothing, unless you
14570 * enable always select with elm_genlist_always_select_mode_set().
14571 * This means that, even if selected, every click will make the selected
14572 * callbacks be called.
14574 * @see elm_genlist_always_select_mode_get()
14578 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14580 * Get the always select mode.
14582 * @param obj The genlist object
14583 * @return The always select mode
14584 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14586 * @see elm_genlist_always_select_mode_set()
14590 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14592 * Enable/disable the no select mode.
14594 * @param obj The genlist object
14595 * @param no_select The no select mode
14596 * (EINA_TRUE = on, EINA_FALSE = off)
14598 * This will turn off the ability to select items entirely and they
14599 * will neither appear selected nor call selected callback functions.
14601 * @see elm_genlist_no_select_mode_get()
14605 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14607 * Gets whether the no select mode is enabled.
14609 * @param obj The genlist object
14610 * @return The no select mode
14611 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14613 * @see elm_genlist_no_select_mode_set()
14617 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14619 * Enable/disable compress mode.
14621 * @param obj The genlist object
14622 * @param compress The compress mode
14623 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14625 * This will enable the compress mode where items are "compressed"
14626 * horizontally to fit the genlist scrollable viewport width. This is
14627 * special for genlist. Do not rely on
14628 * elm_genlist_horizontal_mode_set() being set to @c ELM_LIST_COMPRESS to
14629 * work as genlist needs to handle it specially.
14631 * @see elm_genlist_compress_mode_get()
14635 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14637 * Get whether the compress mode is enabled.
14639 * @param obj The genlist object
14640 * @return The compress mode
14641 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14643 * @see elm_genlist_compress_mode_set()
14647 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14649 * Enable/disable height-for-width mode.
14651 * @param obj The genlist object
14652 * @param setting The height-for-width mode (@c EINA_TRUE = on,
14653 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14655 * With height-for-width mode the item width will be fixed (restricted
14656 * to a minimum of) to the list width when calculating its size in
14657 * order to allow the height to be calculated based on it. This allows,
14658 * for instance, text block to wrap lines if the Edje part is
14659 * configured with "text.min: 0 1".
14661 * @note This mode will make list resize slower as it will have to
14662 * recalculate every item height again whenever the list width
14665 * @note When height-for-width mode is enabled, it also enables
14666 * compress mode (see elm_genlist_compress_mode_set()) and
14667 * disables homogeneous (see elm_genlist_homogeneous_set()).
14671 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14673 * Get whether the height-for-width mode is enabled.
14675 * @param obj The genlist object
14676 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14681 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14683 * Enable/disable horizontal and vertical bouncing effect.
14685 * @param obj The genlist object
14686 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14687 * EINA_FALSE = off). Default is @c EINA_FALSE.
14688 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14689 * EINA_FALSE = off). Default is @c EINA_TRUE.
14691 * This will enable or disable the scroller bouncing effect for the
14692 * genlist. See elm_scroller_bounce_set() for details.
14694 * @see elm_scroller_bounce_set()
14695 * @see elm_genlist_bounce_get()
14699 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14701 * Get whether the horizontal and vertical bouncing effect is enabled.
14703 * @param obj The genlist object
14704 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14706 * @param v_bounce Pointer to a bool to receive if the bounce vertically
14709 * @see elm_genlist_bounce_set()
14713 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14715 * Enable/disable homogenous mode.
14717 * @param obj The genlist object
14718 * @param homogeneous Assume the items within the genlist are of the
14719 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
14722 * This will enable the homogeneous mode where items are of the same
14723 * height and width so that genlist may do the lazy-loading at its
14724 * maximum (which increases the performance for scrolling the list). This
14725 * implies 'compressed' mode.
14727 * @see elm_genlist_compress_mode_set()
14728 * @see elm_genlist_homogeneous_get()
14732 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14734 * Get whether the homogenous mode is enabled.
14736 * @param obj The genlist object
14737 * @return Assume the items within the genlist are of the same height
14738 * and width (EINA_TRUE = on, EINA_FALSE = off)
14740 * @see elm_genlist_homogeneous_set()
14744 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14746 * Set the maximum number of items within an item block
14748 * @param obj The genlist object
14749 * @param n Maximum number of items within an item block. Default is 32.
14751 * This will configure the block count to tune to the target with
14752 * particular performance matrix.
14754 * A block of objects will be used to reduce the number of operations due to
14755 * many objects in the screen. It can determine the visibility, or if the
14756 * object has changed, it theme needs to be updated, etc. doing this kind of
14757 * calculation to the entire block, instead of per object.
14759 * The default value for the block count is enough for most lists, so unless
14760 * you know you will have a lot of objects visible in the screen at the same
14761 * time, don't try to change this.
14763 * @see elm_genlist_block_count_get()
14764 * @see @ref Genlist_Implementation
14768 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
14770 * Get the maximum number of items within an item block
14772 * @param obj The genlist object
14773 * @return Maximum number of items within an item block
14775 * @see elm_genlist_block_count_set()
14779 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14781 * Set the timeout in seconds for the longpress event.
14783 * @param obj The genlist object
14784 * @param timeout timeout in seconds. Default is 1.
14786 * This option will change how long it takes to send an event "longpressed"
14787 * after the mouse down signal is sent to the list. If this event occurs, no
14788 * "clicked" event will be sent.
14790 * @see elm_genlist_longpress_timeout_set()
14794 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
14796 * Get the timeout in seconds for the longpress event.
14798 * @param obj The genlist object
14799 * @return timeout in seconds
14801 * @see elm_genlist_longpress_timeout_get()
14805 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14807 * Append a new item in a given genlist widget.
14809 * @param obj The genlist object
14810 * @param itc The item class for the item
14811 * @param data The item data
14812 * @param parent The parent item, or NULL if none
14813 * @param flags Item flags
14814 * @param func Convenience function called when the item is selected
14815 * @param func_data Data passed to @p func above.
14816 * @return A handle to the item added or @c NULL if not possible
14818 * This adds the given item to the end of the list or the end of
14819 * the children list if the @p parent is given.
14821 * @see elm_genlist_item_prepend()
14822 * @see elm_genlist_item_insert_before()
14823 * @see elm_genlist_item_insert_after()
14824 * @see elm_genlist_item_del()
14828 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);
14830 * Prepend a new item in a given genlist widget.
14832 * @param obj The genlist object
14833 * @param itc The item class for the item
14834 * @param data The item data
14835 * @param parent The parent item, or NULL if none
14836 * @param flags Item flags
14837 * @param func Convenience function called when the item is selected
14838 * @param func_data Data passed to @p func above.
14839 * @return A handle to the item added or NULL if not possible
14841 * This adds an item to the beginning of the list or beginning of the
14842 * children of the parent if given.
14844 * @see elm_genlist_item_append()
14845 * @see elm_genlist_item_insert_before()
14846 * @see elm_genlist_item_insert_after()
14847 * @see elm_genlist_item_del()
14851 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);
14853 * Insert an item before another in a genlist widget
14855 * @param obj The genlist object
14856 * @param itc The item class for the item
14857 * @param data The item data
14858 * @param before The item to place this new one before.
14859 * @param flags Item flags
14860 * @param func Convenience function called when the item is selected
14861 * @param func_data Data passed to @p func above.
14862 * @return A handle to the item added or @c NULL if not possible
14864 * This inserts an item before another in the list. It will be in the
14865 * same tree level or group as the item it is inserted before.
14867 * @see elm_genlist_item_append()
14868 * @see elm_genlist_item_prepend()
14869 * @see elm_genlist_item_insert_after()
14870 * @see elm_genlist_item_del()
14874 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);
14876 * Insert an item after another in a genlist widget
14878 * @param obj The genlist object
14879 * @param itc The item class for the item
14880 * @param data The item data
14881 * @param after The item to place this new one after.
14882 * @param flags Item flags
14883 * @param func Convenience function called when the item is selected
14884 * @param func_data Data passed to @p func above.
14885 * @return A handle to the item added or @c NULL if not possible
14887 * This inserts an item after another in the list. It will be in the
14888 * same tree level or group as the item it is inserted after.
14890 * @see elm_genlist_item_append()
14891 * @see elm_genlist_item_prepend()
14892 * @see elm_genlist_item_insert_before()
14893 * @see elm_genlist_item_del()
14897 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);
14899 * Insert a new item into the sorted genlist object
14901 * @param obj The genlist object
14902 * @param itc The item class for the item
14903 * @param data The item data
14904 * @param parent The parent item, or NULL if none
14905 * @param flags Item flags
14906 * @param comp The function called for the sort
14907 * @param func Convenience function called when item selected
14908 * @param func_data Data passed to @p func above.
14909 * @return A handle to the item added or NULL if not possible
14913 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);
14914 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);
14915 /* operations to retrieve existing items */
14917 * Get the selectd item in the genlist.
14919 * @param obj The genlist object
14920 * @return The selected item, or NULL if none is selected.
14922 * This gets the selected item in the list (if multi-selection is enabled, only
14923 * the item that was first selected in the list is returned - which is not very
14924 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
14927 * If no item is selected, NULL is returned.
14929 * @see elm_genlist_selected_items_get()
14933 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14935 * Get a list of selected items in the genlist.
14937 * @param obj The genlist object
14938 * @return The list of selected items, or NULL if none are selected.
14940 * It returns a list of the selected items. This list pointer is only valid so
14941 * long as the selection doesn't change (no items are selected or unselected, or
14942 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
14943 * pointers. The order of the items in this list is the order which they were
14944 * selected, i.e. the first item in this list is the first item that was
14945 * selected, and so on.
14947 * @note If not in multi-select mode, consider using function
14948 * elm_genlist_selected_item_get() instead.
14950 * @see elm_genlist_multi_select_set()
14951 * @see elm_genlist_selected_item_get()
14955 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14957 * Get a list of realized items in genlist
14959 * @param obj The genlist object
14960 * @return The list of realized items, nor NULL if none are realized.
14962 * This returns a list of the realized items in the genlist. The list
14963 * contains Elm_Genlist_Item pointers. The list must be freed by the
14964 * caller when done with eina_list_free(). The item pointers in the
14965 * list are only valid so long as those items are not deleted or the
14966 * genlist is not deleted.
14968 * @see elm_genlist_realized_items_update()
14972 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14974 * Get the item that is at the x, y canvas coords.
14976 * @param obj The gelinst object.
14977 * @param x The input x coordinate
14978 * @param y The input y coordinate
14979 * @param posret The position relative to the item returned here
14980 * @return The item at the coordinates or NULL if none
14982 * This returns the item at the given coordinates (which are canvas
14983 * relative, not object-relative). If an item is at that coordinate,
14984 * that item handle is returned, and if @p posret is not NULL, the
14985 * integer pointed to is set to a value of -1, 0 or 1, depending if
14986 * the coordinate is on the upper portion of that item (-1), on the
14987 * middle section (0) or on the lower part (1). If NULL is returned as
14988 * an item (no item found there), then posret may indicate -1 or 1
14989 * based if the coordinate is above or below all items respectively in
14994 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);
14996 * Get the first item in the genlist
14998 * This returns the first item in the list.
15000 * @param obj The genlist object
15001 * @return The first item, or NULL if none
15005 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15007 * Get the last item in the genlist
15009 * This returns the last item in the list.
15011 * @return The last item, or NULL if none
15015 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15017 * Set the scrollbar policy
15019 * @param obj The genlist object
15020 * @param policy_h Horizontal scrollbar policy.
15021 * @param policy_v Vertical scrollbar policy.
15023 * This sets the scrollbar visibility policy for the given genlist
15024 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15025 * made visible if it is needed, and otherwise kept hidden.
15026 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15027 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15028 * respectively for the horizontal and vertical scrollbars. Default is
15029 * #ELM_SMART_SCROLLER_POLICY_AUTO
15031 * @see elm_genlist_scroller_policy_get()
15035 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15037 * Get the scrollbar policy
15039 * @param obj The genlist object
15040 * @param policy_h Pointer to store the horizontal scrollbar policy.
15041 * @param policy_v Pointer to store the vertical scrollbar policy.
15043 * @see elm_genlist_scroller_policy_set()
15047 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);
15049 * Get the @b next item in a genlist widget's internal list of items,
15050 * given a handle to one of those items.
15052 * @param item The genlist item to fetch next from
15053 * @return The item after @p item, or @c NULL if there's none (and
15056 * This returns the item placed after the @p item, on the container
15059 * @see elm_genlist_item_prev_get()
15063 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15065 * Get the @b previous item in a genlist widget's internal list of items,
15066 * given a handle to one of those items.
15068 * @param item The genlist item to fetch previous from
15069 * @return The item before @p item, or @c NULL if there's none (and
15072 * This returns the item placed before the @p item, on the container
15075 * @see elm_genlist_item_next_get()
15079 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15081 * Get the genlist object's handle which contains a given genlist
15084 * @param item The item to fetch the container from
15085 * @return The genlist (parent) object
15087 * This returns the genlist object itself that an item belongs to.
15091 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15093 * Get the parent item of the given item
15095 * @param it The item
15096 * @return The parent of the item or @c NULL if it has no parent.
15098 * This returns the item that was specified as parent of the item @p it on
15099 * elm_genlist_item_append() and insertion related functions.
15103 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15105 * Remove all sub-items (children) of the given item
15107 * @param it The item
15109 * This removes all items that are children (and their descendants) of the
15110 * given item @p it.
15112 * @see elm_genlist_clear()
15113 * @see elm_genlist_item_del()
15117 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15119 * Set whether a given genlist item is selected or not
15121 * @param it The item
15122 * @param selected Use @c EINA_TRUE, to make it selected, @c
15123 * EINA_FALSE to make it unselected
15125 * This sets the selected state of an item. If multi selection is
15126 * not enabled on the containing genlist and @p selected is @c
15127 * EINA_TRUE, any other previously selected items will get
15128 * unselected in favor of this new one.
15130 * @see elm_genlist_item_selected_get()
15134 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15136 * Get whether a given genlist item is selected or not
15138 * @param it The item
15139 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15141 * @see elm_genlist_item_selected_set() for more details
15145 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15147 * Sets the expanded state of an item.
15149 * @param it The item
15150 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15152 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15155 * The theme will respond to this change visually, and a signal "expanded" or
15156 * "contracted" will be sent from the genlist with a pointer to the item that
15157 * has been expanded/contracted.
15159 * Calling this function won't show or hide any child of this item (if it is
15160 * a parent). You must manually delete and create them on the callbacks fo
15161 * the "expanded" or "contracted" signals.
15163 * @see elm_genlist_item_expanded_get()
15167 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15169 * Get the expanded state of an item
15171 * @param it The item
15172 * @return The expanded state
15174 * This gets the expanded state of an item.
15176 * @see elm_genlist_item_expanded_set()
15180 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15182 * Get the depth of expanded item
15184 * @param it The genlist item object
15185 * @return The depth of expanded item
15189 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15191 * Set whether a given genlist item is disabled or not.
15193 * @param it The item
15194 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15195 * to enable it back.
15197 * A disabled item cannot be selected or unselected. It will also
15198 * change its appearance, to signal the user it's disabled.
15200 * @see elm_genlist_item_disabled_get()
15204 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15206 * Get whether a given genlist item is disabled or not.
15208 * @param it The item
15209 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15212 * @see elm_genlist_item_disabled_set() for more details
15216 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15218 * Sets the display only state of an item.
15220 * @param it The item
15221 * @param display_only @c EINA_TRUE if the item is display only, @c
15222 * EINA_FALSE otherwise.
15224 * A display only item cannot be selected or unselected. It is for
15225 * display only and not selecting or otherwise clicking, dragging
15226 * etc. by the user, thus finger size rules will not be applied to
15229 * It's good to set group index items to display only state.
15231 * @see elm_genlist_item_display_only_get()
15235 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15237 * Get the display only state of an item
15239 * @param it The item
15240 * @return @c EINA_TRUE if the item is display only, @c
15241 * EINA_FALSE otherwise.
15243 * @see elm_genlist_item_display_only_set()
15247 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15249 * Show the portion of a genlist's internal list containing a given
15250 * item, immediately.
15252 * @param it The item to display
15254 * This causes genlist to jump to the given item @p it and show it (by
15255 * immediately scrolling to that position), if it is not fully visible.
15257 * @see elm_genlist_item_bring_in()
15258 * @see elm_genlist_item_top_show()
15259 * @see elm_genlist_item_middle_show()
15263 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15265 * Animatedly bring in, to the visible are of a genlist, a given
15268 * @param it The item to display
15270 * This causes genlist to jump to the given item @p it and show it (by
15271 * animatedly scrolling), if it is not fully visible. This may use animation
15272 * to do so and take a period of time
15274 * @see elm_genlist_item_show()
15275 * @see elm_genlist_item_top_bring_in()
15276 * @see elm_genlist_item_middle_bring_in()
15280 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15282 * Show the portion of a genlist's internal list containing a given
15283 * item, immediately.
15285 * @param it The item to display
15287 * This causes genlist to jump to the given item @p it and show it (by
15288 * immediately scrolling to that position), if it is not fully visible.
15290 * The item will be positioned at the top of the genlist viewport.
15292 * @see elm_genlist_item_show()
15293 * @see elm_genlist_item_top_bring_in()
15297 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15299 * Animatedly bring in, to the visible are of a genlist, a given
15302 * @param it The item
15304 * This causes genlist to jump to the given item @p it and show it (by
15305 * animatedly scrolling), if it is not fully visible. This may use animation
15306 * to do so and take a period of time
15308 * The item will be positioned at the top of the genlist viewport.
15310 * @see elm_genlist_item_bring_in()
15311 * @see elm_genlist_item_top_show()
15315 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15317 * Show the portion of a genlist's internal list containing a given
15318 * item, immediately.
15320 * @param it The item to display
15322 * This causes genlist to jump to the given item @p it and show it (by
15323 * immediately scrolling to that position), if it is not fully visible.
15325 * The item will be positioned at the middle of the genlist viewport.
15327 * @see elm_genlist_item_show()
15328 * @see elm_genlist_item_middle_bring_in()
15332 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15334 * Animatedly bring in, to the visible are of a genlist, a given
15337 * @param it The item
15339 * This causes genlist to jump to the given item @p it and show it (by
15340 * animatedly scrolling), if it is not fully visible. This may use animation
15341 * to do so and take a period of time
15343 * The item will be positioned at the middle of the genlist viewport.
15345 * @see elm_genlist_item_bring_in()
15346 * @see elm_genlist_item_middle_show()
15350 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15352 * Remove a genlist item from the its parent, deleting it.
15354 * @param item The item to be removed.
15355 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15357 * @see elm_genlist_clear(), to remove all items in a genlist at
15362 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15364 * Return the data associated to a given genlist item
15366 * @param item The genlist item.
15367 * @return the data associated to this item.
15369 * This returns the @c data value passed on the
15370 * elm_genlist_item_append() and related item addition calls.
15372 * @see elm_genlist_item_append()
15373 * @see elm_genlist_item_data_set()
15377 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15379 * Set the data associated to a given genlist item
15381 * @param item The genlist item
15382 * @param data The new data pointer to set on it
15384 * This @b overrides the @c data value passed on the
15385 * elm_genlist_item_append() and related item addition calls. This
15386 * function @b won't call elm_genlist_item_update() automatically,
15387 * so you'd issue it afterwards if you want to hove the item
15388 * updated to reflect the that new data.
15390 * @see elm_genlist_item_data_get()
15394 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15396 * Tells genlist to "orphan" icons fetchs by the item class
15398 * @param it The item
15400 * This instructs genlist to release references to icons in the item,
15401 * meaning that they will no longer be managed by genlist and are
15402 * floating "orphans" that can be re-used elsewhere if the user wants
15407 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15409 * Get the real Evas object created to implement the view of a
15410 * given genlist item
15412 * @param item The genlist item.
15413 * @return the Evas object implementing this item's view.
15415 * This returns the actual Evas object used to implement the
15416 * specified genlist item's view. This may be @c NULL, as it may
15417 * not have been created or may have been deleted, at any time, by
15418 * the genlist. <b>Do not modify this object</b> (move, resize,
15419 * show, hide, etc.), as the genlist is controlling it. This
15420 * function is for querying, emitting custom signals or hooking
15421 * lower level callbacks for events on that object. Do not delete
15422 * this object under any circumstances.
15424 * @see elm_genlist_item_data_get()
15428 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15430 * Update the contents of an item
15432 * @param it The item
15434 * This updates an item by calling all the item class functions again
15435 * to get the icons, labels and states. Use this when the original
15436 * item data has changed and the changes are desired to be reflected.
15438 * Use elm_genlist_realized_items_update() to update all already realized
15441 * @see elm_genlist_realized_items_update()
15445 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15447 * Update the item class of an item
15449 * @param it The item
15450 * @param itc The item class for the item
15452 * This sets another class fo the item, changing the way that it is
15453 * displayed. After changing the item class, elm_genlist_item_update() is
15454 * called on the item @p it.
15458 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15459 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15461 * Set the text to be shown in a given genlist item's tooltips.
15463 * @param item The genlist item
15464 * @param text The text to set in the content
15466 * This call will setup the text to be used as tooltip to that item
15467 * (analogous to elm_object_tooltip_text_set(), but being item
15468 * tooltips with higher precedence than object tooltips). It can
15469 * have only one tooltip at a time, so any previous tooltip data
15470 * will get removed.
15472 * In order to set an icon or something else as a tooltip, look at
15473 * elm_genlist_item_tooltip_content_cb_set().
15477 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15479 * Set the content to be shown in a given genlist item's tooltips
15481 * @param item The genlist item.
15482 * @param func The function returning the tooltip contents.
15483 * @param data What to provide to @a func as callback data/context.
15484 * @param del_cb Called when data is not needed anymore, either when
15485 * another callback replaces @p func, the tooltip is unset with
15486 * elm_genlist_item_tooltip_unset() or the owner @p item
15487 * dies. This callback receives as its first parameter the
15488 * given @p data, being @c event_info the item handle.
15490 * This call will setup the tooltip's contents to @p item
15491 * (analogous to elm_object_tooltip_content_cb_set(), but being
15492 * item tooltips with higher precedence than object tooltips). It
15493 * can have only one tooltip at a time, so any previous tooltip
15494 * content will get removed. @p func (with @p data) will be called
15495 * every time Elementary needs to show the tooltip and it should
15496 * return a valid Evas object, which will be fully managed by the
15497 * tooltip system, getting deleted when the tooltip is gone.
15499 * In order to set just a text as a tooltip, look at
15500 * elm_genlist_item_tooltip_text_set().
15504 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);
15506 * Unset a tooltip from a given genlist item
15508 * @param item genlist item to remove a previously set tooltip from.
15510 * This call removes any tooltip set on @p item. The callback
15511 * provided as @c del_cb to
15512 * elm_genlist_item_tooltip_content_cb_set() will be called to
15513 * notify it is not used anymore (and have resources cleaned, if
15516 * @see elm_genlist_item_tooltip_content_cb_set()
15520 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15522 * Set a different @b style for a given genlist item's tooltip.
15524 * @param item genlist item with tooltip set
15525 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15526 * "default", @c "transparent", etc)
15528 * Tooltips can have <b>alternate styles</b> to be displayed on,
15529 * which are defined by the theme set on Elementary. This function
15530 * works analogously as elm_object_tooltip_style_set(), but here
15531 * applied only to genlist item objects. The default style for
15532 * tooltips is @c "default".
15534 * @note before you set a style you should define a tooltip with
15535 * elm_genlist_item_tooltip_content_cb_set() or
15536 * elm_genlist_item_tooltip_text_set()
15538 * @see elm_genlist_item_tooltip_style_get()
15542 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15544 * Get the style set a given genlist item's tooltip.
15546 * @param item genlist item with tooltip already set on.
15547 * @return style the theme style in use, which defaults to
15548 * "default". If the object does not have a tooltip set,
15549 * then @c NULL is returned.
15551 * @see elm_genlist_item_tooltip_style_set() for more details
15555 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15557 * @brief Disable size restrictions on an object's tooltip
15558 * @param item The tooltip's anchor object
15559 * @param disable If EINA_TRUE, size restrictions are disabled
15560 * @return EINA_FALSE on failure, EINA_TRUE on success
15562 * This function allows a tooltip to expand beyond its parant window's canvas.
15563 * It will instead be limited only by the size of the display.
15565 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15567 * @brief Retrieve size restriction state of an object's tooltip
15568 * @param item The tooltip's anchor object
15569 * @return If EINA_TRUE, size restrictions are disabled
15571 * This function returns whether a tooltip is allowed to expand beyond
15572 * its parant window's canvas.
15573 * It will instead be limited only by the size of the display.
15575 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15577 * Set the type of mouse pointer/cursor decoration to be shown,
15578 * when the mouse pointer is over the given genlist widget item
15580 * @param item genlist item to customize cursor on
15581 * @param cursor the cursor type's name
15583 * This function works analogously as elm_object_cursor_set(), but
15584 * here the cursor's changing area is restricted to the item's
15585 * area, and not the whole widget's. Note that that item cursors
15586 * have precedence over widget cursors, so that a mouse over @p
15587 * item will always show cursor @p type.
15589 * If this function is called twice for an object, a previously set
15590 * cursor will be unset on the second call.
15592 * @see elm_object_cursor_set()
15593 * @see elm_genlist_item_cursor_get()
15594 * @see elm_genlist_item_cursor_unset()
15598 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15600 * Get the type of mouse pointer/cursor decoration set to be shown,
15601 * when the mouse pointer is over the given genlist widget item
15603 * @param item genlist item with custom cursor set
15604 * @return the cursor type's name or @c NULL, if no custom cursors
15605 * were set to @p item (and on errors)
15607 * @see elm_object_cursor_get()
15608 * @see elm_genlist_item_cursor_set() for more details
15609 * @see elm_genlist_item_cursor_unset()
15613 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15615 * Unset any custom mouse pointer/cursor decoration set to be
15616 * shown, when the mouse pointer is over the given genlist widget
15617 * item, thus making it show the @b default cursor again.
15619 * @param item a genlist item
15621 * Use this call to undo any custom settings on this item's cursor
15622 * decoration, bringing it back to defaults (no custom style set).
15624 * @see elm_object_cursor_unset()
15625 * @see elm_genlist_item_cursor_set() for more details
15629 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15631 * Set a different @b style for a given custom cursor set for a
15634 * @param item genlist item with custom cursor set
15635 * @param style the <b>theme style</b> to use (e.g. @c "default",
15636 * @c "transparent", etc)
15638 * This function only makes sense when one is using custom mouse
15639 * cursor decorations <b>defined in a theme file</b> , which can
15640 * have, given a cursor name/type, <b>alternate styles</b> on
15641 * it. It works analogously as elm_object_cursor_style_set(), but
15642 * here applied only to genlist item objects.
15644 * @warning Before you set a cursor style you should have defined a
15645 * custom cursor previously on the item, with
15646 * elm_genlist_item_cursor_set()
15648 * @see elm_genlist_item_cursor_engine_only_set()
15649 * @see elm_genlist_item_cursor_style_get()
15653 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15655 * Get the current @b style set for a given genlist item's custom
15658 * @param item genlist item with custom cursor set.
15659 * @return style the cursor style in use. If the object does not
15660 * have a cursor set, then @c NULL is returned.
15662 * @see elm_genlist_item_cursor_style_set() for more details
15666 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15668 * Set if the (custom) cursor for a given genlist item should be
15669 * searched in its theme, also, or should only rely on the
15670 * rendering engine.
15672 * @param item item with custom (custom) cursor already set on
15673 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15674 * only on those provided by the rendering engine, @c EINA_FALSE to
15675 * have them searched on the widget's theme, as well.
15677 * @note This call is of use only if you've set a custom cursor
15678 * for genlist items, with elm_genlist_item_cursor_set().
15680 * @note By default, cursors will only be looked for between those
15681 * provided by the rendering engine.
15685 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15687 * Get if the (custom) cursor for a given genlist item is being
15688 * searched in its theme, also, or is only relying on the rendering
15691 * @param item a genlist item
15692 * @return @c EINA_TRUE, if cursors are being looked for only on
15693 * those provided by the rendering engine, @c EINA_FALSE if they
15694 * are being searched on the widget's theme, as well.
15696 * @see elm_genlist_item_cursor_engine_only_set(), for more details
15700 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15702 * Update the contents of all realized items.
15704 * @param obj The genlist object.
15706 * This updates all realized items by calling all the item class functions again
15707 * to get the icons, labels and states. Use this when the original
15708 * item data has changed and the changes are desired to be reflected.
15710 * To update just one item, use elm_genlist_item_update().
15712 * @see elm_genlist_realized_items_get()
15713 * @see elm_genlist_item_update()
15717 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15718 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
15719 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15720 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15721 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
15722 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15729 * @defgroup Check Check
15731 * @image html img/widget/check/preview-00.png
15732 * @image latex img/widget/check/preview-00.eps
15733 * @image html img/widget/check/preview-01.png
15734 * @image latex img/widget/check/preview-01.eps
15735 * @image html img/widget/check/preview-02.png
15736 * @image latex img/widget/check/preview-02.eps
15738 * @brief The check widget allows for toggling a value between true and
15741 * Check objects are a lot like radio objects in layout and functionality
15742 * except they do not work as a group, but independently and only toggle the
15743 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
15744 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
15745 * returns the current state. For convenience, like the radio objects, you
15746 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
15747 * for it to modify.
15749 * Signals that you can add callbacks for are:
15750 * "changed" - This is called whenever the user changes the state of one of
15751 * the check object(event_info is NULL).
15753 * @ref tutorial_check should give you a firm grasp of how to use this widget.
15757 * @brief Add a new Check object
15759 * @param parent The parent object
15760 * @return The new object or NULL if it cannot be created
15762 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15764 * @brief Set the text label of the check object
15766 * @param obj The check object
15767 * @param label The text label string in UTF-8
15769 * @deprecated use elm_object_text_set() instead.
15771 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15773 * @brief Get the text label of the check object
15775 * @param obj The check object
15776 * @return The text label string in UTF-8
15778 * @deprecated use elm_object_text_get() instead.
15780 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15782 * @brief Set the icon object of the check object
15784 * @param obj The check object
15785 * @param icon The icon object
15787 * Once the icon object is set, a previously set one will be deleted.
15788 * If you want to keep that old content object, use the
15789 * elm_check_icon_unset() function.
15791 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15793 * @brief Get the icon object of the check object
15795 * @param obj The check object
15796 * @return The icon object
15798 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15800 * @brief Unset the icon used for the check object
15802 * @param obj The check object
15803 * @return The icon object that was being used
15805 * Unparent and return the icon object which was set for this widget.
15807 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15809 * @brief Set the on/off state of the check object
15811 * @param obj The check object
15812 * @param state The state to use (1 == on, 0 == off)
15814 * This sets the state of the check. If set
15815 * with elm_check_state_pointer_set() the state of that variable is also
15816 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
15818 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
15820 * @brief Get the state of the check object
15822 * @param obj The check object
15823 * @return The boolean state
15825 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15827 * @brief Set a convenience pointer to a boolean to change
15829 * @param obj The check object
15830 * @param statep Pointer to the boolean to modify
15832 * This sets a pointer to a boolean, that, in addition to the check objects
15833 * state will also be modified directly. To stop setting the object pointed
15834 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
15835 * then when this is called, the check objects state will also be modified to
15836 * reflect the value of the boolean @p statep points to, just like calling
15837 * elm_check_state_set().
15839 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
15845 * @defgroup Radio Radio
15847 * @image html img/widget/radio/preview-00.png
15848 * @image latex img/widget/radio/preview-00.eps
15850 * @brief Radio is a widget that allows for 1 or more options to be displayed
15851 * and have the user choose only 1 of them.
15853 * A radio object contains an indicator, an optional Label and an optional
15854 * icon object. While it's possible to have a group of only one radio they,
15855 * are normally used in groups of 2 or more. To add a radio to a group use
15856 * elm_radio_group_add(). The radio object(s) will select from one of a set
15857 * of integer values, so any value they are configuring needs to be mapped to
15858 * a set of integers. To configure what value that radio object represents,
15859 * use elm_radio_state_value_set() to set the integer it represents. To set
15860 * the value the whole group(which one is currently selected) is to indicate
15861 * use elm_radio_value_set() on any group member, and to get the groups value
15862 * use elm_radio_value_get(). For convenience the radio objects are also able
15863 * to directly set an integer(int) to the value that is selected. To specify
15864 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
15865 * The radio objects will modify this directly. That implies the pointer must
15866 * point to valid memory for as long as the radio objects exist.
15868 * Signals that you can add callbacks for are:
15869 * @li changed - This is called whenever the user changes the state of one of
15870 * the radio objects within the group of radio objects that work together.
15872 * @ref tutorial_radio show most of this API in action.
15876 * @brief Add a new radio to the parent
15878 * @param parent The parent object
15879 * @return The new object or NULL if it cannot be created
15881 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15883 * @brief Set the text label of the radio object
15885 * @param obj The radio object
15886 * @param label The text label string in UTF-8
15888 * @deprecated use elm_object_text_set() instead.
15890 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15892 * @brief Get the text label of the radio object
15894 * @param obj The radio object
15895 * @return The text label string in UTF-8
15897 * @deprecated use elm_object_text_set() instead.
15899 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15901 * @brief Set the icon object of the radio object
15903 * @param obj The radio object
15904 * @param icon The icon object
15906 * Once the icon object is set, a previously set one will be deleted. If you
15907 * want to keep that old content object, use the elm_radio_icon_unset()
15910 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15912 * @brief Get the icon object of the radio object
15914 * @param obj The radio object
15915 * @return The icon object
15917 * @see elm_radio_icon_set()
15919 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15921 * @brief Unset the icon used for the radio object
15923 * @param obj The radio object
15924 * @return The icon object that was being used
15926 * Unparent and return the icon object which was set for this widget.
15928 * @see elm_radio_icon_set()
15930 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15932 * @brief Add this radio to a group of other radio objects
15934 * @param obj The radio object
15935 * @param group Any object whose group the @p obj is to join.
15937 * Radio objects work in groups. Each member should have a different integer
15938 * value assigned. In order to have them work as a group, they need to know
15939 * about each other. This adds the given radio object to the group of which
15940 * the group object indicated is a member.
15942 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
15944 * @brief Set the integer value that this radio object represents
15946 * @param obj The radio object
15947 * @param value The value to use if this radio object is selected
15949 * This sets the value of the radio.
15951 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
15953 * @brief Get the integer value that this radio object represents
15955 * @param obj The radio object
15956 * @return The value used if this radio object is selected
15958 * This gets the value of the radio.
15960 * @see elm_radio_value_set()
15962 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15964 * @brief Set the value of the radio.
15966 * @param obj The radio object
15967 * @param value The value to use for the group
15969 * This sets the value of the radio group and will also set the value if
15970 * pointed to, to the value supplied, but will not call any callbacks.
15972 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
15974 * @brief Get the state of the radio object
15976 * @param obj The radio object
15977 * @return The integer state
15979 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15981 * @brief Set a convenience pointer to a integer to change
15983 * @param obj The radio object
15984 * @param valuep Pointer to the integer to modify
15986 * This sets a pointer to a integer, that, in addition to the radio objects
15987 * state will also be modified directly. To stop setting the object pointed
15988 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
15989 * when this is called, the radio objects state will also be modified to
15990 * reflect the value of the integer valuep points to, just like calling
15991 * elm_radio_value_set().
15993 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
15999 * @defgroup Pager Pager
16001 * @image html img/widget/pager/preview-00.png
16002 * @image latex img/widget/pager/preview-00.eps
16004 * @brief Widget that allows flipping between 1 or more “pages” of objects.
16006 * The flipping between “pages” of objects is animated. All content in pager
16007 * is kept in a stack, the last content to be added will be on the top of the
16008 * stack(be visible).
16010 * Objects can be pushed or popped from the stack or deleted as normal.
16011 * Pushes and pops will animate (and a pop will delete the object once the
16012 * animation is finished). Any object already in the pager can be promoted to
16013 * the top(from its current stacking position) through the use of
16014 * elm_pager_content_promote(). Objects are pushed to the top with
16015 * elm_pager_content_push() and when the top item is no longer wanted, simply
16016 * pop it with elm_pager_content_pop() and it will also be deleted. If an
16017 * object is no longer needed and is not the top item, just delete it as
16018 * normal. You can query which objects are the top and bottom with
16019 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16021 * Signals that you can add callbacks for are:
16022 * "hide,finished" - when the previous page is hided
16024 * This widget has the following styles available:
16027 * @li fade_translucide
16028 * @li fade_invisible
16029 * @note This styles affect only the flipping animations, the appearance when
16030 * not animating is unaffected by styles.
16032 * @ref tutorial_pager gives a good overview of the usage of the API.
16036 * Add a new pager to the parent
16038 * @param parent The parent object
16039 * @return The new object or NULL if it cannot be created
16043 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16045 * @brief Push an object to the top of the pager stack (and show it).
16047 * @param obj The pager object
16048 * @param content The object to push
16050 * The object pushed becomes a child of the pager, it will be controlled and
16051 * deleted when the pager is deleted.
16053 * @note If the content is already in the stack use
16054 * elm_pager_content_promote().
16055 * @warning Using this function on @p content already in the stack results in
16056 * undefined behavior.
16058 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16060 * @brief Pop the object that is on top of the stack
16062 * @param obj The pager object
16064 * This pops the object that is on the top(visible) of the pager, makes it
16065 * disappear, then deletes the object. The object that was underneath it on
16066 * the stack will become visible.
16068 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16070 * @brief Moves an object already in the pager stack to the top of the stack.
16072 * @param obj The pager object
16073 * @param content The object to promote
16075 * This will take the @p content and move it to the top of the stack as
16076 * if it had been pushed there.
16078 * @note If the content isn't already in the stack use
16079 * elm_pager_content_push().
16080 * @warning Using this function on @p content not already in the stack
16081 * results in undefined behavior.
16083 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16085 * @brief Return the object at the bottom of the pager stack
16087 * @param obj The pager object
16088 * @return The bottom object or NULL if none
16090 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16092 * @brief Return the object at the top of the pager stack
16094 * @param obj The pager object
16095 * @return The top object or NULL if none
16097 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16103 * @defgroup Slideshow Slideshow
16105 * @image html img/widget/slideshow/preview-00.png
16106 * @image latex img/widget/slideshow/preview-00.eps
16108 * This widget, as the name indicates, is a pre-made image
16109 * slideshow panel, with API functions acting on (child) image
16110 * items presentation. Between those actions, are:
16111 * - advance to next/previous image
16112 * - select the style of image transition animation
16113 * - set the exhibition time for each image
16114 * - start/stop the slideshow
16116 * The transition animations are defined in the widget's theme,
16117 * consequently new animations can be added without having to
16118 * update the widget's code.
16120 * @section Slideshow_Items Slideshow items
16122 * For slideshow items, just like for @ref Genlist "genlist" ones,
16123 * the user defines a @b classes, specifying functions that will be
16124 * called on the item's creation and deletion times.
16126 * The #Elm_Slideshow_Item_Class structure contains the following
16129 * - @c func.get - When an item is displayed, this function is
16130 * called, and it's where one should create the item object, de
16131 * facto. For example, the object can be a pure Evas image object
16132 * or an Elementary @ref Photocam "photocam" widget. See
16133 * #SlideshowItemGetFunc.
16134 * - @c func.del - When an item is no more displayed, this function
16135 * is called, where the user must delete any data associated to
16136 * the item. See #SlideshowItemDelFunc.
16138 * @section Slideshow_Caching Slideshow caching
16140 * The slideshow provides facilities to have items adjacent to the
16141 * one being displayed <b>already "realized"</b> (i.e. loaded) for
16142 * you, so that the system does not have to decode image data
16143 * anymore at the time it has to actually switch images on its
16144 * viewport. The user is able to set the numbers of items to be
16145 * cached @b before and @b after the current item, in the widget's
16148 * Smart events one can add callbacks for are:
16150 * - @c "changed" - when the slideshow switches its view to a new
16153 * List of examples for the slideshow widget:
16154 * @li @ref slideshow_example
16158 * @addtogroup Slideshow
16162 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16163 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16164 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
16165 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16166 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16169 * @struct _Elm_Slideshow_Item_Class
16171 * Slideshow item class definition. See @ref Slideshow_Items for
16174 struct _Elm_Slideshow_Item_Class
16176 struct _Elm_Slideshow_Item_Class_Func
16178 SlideshowItemGetFunc get;
16179 SlideshowItemDelFunc del;
16181 }; /**< #Elm_Slideshow_Item_Class member definitions */
16184 * Add a new slideshow widget to the given parent Elementary
16185 * (container) object
16187 * @param parent The parent object
16188 * @return A new slideshow widget handle or @c NULL, on errors
16190 * This function inserts a new slideshow widget on the canvas.
16192 * @ingroup Slideshow
16194 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16197 * Add (append) a new item in a given slideshow widget.
16199 * @param obj The slideshow object
16200 * @param itc The item class for the item
16201 * @param data The item's data
16202 * @return A handle to the item added or @c NULL, on errors
16204 * Add a new item to @p obj's internal list of items, appending it.
16205 * The item's class must contain the function really fetching the
16206 * image object to show for this item, which could be an Evas image
16207 * object or an Elementary photo, for example. The @p data
16208 * parameter is going to be passed to both class functions of the
16211 * @see #Elm_Slideshow_Item_Class
16212 * @see elm_slideshow_item_sorted_insert()
16214 * @ingroup Slideshow
16216 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16219 * Insert a new item into the given slideshow widget, using the @p func
16220 * function to sort items (by item handles).
16222 * @param obj The slideshow object
16223 * @param itc The item class for the item
16224 * @param data The item's data
16225 * @param func The comparing function to be used to sort slideshow
16226 * items <b>by #Elm_Slideshow_Item item handles</b>
16227 * @return Returns The slideshow item handle, on success, or
16228 * @c NULL, on errors
16230 * Add a new item to @p obj's internal list of items, in a position
16231 * determined by the @p func comparing function. The item's class
16232 * must contain the function really fetching the image object to
16233 * show for this item, which could be an Evas image object or an
16234 * Elementary photo, for example. The @p data parameter is going to
16235 * be passed to both class functions of the item.
16237 * @see #Elm_Slideshow_Item_Class
16238 * @see elm_slideshow_item_add()
16240 * @ingroup Slideshow
16242 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);
16245 * Display a given slideshow widget's item, programmatically.
16247 * @param obj The slideshow object
16248 * @param item The item to display on @p obj's viewport
16250 * The change between the current item and @p item will use the
16251 * transition @p obj is set to use (@see
16252 * elm_slideshow_transition_set()).
16254 * @ingroup Slideshow
16256 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16259 * Slide to the @b next item, in a given slideshow widget
16261 * @param obj The slideshow object
16263 * The sliding animation @p obj is set to use will be the
16264 * transition effect used, after this call is issued.
16266 * @note If the end of the slideshow's internal list of items is
16267 * reached, it'll wrap around to the list's beginning, again.
16269 * @ingroup Slideshow
16271 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16274 * Slide to the @b previous item, in a given slideshow widget
16276 * @param obj The slideshow object
16278 * The sliding animation @p obj is set to use will be the
16279 * transition effect used, after this call is issued.
16281 * @note If the beginning of the slideshow's internal list of items
16282 * is reached, it'll wrap around to the list's end, again.
16284 * @ingroup Slideshow
16286 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16289 * Returns the list of sliding transition/effect names available, for a
16290 * given slideshow widget.
16292 * @param obj The slideshow object
16293 * @return The list of transitions (list of @b stringshared strings
16296 * The transitions, which come from @p obj's theme, must be an EDC
16297 * data item named @c "transitions" on the theme file, with (prefix)
16298 * names of EDC programs actually implementing them.
16300 * The available transitions for slideshows on the default theme are:
16301 * - @c "fade" - the current item fades out, while the new one
16302 * fades in to the slideshow's viewport.
16303 * - @c "black_fade" - the current item fades to black, and just
16304 * then, the new item will fade in.
16305 * - @c "horizontal" - the current item slides horizontally, until
16306 * it gets out of the slideshow's viewport, while the new item
16307 * comes from the left to take its place.
16308 * - @c "vertical" - the current item slides vertically, until it
16309 * gets out of the slideshow's viewport, while the new item comes
16310 * from the bottom to take its place.
16311 * - @c "square" - the new item starts to appear from the middle of
16312 * the current one, but with a tiny size, growing until its
16313 * target (full) size and covering the old one.
16315 * @warning The stringshared strings get no new references
16316 * exclusive to the user grabbing the list, here, so if you'd like
16317 * to use them out of this call's context, you'd better @c
16318 * eina_stringshare_ref() them.
16320 * @see elm_slideshow_transition_set()
16322 * @ingroup Slideshow
16324 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16327 * Set the current slide transition/effect in use for a given
16330 * @param obj The slideshow object
16331 * @param transition The new transition's name string
16333 * If @p transition is implemented in @p obj's theme (i.e., is
16334 * contained in the list returned by
16335 * elm_slideshow_transitions_get()), this new sliding effect will
16336 * be used on the widget.
16338 * @see elm_slideshow_transitions_get() for more details
16340 * @ingroup Slideshow
16342 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16345 * Get the current slide transition/effect in use for a given
16348 * @param obj The slideshow object
16349 * @return The current transition's name
16351 * @see elm_slideshow_transition_set() for more details
16353 * @ingroup Slideshow
16355 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16358 * Set the interval between each image transition on a given
16359 * slideshow widget, <b>and start the slideshow, itself</b>
16361 * @param obj The slideshow object
16362 * @param timeout The new displaying timeout for images
16364 * After this call, the slideshow widget will start cycling its
16365 * view, sequentially and automatically, with the images of the
16366 * items it has. The time between each new image displayed is going
16367 * to be @p timeout, in @b seconds. If a different timeout was set
16368 * previously and an slideshow was in progress, it will continue
16369 * with the new time between transitions, after this call.
16371 * @note A value less than or equal to 0 on @p timeout will disable
16372 * the widget's internal timer, thus halting any slideshow which
16373 * could be happening on @p obj.
16375 * @see elm_slideshow_timeout_get()
16377 * @ingroup Slideshow
16379 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16382 * Get the interval set for image transitions on a given slideshow
16385 * @param obj The slideshow object
16386 * @return Returns the timeout set on it
16388 * @see elm_slideshow_timeout_set() for more details
16390 * @ingroup Slideshow
16392 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16395 * Set if, after a slideshow is started, for a given slideshow
16396 * widget, its items should be displayed cyclically or not.
16398 * @param obj The slideshow object
16399 * @param loop Use @c EINA_TRUE to make it cycle through items or
16400 * @c EINA_FALSE for it to stop at the end of @p obj's internal
16403 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16404 * ignore what is set by this functions, i.e., they'll @b always
16405 * cycle through items. This affects only the "automatic"
16406 * slideshow, as set by elm_slideshow_timeout_set().
16408 * @see elm_slideshow_loop_get()
16410 * @ingroup Slideshow
16412 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16415 * Get if, after a slideshow is started, for a given slideshow
16416 * widget, its items are to be displayed cyclically or not.
16418 * @param obj The slideshow object
16419 * @return @c EINA_TRUE, if the items in @p obj will be cycled
16420 * through or @c EINA_FALSE, otherwise
16422 * @see elm_slideshow_loop_set() for more details
16424 * @ingroup Slideshow
16426 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16429 * Remove all items from a given slideshow widget
16431 * @param obj The slideshow object
16433 * This removes (and deletes) all items in @p obj, leaving it
16436 * @see elm_slideshow_item_del(), to remove just one item.
16438 * @ingroup Slideshow
16440 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16443 * Get the internal list of items in a given slideshow widget.
16445 * @param obj The slideshow object
16446 * @return The list of items (#Elm_Slideshow_Item as data) or
16447 * @c NULL on errors.
16449 * This list is @b not to be modified in any way and must not be
16450 * freed. Use the list members with functions like
16451 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16453 * @warning This list is only valid until @p obj object's internal
16454 * items list is changed. It should be fetched again with another
16455 * call to this function when changes happen.
16457 * @ingroup Slideshow
16459 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16462 * Delete a given item from a slideshow widget.
16464 * @param item The slideshow item
16466 * @ingroup Slideshow
16468 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16471 * Return the data associated with a given slideshow item
16473 * @param item The slideshow item
16474 * @return Returns the data associated to this item
16476 * @ingroup Slideshow
16478 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16481 * Returns the currently displayed item, in a given slideshow widget
16483 * @param obj The slideshow object
16484 * @return A handle to the item being displayed in @p obj or
16485 * @c NULL, if none is (and on errors)
16487 * @ingroup Slideshow
16489 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16492 * Get the real Evas object created to implement the view of a
16493 * given slideshow item
16495 * @param item The slideshow item.
16496 * @return the Evas object implementing this item's view.
16498 * This returns the actual Evas object used to implement the
16499 * specified slideshow item's view. This may be @c NULL, as it may
16500 * not have been created or may have been deleted, at any time, by
16501 * the slideshow. <b>Do not modify this object</b> (move, resize,
16502 * show, hide, etc.), as the slideshow is controlling it. This
16503 * function is for querying, emitting custom signals or hooking
16504 * lower level callbacks for events on that object. Do not delete
16505 * this object under any circumstances.
16507 * @see elm_slideshow_item_data_get()
16509 * @ingroup Slideshow
16511 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16514 * Get the the item, in a given slideshow widget, placed at
16515 * position @p nth, in its internal items list
16517 * @param obj The slideshow object
16518 * @param nth The number of the item to grab a handle to (0 being
16520 * @return The item stored in @p obj at position @p nth or @c NULL,
16521 * if there's no item with that index (and on errors)
16523 * @ingroup Slideshow
16525 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16528 * Set the current slide layout in use for a given slideshow widget
16530 * @param obj The slideshow object
16531 * @param layout The new layout's name string
16533 * If @p layout is implemented in @p obj's theme (i.e., is contained
16534 * in the list returned by elm_slideshow_layouts_get()), this new
16535 * images layout will be used on the widget.
16537 * @see elm_slideshow_layouts_get() for more details
16539 * @ingroup Slideshow
16541 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16544 * Get the current slide layout in use for a given slideshow widget
16546 * @param obj The slideshow object
16547 * @return The current layout's name
16549 * @see elm_slideshow_layout_set() for more details
16551 * @ingroup Slideshow
16553 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16556 * Returns the list of @b layout names available, for a given
16557 * slideshow widget.
16559 * @param obj The slideshow object
16560 * @return The list of layouts (list of @b stringshared strings
16563 * Slideshow layouts will change how the widget is to dispose each
16564 * image item in its viewport, with regard to cropping, scaling,
16567 * The layouts, which come from @p obj's theme, must be an EDC
16568 * data item name @c "layouts" on the theme file, with (prefix)
16569 * names of EDC programs actually implementing them.
16571 * The available layouts for slideshows on the default theme are:
16572 * - @c "fullscreen" - item images with original aspect, scaled to
16573 * touch top and down slideshow borders or, if the image's heigh
16574 * is not enough, left and right slideshow borders.
16575 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16576 * one, but always leaving 10% of the slideshow's dimensions of
16577 * distance between the item image's borders and the slideshow
16578 * borders, for each axis.
16580 * @warning The stringshared strings get no new references
16581 * exclusive to the user grabbing the list, here, so if you'd like
16582 * to use them out of this call's context, you'd better @c
16583 * eina_stringshare_ref() them.
16585 * @see elm_slideshow_layout_set()
16587 * @ingroup Slideshow
16589 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16592 * Set the number of items to cache, on a given slideshow widget,
16593 * <b>before the current item</b>
16595 * @param obj The slideshow object
16596 * @param count Number of items to cache before the current one
16598 * The default value for this property is @c 2. See
16599 * @ref Slideshow_Caching "slideshow caching" for more details.
16601 * @see elm_slideshow_cache_before_get()
16603 * @ingroup Slideshow
16605 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16608 * Retrieve the number of items to cache, on a given slideshow widget,
16609 * <b>before the current item</b>
16611 * @param obj The slideshow object
16612 * @return The number of items set to be cached before the current one
16614 * @see elm_slideshow_cache_before_set() for more details
16616 * @ingroup Slideshow
16618 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16621 * Set the number of items to cache, on a given slideshow widget,
16622 * <b>after the current item</b>
16624 * @param obj The slideshow object
16625 * @param count Number of items to cache after the current one
16627 * The default value for this property is @c 2. See
16628 * @ref Slideshow_Caching "slideshow caching" for more details.
16630 * @see elm_slideshow_cache_after_get()
16632 * @ingroup Slideshow
16634 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16637 * Retrieve the number of items to cache, on a given slideshow widget,
16638 * <b>after the current item</b>
16640 * @param obj The slideshow object
16641 * @return The number of items set to be cached after the current one
16643 * @see elm_slideshow_cache_after_set() for more details
16645 * @ingroup Slideshow
16647 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16650 * Get the number of items stored in a given slideshow widget
16652 * @param obj The slideshow object
16653 * @return The number of items on @p obj, at the moment of this call
16655 * @ingroup Slideshow
16657 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16664 * @defgroup Fileselector File Selector
16666 * @image html img/widget/fileselector/preview-00.png
16667 * @image latex img/widget/fileselector/preview-00.eps
16669 * A file selector is a widget that allows a user to navigate
16670 * through a file system, reporting file selections back via its
16673 * It contains shortcut buttons for home directory (@c ~) and to
16674 * jump one directory upwards (..), as well as cancel/ok buttons to
16675 * confirm/cancel a given selection. After either one of those two
16676 * former actions, the file selector will issue its @c "done" smart
16679 * There's a text entry on it, too, showing the name of the current
16680 * selection. There's the possibility of making it editable, so it
16681 * is useful on file saving dialogs on applications, where one
16682 * gives a file name to save contents to, in a given directory in
16683 * the system. This custom file name will be reported on the @c
16684 * "done" smart callback (explained in sequence).
16686 * Finally, it has a view to display file system items into in two
16691 * If Elementary is built with support of the Ethumb thumbnailing
16692 * library, the second form of view will display preview thumbnails
16693 * of files which it supports.
16695 * Smart callbacks one can register to:
16697 * - @c "selected" - the user has clicked on a file (when not in
16698 * folders-only mode) or directory (when in folders-only mode)
16699 * - @c "directory,open" - the list has been populated with new
16700 * content (@c event_info is a pointer to the directory's
16701 * path, a @b stringshared string)
16702 * - @c "done" - the user has clicked on the "ok" or "cancel"
16703 * buttons (@c event_info is a pointer to the selection's
16704 * path, a @b stringshared string)
16706 * Here is an example on its usage:
16707 * @li @ref fileselector_example
16711 * @addtogroup Fileselector
16716 * Defines how a file selector widget is to layout its contents
16717 * (file system entries).
16719 typedef enum _Elm_Fileselector_Mode
16721 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
16722 ELM_FILESELECTOR_GRID, /**< layout as a grid */
16723 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
16724 } Elm_Fileselector_Mode;
16727 * Add a new file selector widget to the given parent Elementary
16728 * (container) object
16730 * @param parent The parent object
16731 * @return a new file selector widget handle or @c NULL, on errors
16733 * This function inserts a new file selector widget on the canvas.
16735 * @ingroup Fileselector
16737 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16740 * Enable/disable the file name entry box where the user can type
16741 * in a name for a file, in a given file selector widget
16743 * @param obj The file selector object
16744 * @param is_save @c EINA_TRUE to make the file selector a "saving
16745 * dialog", @c EINA_FALSE otherwise
16747 * Having the entry editable is useful on file saving dialogs on
16748 * applications, where one gives a file name to save contents to,
16749 * in a given directory in the system. This custom file name will
16750 * be reported on the @c "done" smart callback.
16752 * @see elm_fileselector_is_save_get()
16754 * @ingroup Fileselector
16756 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
16759 * Get whether the given file selector is in "saving dialog" mode
16761 * @param obj The file selector object
16762 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
16763 * mode, @c EINA_FALSE otherwise (and on errors)
16765 * @see elm_fileselector_is_save_set() for more details
16767 * @ingroup Fileselector
16769 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16772 * Enable/disable folder-only view for a given file selector widget
16774 * @param obj The file selector object
16775 * @param only @c EINA_TRUE to make @p obj only display
16776 * directories, @c EINA_FALSE to make files to be displayed in it
16779 * If enabled, the widget's view will only display folder items,
16782 * @see elm_fileselector_folder_only_get()
16784 * @ingroup Fileselector
16786 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
16789 * Get whether folder-only view is set for a given file selector
16792 * @param obj The file selector object
16793 * @return only @c EINA_TRUE if @p obj is only displaying
16794 * directories, @c EINA_FALSE if files are being displayed in it
16795 * too (and on errors)
16797 * @see elm_fileselector_folder_only_get()
16799 * @ingroup Fileselector
16801 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16804 * Enable/disable the "ok" and "cancel" buttons on a given file
16807 * @param obj The file selector object
16808 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
16810 * @note A file selector without those buttons will never emit the
16811 * @c "done" smart event, and is only usable if one is just hooking
16812 * to the other two events.
16814 * @see elm_fileselector_buttons_ok_cancel_get()
16816 * @ingroup Fileselector
16818 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
16821 * Get whether the "ok" and "cancel" buttons on a given file
16822 * selector widget are being shown.
16824 * @param obj The file selector object
16825 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
16826 * otherwise (and on errors)
16828 * @see elm_fileselector_buttons_ok_cancel_set() for more details
16830 * @ingroup Fileselector
16832 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16835 * Enable/disable a tree view in the given file selector widget,
16836 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
16838 * @param obj The file selector object
16839 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
16842 * In a tree view, arrows are created on the sides of directories,
16843 * allowing them to expand in place.
16845 * @note If it's in other mode, the changes made by this function
16846 * will only be visible when one switches back to "list" mode.
16848 * @see elm_fileselector_expandable_get()
16850 * @ingroup Fileselector
16852 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
16855 * Get whether tree view is enabled for the given file selector
16858 * @param obj The file selector object
16859 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
16860 * otherwise (and or errors)
16862 * @see elm_fileselector_expandable_set() for more details
16864 * @ingroup Fileselector
16866 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16869 * Set, programmatically, the @b directory that a given file
16870 * selector widget will display contents from
16872 * @param obj The file selector object
16873 * @param path The path to display in @p obj
16875 * This will change the @b directory that @p obj is displaying. It
16876 * will also clear the text entry area on the @p obj object, which
16877 * displays select files' names.
16879 * @see elm_fileselector_path_get()
16881 * @ingroup Fileselector
16883 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16886 * Get the parent directory's path that a given file selector
16887 * widget is displaying
16889 * @param obj The file selector object
16890 * @return The (full) path of the directory the file selector is
16891 * displaying, a @b stringshared string
16893 * @see elm_fileselector_path_set()
16895 * @ingroup Fileselector
16897 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16900 * Set, programmatically, the currently selected file/directory in
16901 * the given file selector widget
16903 * @param obj The file selector object
16904 * @param path The (full) path to a file or directory
16905 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
16906 * latter case occurs if the directory or file pointed to do not
16909 * @see elm_fileselector_selected_get()
16911 * @ingroup Fileselector
16913 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16916 * Get the currently selected item's (full) path, in the given file
16919 * @param obj The file selector object
16920 * @return The absolute path of the selected item, a @b
16921 * stringshared string
16923 * @note Custom editions on @p obj object's text entry, if made,
16924 * will appear on the return string of this function, naturally.
16926 * @see elm_fileselector_selected_set() for more details
16928 * @ingroup Fileselector
16930 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16933 * Set the mode in which a given file selector widget will display
16934 * (layout) file system entries in its view
16936 * @param obj The file selector object
16937 * @param mode The mode of the fileselector, being it one of
16938 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
16939 * first one, naturally, will display the files in a list. The
16940 * latter will make the widget to display its entries in a grid
16943 * @note By using elm_fileselector_expandable_set(), the user may
16944 * trigger a tree view for that list.
16946 * @note If Elementary is built with support of the Ethumb
16947 * thumbnailing library, the second form of view will display
16948 * preview thumbnails of files which it supports. You must have
16949 * elm_need_ethumb() called in your Elementary for thumbnailing to
16952 * @see elm_fileselector_expandable_set().
16953 * @see elm_fileselector_mode_get().
16955 * @ingroup Fileselector
16957 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
16960 * Get the mode in which a given file selector widget is displaying
16961 * (layouting) file system entries in its view
16963 * @param obj The fileselector object
16964 * @return The mode in which the fileselector is at
16966 * @see elm_fileselector_mode_set() for more details
16968 * @ingroup Fileselector
16970 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16977 * @defgroup Progressbar Progress bar
16979 * The progress bar is a widget for visually representing the
16980 * progress status of a given job/task.
16982 * A progress bar may be horizontal or vertical. It may display an
16983 * icon besides it, as well as primary and @b units labels. The
16984 * former is meant to label the widget as a whole, while the
16985 * latter, which is formatted with floating point values (and thus
16986 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
16987 * units"</c>), is meant to label the widget's <b>progress
16988 * value</b>. Label, icon and unit strings/objects are @b optional
16989 * for progress bars.
16991 * A progress bar may be @b inverted, in which state it gets its
16992 * values inverted, with high values being on the left or top and
16993 * low values on the right or bottom, as opposed to normally have
16994 * the low values on the former and high values on the latter,
16995 * respectively, for horizontal and vertical modes.
16997 * The @b span of the progress, as set by
16998 * elm_progressbar_span_size_set(), is its length (horizontally or
16999 * vertically), unless one puts size hints on the widget to expand
17000 * on desired directions, by any container. That length will be
17001 * scaled by the object or applications scaling factor. At any
17002 * point code can query the progress bar for its value with
17003 * elm_progressbar_value_get().
17005 * Available widget styles for progress bars:
17007 * - @c "wheel" (simple style, no text, no progression, only
17008 * "pulse" effect is available)
17010 * Here is an example on its usage:
17011 * @li @ref progressbar_example
17015 * Add a new progress bar widget to the given parent Elementary
17016 * (container) object
17018 * @param parent The parent object
17019 * @return a new progress bar widget handle or @c NULL, on errors
17021 * This function inserts a new progress bar widget on the canvas.
17023 * @ingroup Progressbar
17025 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17028 * Set whether a given progress bar widget is at "pulsing mode" or
17031 * @param obj The progress bar object
17032 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
17033 * @c EINA_FALSE to put it back to its default one
17035 * By default, progress bars will display values from the low to
17036 * high value boundaries. There are, though, contexts in which the
17037 * state of progression of a given task is @b unknown. For those,
17038 * one can set a progress bar widget to a "pulsing state", to give
17039 * the user an idea that some computation is being held, but
17040 * without exact progress values. In the default theme it will
17041 * animate its bar with the contents filling in constantly and back
17042 * to non-filled, in a loop. To start and stop this pulsing
17043 * animation, one has to explicitly call elm_progressbar_pulse().
17045 * @see elm_progressbar_pulse_get()
17046 * @see elm_progressbar_pulse()
17048 * @ingroup Progressbar
17050 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17053 * Get whether a given progress bar widget is at "pulsing mode" or
17056 * @param obj The progress bar object
17057 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
17058 * if it's in the default one (and on errors)
17060 * @ingroup Progressbar
17062 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17065 * Start/stop a given progress bar "pulsing" animation, if its
17068 * @param obj The progress bar object
17069 * @param state @c EINA_TRUE, to @b start the pulsing animation,
17070 * @c EINA_FALSE to @b stop it
17072 * @note This call won't do anything if @p obj is not under "pulsing mode".
17074 * @see elm_progressbar_pulse_set() for more details.
17076 * @ingroup Progressbar
17078 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17081 * Set the progress value (in percentage) on a given progress bar
17084 * @param obj The progress bar object
17085 * @param val The progress value (@b must be between @c 0.0 and @c
17088 * Use this call to set progress bar levels.
17090 * @note If you passes a value out of the specified range for @p
17091 * val, it will be interpreted as the @b closest of the @b boundary
17092 * values in the range.
17094 * @ingroup Progressbar
17096 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17099 * Get the progress value (in percentage) on a given progress bar
17102 * @param obj The progress bar object
17103 * @return The value of the progressbar
17105 * @see elm_progressbar_value_set() for more details
17107 * @ingroup Progressbar
17109 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17112 * Set the label of a given progress bar widget
17114 * @param obj The progress bar object
17115 * @param label The text label string, in UTF-8
17117 * @ingroup Progressbar
17118 * @deprecated use elm_object_text_set() instead.
17120 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17123 * Get the label of a given progress bar widget
17125 * @param obj The progressbar object
17126 * @return The text label string, in UTF-8
17128 * @ingroup Progressbar
17129 * @deprecated use elm_object_text_set() instead.
17131 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17134 * Set the icon object of a given progress bar widget
17136 * @param obj The progress bar object
17137 * @param icon The icon object
17139 * Use this call to decorate @p obj with an icon next to it.
17141 * @note Once the icon object is set, a previously set one will be
17142 * deleted. If you want to keep that old content object, use the
17143 * elm_progressbar_icon_unset() function.
17145 * @see elm_progressbar_icon_get()
17147 * @ingroup Progressbar
17149 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17152 * Retrieve the icon object set for a given progress bar widget
17154 * @param obj The progress bar object
17155 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17156 * otherwise (and on errors)
17158 * @see elm_progressbar_icon_set() for more details
17160 * @ingroup Progressbar
17162 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17165 * Unset an icon set on a given progress bar widget
17167 * @param obj The progress bar object
17168 * @return The icon object that was being used, if any was set, or
17169 * @c NULL, otherwise (and on errors)
17171 * This call will unparent and return the icon object which was set
17172 * for this widget, previously, on success.
17174 * @see elm_progressbar_icon_set() for more details
17176 * @ingroup Progressbar
17178 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17181 * Set the (exact) length of the bar region of a given progress bar
17184 * @param obj The progress bar object
17185 * @param size The length of the progress bar's bar region
17187 * This sets the minimum width (when in horizontal mode) or height
17188 * (when in vertical mode) of the actual bar area of the progress
17189 * bar @p obj. This in turn affects the object's minimum size. Use
17190 * this when you're not setting other size hints expanding on the
17191 * given direction (like weight and alignment hints) and you would
17192 * like it to have a specific size.
17194 * @note Icon, label and unit text around @p obj will require their
17195 * own space, which will make @p obj to require more the @p size,
17198 * @see elm_progressbar_span_size_get()
17200 * @ingroup Progressbar
17202 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17205 * Get the length set for the bar region of a given progress bar
17208 * @param obj The progress bar object
17209 * @return The length of the progress bar's bar region
17211 * If that size was not set previously, with
17212 * elm_progressbar_span_size_set(), this call will return @c 0.
17214 * @ingroup Progressbar
17216 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17219 * Set the format string for a given progress bar widget's units
17222 * @param obj The progress bar object
17223 * @param format The format string for @p obj's units label
17225 * If @c NULL is passed on @p format, it will make @p obj's units
17226 * area to be hidden completely. If not, it'll set the <b>format
17227 * string</b> for the units label's @b text. The units label is
17228 * provided a floating point value, so the units text is up display
17229 * at most one floating point falue. Note that the units label is
17230 * optional. Use a format string such as "%1.2f meters" for
17233 * @note The default format string for a progress bar is an integer
17234 * percentage, as in @c "%.0f %%".
17236 * @see elm_progressbar_unit_format_get()
17238 * @ingroup Progressbar
17240 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17243 * Retrieve the format string set for a given progress bar widget's
17246 * @param obj The progress bar object
17247 * @return The format set string for @p obj's units label or
17248 * @c NULL, if none was set (and on errors)
17250 * @see elm_progressbar_unit_format_set() for more details
17252 * @ingroup Progressbar
17254 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17257 * Set the orientation of a given progress bar widget
17259 * @param obj The progress bar object
17260 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17261 * @b horizontal, @c EINA_FALSE to make it @b vertical
17263 * Use this function to change how your progress bar is to be
17264 * disposed: vertically or horizontally.
17266 * @see elm_progressbar_horizontal_get()
17268 * @ingroup Progressbar
17270 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17273 * Retrieve the orientation of a given progress bar widget
17275 * @param obj The progress bar object
17276 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17277 * @c EINA_FALSE if it's @b vertical (and on errors)
17279 * @see elm_progressbar_horizontal_set() for more details
17281 * @ingroup Progressbar
17283 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17286 * Invert a given progress bar widget's displaying values order
17288 * @param obj The progress bar object
17289 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17290 * @c EINA_FALSE to bring it back to default, non-inverted values.
17292 * A progress bar may be @b inverted, in which state it gets its
17293 * values inverted, with high values being on the left or top and
17294 * low values on the right or bottom, as opposed to normally have
17295 * the low values on the former and high values on the latter,
17296 * respectively, for horizontal and vertical modes.
17298 * @see elm_progressbar_inverted_get()
17300 * @ingroup Progressbar
17302 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17305 * Get whether a given progress bar widget's displaying values are
17308 * @param obj The progress bar object
17309 * @return @c EINA_TRUE, if @p obj has inverted values,
17310 * @c EINA_FALSE otherwise (and on errors)
17312 * @see elm_progressbar_inverted_set() for more details
17314 * @ingroup Progressbar
17316 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17319 * @defgroup Separator Separator
17321 * @brief Separator is a very thin object used to separate other objects.
17323 * A separator can be vertical or horizontal.
17325 * @ref tutorial_separator is a good example of how to use a separator.
17329 * @brief Add a separator object to @p parent
17331 * @param parent The parent object
17333 * @return The separator object, or NULL upon failure
17335 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17337 * @brief Set the horizontal mode of a separator object
17339 * @param obj The separator object
17340 * @param horizontal If true, the separator is horizontal
17342 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17344 * @brief Get the horizontal mode of a separator object
17346 * @param obj The separator object
17347 * @return If true, the separator is horizontal
17349 * @see elm_separator_horizontal_set()
17351 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17357 * @defgroup Spinner Spinner
17358 * @ingroup Elementary
17360 * @image html img/widget/spinner/preview-00.png
17361 * @image latex img/widget/spinner/preview-00.eps
17363 * A spinner is a widget which allows the user to increase or decrease
17364 * numeric values using arrow buttons, or edit values directly, clicking
17365 * over it and typing the new value.
17367 * By default the spinner will not wrap and has a label
17368 * of "%.0f" (just showing the integer value of the double).
17370 * A spinner has a label that is formatted with floating
17371 * point values and thus accepts a printf-style format string, like
17374 * It also allows specific values to be replaced by pre-defined labels.
17376 * Smart callbacks one can register to:
17378 * - "changed" - Whenever the spinner value is changed.
17379 * - "delay,changed" - A short time after the value is changed by the user.
17380 * This will be called only when the user stops dragging for a very short
17381 * period or when they release their finger/mouse, so it avoids possibly
17382 * expensive reactions to the value change.
17384 * Available styles for it:
17386 * - @c "vertical": up/down buttons at the right side and text left aligned.
17388 * Here is an example on its usage:
17389 * @ref spinner_example
17393 * @addtogroup Spinner
17398 * Add a new spinner widget to the given parent Elementary
17399 * (container) object.
17401 * @param parent The parent object.
17402 * @return a new spinner widget handle or @c NULL, on errors.
17404 * This function inserts a new spinner widget on the canvas.
17409 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17412 * Set the format string of the displayed label.
17414 * @param obj The spinner object.
17415 * @param fmt The format string for the label display.
17417 * If @c NULL, this sets the format to "%.0f". If not it sets the format
17418 * string for the label text. The label text is provided a floating point
17419 * value, so the label text can display up to 1 floating point value.
17420 * Note that this is optional.
17422 * Use a format string such as "%1.2f meters" for example, and it will
17423 * display values like: "3.14 meters" for a value equal to 3.14159.
17425 * Default is "%0.f".
17427 * @see elm_spinner_label_format_get()
17431 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17434 * Get the label format of the spinner.
17436 * @param obj The spinner object.
17437 * @return The text label format string in UTF-8.
17439 * @see elm_spinner_label_format_set() for details.
17443 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17446 * Set the minimum and maximum values for the spinner.
17448 * @param obj The spinner object.
17449 * @param min The minimum value.
17450 * @param max The maximum value.
17452 * Define the allowed range of values to be selected by the user.
17454 * If actual value is less than @p min, it will be updated to @p min. If it
17455 * is bigger then @p max, will be updated to @p max. Actual value can be
17456 * get with elm_spinner_value_get().
17458 * By default, min is equal to 0, and max is equal to 100.
17460 * @warning Maximum must be greater than minimum.
17462 * @see elm_spinner_min_max_get()
17466 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17469 * Get the minimum and maximum values of the spinner.
17471 * @param obj The spinner object.
17472 * @param min Pointer where to store the minimum value.
17473 * @param max Pointer where to store the maximum value.
17475 * @note If only one value is needed, the other pointer can be passed
17478 * @see elm_spinner_min_max_set() for details.
17482 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17485 * Set the step used to increment or decrement the spinner value.
17487 * @param obj The spinner object.
17488 * @param step The step value.
17490 * This value will be incremented or decremented to the displayed value.
17491 * It will be incremented while the user keep right or top arrow pressed,
17492 * and will be decremented while the user keep left or bottom arrow pressed.
17494 * The interval to increment / decrement can be set with
17495 * elm_spinner_interval_set().
17497 * By default step value is equal to 1.
17499 * @see elm_spinner_step_get()
17503 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17506 * Get the step used to increment or decrement the spinner value.
17508 * @param obj The spinner object.
17509 * @return The step value.
17511 * @see elm_spinner_step_get() for more details.
17515 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17518 * Set the value the spinner displays.
17520 * @param obj The spinner object.
17521 * @param val The value to be displayed.
17523 * Value will be presented on the label following format specified with
17524 * elm_spinner_format_set().
17526 * @warning The value must to be between min and max values. This values
17527 * are set by elm_spinner_min_max_set().
17529 * @see elm_spinner_value_get().
17530 * @see elm_spinner_format_set().
17531 * @see elm_spinner_min_max_set().
17535 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17538 * Get the value displayed by the spinner.
17540 * @param obj The spinner object.
17541 * @return The value displayed.
17543 * @see elm_spinner_value_set() for details.
17547 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17550 * Set whether the spinner should wrap when it reaches its
17551 * minimum or maximum value.
17553 * @param obj The spinner object.
17554 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17557 * Disabled by default. If disabled, when the user tries to increment the
17559 * but displayed value plus step value is bigger than maximum value,
17561 * won't allow it. The same happens when the user tries to decrement it,
17562 * but the value less step is less than minimum value.
17564 * When wrap is enabled, in such situations it will allow these changes,
17565 * but will get the value that would be less than minimum and subtracts
17566 * from maximum. Or add the value that would be more than maximum to
17570 * @li min value = 10
17571 * @li max value = 50
17572 * @li step value = 20
17573 * @li displayed value = 20
17575 * When the user decrement value (using left or bottom arrow), it will
17576 * displays @c 40, because max - (min - (displayed - step)) is
17577 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17579 * @see elm_spinner_wrap_get().
17583 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17586 * Get whether the spinner should wrap when it reaches its
17587 * minimum or maximum value.
17589 * @param obj The spinner object
17590 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17591 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17593 * @see elm_spinner_wrap_set() for details.
17597 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17600 * Set whether the spinner can be directly edited by the user or not.
17602 * @param obj The spinner object.
17603 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17604 * don't allow users to edit it directly.
17606 * Spinner objects can have edition @b disabled, in which state they will
17607 * be changed only by arrows.
17608 * Useful for contexts
17609 * where you don't want your users to interact with it writting the value.
17611 * when using special values, the user can see real value instead
17612 * of special label on edition.
17614 * It's enabled by default.
17616 * @see elm_spinner_editable_get()
17620 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17623 * Get whether the spinner can be directly edited by the user or not.
17625 * @param obj The spinner object.
17626 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17627 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17629 * @see elm_spinner_editable_set() for details.
17633 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17636 * Set a special string to display in the place of the numerical value.
17638 * @param obj The spinner object.
17639 * @param value The value to be replaced.
17640 * @param label The label to be used.
17642 * It's useful for cases when a user should select an item that is
17643 * better indicated by a label than a value. For example, weekdays or months.
17647 * sp = elm_spinner_add(win);
17648 * elm_spinner_min_max_set(sp, 1, 3);
17649 * elm_spinner_special_value_add(sp, 1, "January");
17650 * elm_spinner_special_value_add(sp, 2, "February");
17651 * elm_spinner_special_value_add(sp, 3, "March");
17652 * evas_object_show(sp);
17657 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
17660 * Set the interval on time updates for an user mouse button hold
17661 * on spinner widgets' arrows.
17663 * @param obj The spinner object.
17664 * @param interval The (first) interval value in seconds.
17666 * This interval value is @b decreased while the user holds the
17667 * mouse pointer either incrementing or decrementing spinner's value.
17669 * This helps the user to get to a given value distant from the
17670 * current one easier/faster, as it will start to change quicker and
17671 * quicker on mouse button holds.
17673 * The calculation for the next change interval value, starting from
17674 * the one set with this call, is the previous interval divided by
17675 * @c 1.05, so it decreases a little bit.
17677 * The default starting interval value for automatic changes is
17680 * @see elm_spinner_interval_get()
17684 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
17687 * Get the interval on time updates for an user mouse button hold
17688 * on spinner widgets' arrows.
17690 * @param obj The spinner object.
17691 * @return The (first) interval value, in seconds, set on it.
17693 * @see elm_spinner_interval_set() for more details.
17697 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17704 * @defgroup Index Index
17706 * @image html img/widget/index/preview-00.png
17708 * An index widget gives you an index for fast access to whichever
17709 * group of other UI items one might have. It's a list of text
17710 * items (usually letters, for alphabetically ordered access).
17712 * Index widgets are by default hidden and just appear when the
17713 * user clicks over it's reserved area in the canvas. In its
17714 * default theme, it's an area one @ref Fingers "finger" wide on
17715 * the right side of the index widget's container.
17717 * When items on the index are selected, smart callbacks get
17718 * called, so that its user can make other container objects to
17719 * show a given area or child object depending on the index item
17720 * selected. You'd probably be using an index together with @ref
17721 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
17724 * Smart events one can add callbacks for are:
17725 * - @c "changed" - When the selected index item changes. @c
17726 * event_info is the selected item's data pointer.
17727 * - @c "delay,changed" - When the selected index item changes, but
17728 * after a small idling period. @c event_info is the selected
17729 * item's data pointer.
17730 * - @c "selected" - When the user releases a mouse button and
17731 * selects an item. @c event_info is the selected item's data
17733 * - @c "level,up" - when the user moves a finger from the first
17734 * level to the second level
17735 * - @c "level,down" - when the user moves a finger from the second
17736 * level to the first level
17738 * The @c "delay,changed" event is so that it'll wait a small time
17739 * before actually reporting those events and, moreover, just the
17740 * last event happening on those time frames will actually be
17743 * Here are some examples on its usage:
17744 * @li @ref index_example_01
17745 * @li @ref index_example_02
17749 * @addtogroup Index
17753 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
17756 * Add a new index widget to the given parent Elementary
17757 * (container) object
17759 * @param parent The parent object
17760 * @return a new index widget handle or @c NULL, on errors
17762 * This function inserts a new index widget on the canvas.
17766 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17769 * Set whether a given index widget is or not visible,
17772 * @param obj The index object
17773 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
17775 * Not to be confused with visible as in @c evas_object_show() --
17776 * visible with regard to the widget's auto hiding feature.
17778 * @see elm_index_active_get()
17782 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
17785 * Get whether a given index widget is currently visible or not.
17787 * @param obj The index object
17788 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
17790 * @see elm_index_active_set() for more details
17794 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17797 * Set the items level for a given index widget.
17799 * @param obj The index object.
17800 * @param level @c 0 or @c 1, the currently implemented levels.
17802 * @see elm_index_item_level_get()
17806 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17809 * Get the items level set for a given index widget.
17811 * @param obj The index object.
17812 * @return @c 0 or @c 1, which are the levels @p obj might be at.
17814 * @see elm_index_item_level_set() for more information
17818 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17821 * Returns the last selected item's data, for a given index widget.
17823 * @param obj The index object.
17824 * @return The item @b data associated to the last selected item on
17825 * @p obj (or @c NULL, on errors).
17827 * @warning The returned value is @b not an #Elm_Index_Item item
17828 * handle, but the data associated to it (see the @c item parameter
17829 * in elm_index_item_append(), as an example).
17833 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17836 * Append a new item on a given index widget.
17838 * @param obj The index object.
17839 * @param letter Letter under which the item should be indexed
17840 * @param item The item data to set for the index's item
17842 * Despite the most common usage of the @p letter argument is for
17843 * single char strings, one could use arbitrary strings as index
17846 * @c item will be the pointer returned back on @c "changed", @c
17847 * "delay,changed" and @c "selected" smart events.
17851 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17854 * Prepend a new item on a given index widget.
17856 * @param obj The index object.
17857 * @param letter Letter under which the item should be indexed
17858 * @param item The item data to set for the index's item
17860 * Despite the most common usage of the @p letter argument is for
17861 * single char strings, one could use arbitrary strings as index
17864 * @c item will be the pointer returned back on @c "changed", @c
17865 * "delay,changed" and @c "selected" smart events.
17869 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17872 * Append a new item, on a given index widget, <b>after the item
17873 * having @p relative as data</b>.
17875 * @param obj The index object.
17876 * @param letter Letter under which the item should be indexed
17877 * @param item The item data to set for the index's item
17878 * @param relative The item data of the index item to be the
17879 * predecessor of this new one
17881 * Despite the most common usage of the @p letter argument is for
17882 * single char strings, one could use arbitrary strings as index
17885 * @c item will be the pointer returned back on @c "changed", @c
17886 * "delay,changed" and @c "selected" smart events.
17888 * @note If @p relative is @c NULL or if it's not found to be data
17889 * set on any previous item on @p obj, this function will behave as
17890 * elm_index_item_append().
17894 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17897 * Prepend a new item, on a given index widget, <b>after the item
17898 * having @p relative as data</b>.
17900 * @param obj The index object.
17901 * @param letter Letter under which the item should be indexed
17902 * @param item The item data to set for the index's item
17903 * @param relative The item data of the index item to be the
17904 * successor of this new one
17906 * Despite the most common usage of the @p letter argument is for
17907 * single char strings, one could use arbitrary strings as index
17910 * @c item will be the pointer returned back on @c "changed", @c
17911 * "delay,changed" and @c "selected" smart events.
17913 * @note If @p relative is @c NULL or if it's not found to be data
17914 * set on any previous item on @p obj, this function will behave as
17915 * elm_index_item_prepend().
17919 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17922 * Insert a new item into the given index widget, using @p cmp_func
17923 * function to sort items (by item handles).
17925 * @param obj The index object.
17926 * @param letter Letter under which the item should be indexed
17927 * @param item The item data to set for the index's item
17928 * @param cmp_func The comparing function to be used to sort index
17929 * items <b>by #Elm_Index_Item item handles</b>
17930 * @param cmp_data_func A @b fallback function to be called for the
17931 * sorting of index items <b>by item data</b>). It will be used
17932 * when @p cmp_func returns @c 0 (equality), which means an index
17933 * item with provided item data already exists. To decide which
17934 * data item should be pointed to by the index item in question, @p
17935 * cmp_data_func will be used. If @p cmp_data_func returns a
17936 * non-negative value, the previous index item data will be
17937 * replaced by the given @p item pointer. If the previous data need
17938 * to be freed, it should be done by the @p cmp_data_func function,
17939 * because all references to it will be lost. If this function is
17940 * not provided (@c NULL is given), index items will be @b
17941 * duplicated, if @p cmp_func returns @c 0.
17943 * Despite the most common usage of the @p letter argument is for
17944 * single char strings, one could use arbitrary strings as index
17947 * @c item will be the pointer returned back on @c "changed", @c
17948 * "delay,changed" and @c "selected" smart events.
17952 EAPI void elm_index_item_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);
17955 * Remove an item from a given index widget, <b>to be referenced by
17956 * it's data value</b>.
17958 * @param obj The index object
17959 * @param item The item's data pointer for the item to be removed
17962 * If a deletion callback is set, via elm_index_item_del_cb_set(),
17963 * that callback function will be called by this one.
17965 * @warning The item to be removed from @p obj will be found via
17966 * its item data pointer, and not by an #Elm_Index_Item handle.
17970 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
17973 * Find a given index widget's item, <b>using item data</b>.
17975 * @param obj The index object
17976 * @param item The item data pointed to by the desired index item
17977 * @return The index item handle, if found, or @c NULL otherwise
17981 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
17984 * Removes @b all items from a given index widget.
17986 * @param obj The index object.
17988 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
17989 * that callback function will be called for each item in @p obj.
17993 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17996 * Go to a given items level on a index widget
17998 * @param obj The index object
17999 * @param level The index level (one of @c 0 or @c 1)
18003 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18006 * Return the data associated with a given index widget item
18008 * @param it The index widget item handle
18009 * @return The data associated with @p it
18011 * @see elm_index_item_data_set()
18015 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18018 * Set the data associated with a given index widget item
18020 * @param it The index widget item handle
18021 * @param data The new data pointer to set to @p it
18023 * This sets new item data on @p it.
18025 * @warning The old data pointer won't be touched by this function, so
18026 * the user had better to free that old data himself/herself.
18030 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18033 * Set the function to be called when a given index widget item is freed.
18035 * @param it The item to set the callback on
18036 * @param func The function to call on the item's deletion
18038 * When called, @p func will have both @c data and @c event_info
18039 * arguments with the @p it item's data value and, naturally, the
18040 * @c obj argument with a handle to the parent index widget.
18044 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18047 * Get the letter (string) set on a given index widget item.
18049 * @param it The index item handle
18050 * @return The letter string set on @p it
18054 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18061 * @defgroup Photocam Photocam
18063 * @image html img/widget/photocam/preview-00.png
18064 * @image latex img/widget/photocam/preview-00.eps
18066 * This is a widget specifically for displaying high-resolution digital
18067 * camera photos giving speedy feedback (fast load), low memory footprint
18068 * and zooming and panning as well as fitting logic. It is entirely focused
18069 * on jpeg images, and takes advantage of properties of the jpeg format (via
18070 * evas loader features in the jpeg loader).
18072 * Signals that you can add callbacks for are:
18073 * @li "clicked" - This is called when a user has clicked the photo without
18075 * @li "press" - This is called when a user has pressed down on the photo.
18076 * @li "longpressed" - This is called when a user has pressed down on the
18077 * photo for a long time without dragging around.
18078 * @li "clicked,double" - This is called when a user has double-clicked the
18080 * @li "load" - Photo load begins.
18081 * @li "loaded" - This is called when the image file load is complete for the
18082 * first view (low resolution blurry version).
18083 * @li "load,detail" - Photo detailed data load begins.
18084 * @li "loaded,detail" - This is called when the image file load is complete
18085 * for the detailed image data (full resolution needed).
18086 * @li "zoom,start" - Zoom animation started.
18087 * @li "zoom,stop" - Zoom animation stopped.
18088 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18089 * @li "scroll" - the content has been scrolled (moved)
18090 * @li "scroll,anim,start" - scrolling animation has started
18091 * @li "scroll,anim,stop" - scrolling animation has stopped
18092 * @li "scroll,drag,start" - dragging the contents around has started
18093 * @li "scroll,drag,stop" - dragging the contents around has stopped
18095 * @ref tutorial_photocam shows the API in action.
18099 * @brief Types of zoom available.
18101 typedef enum _Elm_Photocam_Zoom_Mode
18103 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18104 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18105 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18106 ELM_PHOTOCAM_ZOOM_MODE_LAST
18107 } Elm_Photocam_Zoom_Mode;
18109 * @brief Add a new Photocam object
18111 * @param parent The parent object
18112 * @return The new object or NULL if it cannot be created
18114 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18116 * @brief Set the photo file to be shown
18118 * @param obj The photocam object
18119 * @param file The photo file
18120 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18122 * This sets (and shows) the specified file (with a relative or absolute
18123 * path) and will return a load error (same error that
18124 * evas_object_image_load_error_get() will return). The image will change and
18125 * adjust its size at this point and begin a background load process for this
18126 * photo that at some time in the future will be displayed at the full
18129 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18131 * @brief Returns the path of the current image file
18133 * @param obj The photocam object
18134 * @return Returns the path
18136 * @see elm_photocam_file_set()
18138 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18140 * @brief Set the zoom level of the photo
18142 * @param obj The photocam object
18143 * @param zoom The zoom level to set
18145 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18146 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18147 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18148 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18151 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18153 * @brief Get the zoom level of the photo
18155 * @param obj The photocam object
18156 * @return The current zoom level
18158 * This returns the current zoom level of the photocam object. Note that if
18159 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18160 * (which is the default), the zoom level may be changed at any time by the
18161 * photocam object itself to account for photo size and photocam viewpoer
18164 * @see elm_photocam_zoom_set()
18165 * @see elm_photocam_zoom_mode_set()
18167 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18169 * @brief Set the zoom mode
18171 * @param obj The photocam object
18172 * @param mode The desired mode
18174 * This sets the zoom mode to manual or one of several automatic levels.
18175 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18176 * elm_photocam_zoom_set() and will stay at that level until changed by code
18177 * or until zoom mode is changed. This is the default mode. The Automatic
18178 * modes will allow the photocam object to automatically adjust zoom mode
18179 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18180 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18181 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18182 * pixels within the frame are left unfilled.
18184 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18186 * @brief Get the zoom mode
18188 * @param obj The photocam object
18189 * @return The current zoom mode
18191 * This gets the current zoom mode of the photocam object.
18193 * @see elm_photocam_zoom_mode_set()
18195 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18197 * @brief Get the current image pixel width and height
18199 * @param obj The photocam object
18200 * @param w A pointer to the width return
18201 * @param h A pointer to the height return
18203 * This gets the current photo pixel width and height (for the original).
18204 * The size will be returned in the integers @p w and @p h that are pointed
18207 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18209 * @brief Get the area of the image that is currently shown
18212 * @param x A pointer to the X-coordinate of region
18213 * @param y A pointer to the Y-coordinate of region
18214 * @param w A pointer to the width
18215 * @param h A pointer to the height
18217 * @see elm_photocam_image_region_show()
18218 * @see elm_photocam_image_region_bring_in()
18220 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18222 * @brief Set the viewed portion of the image
18224 * @param obj The photocam object
18225 * @param x X-coordinate of region in image original pixels
18226 * @param y Y-coordinate of region in image original pixels
18227 * @param w Width of region in image original pixels
18228 * @param h Height of region in image original pixels
18230 * This shows the region of the image without using animation.
18232 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18234 * @brief Bring in the viewed portion of the image
18236 * @param obj The photocam object
18237 * @param x X-coordinate of region in image original pixels
18238 * @param y Y-coordinate of region in image original pixels
18239 * @param w Width of region in image original pixels
18240 * @param h Height of region in image original pixels
18242 * This shows the region of the image using animation.
18244 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18246 * @brief Set the paused state for photocam
18248 * @param obj The photocam object
18249 * @param paused The pause state to set
18251 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18252 * photocam. The default is off. This will stop zooming using animation on
18253 * zoom levels changes and change instantly. This will stop any existing
18254 * animations that are running.
18256 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18258 * @brief Get the paused state for photocam
18260 * @param obj The photocam object
18261 * @return The current paused state
18263 * This gets the current paused state for the photocam object.
18265 * @see elm_photocam_paused_set()
18267 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18269 * @brief Get the internal low-res image used for photocam
18271 * @param obj The photocam object
18272 * @return The internal image object handle, or NULL if none exists
18274 * This gets the internal image object inside photocam. Do not modify it. It
18275 * is for inspection only, and hooking callbacks to. Nothing else. It may be
18276 * deleted at any time as well.
18278 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18280 * @brief Set the photocam scrolling bouncing.
18282 * @param obj The photocam object
18283 * @param h_bounce bouncing for horizontal
18284 * @param v_bounce bouncing for vertical
18286 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18288 * @brief Get the photocam scrolling bouncing.
18290 * @param obj The photocam object
18291 * @param h_bounce bouncing for horizontal
18292 * @param v_bounce bouncing for vertical
18294 * @see elm_photocam_bounce_set()
18296 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18302 * @defgroup Map Map
18303 * @ingroup Elementary
18305 * @image html img/widget/map/preview-00.png
18306 * @image latex img/widget/map/preview-00.eps
18308 * This is a widget specifically for displaying a map. It uses basically
18309 * OpenStreetMap provider http://www.openstreetmap.org/,
18310 * but custom providers can be added.
18312 * It supports some basic but yet nice features:
18313 * @li zoom and scroll
18314 * @li markers with content to be displayed when user clicks over it
18315 * @li group of markers
18318 * Smart callbacks one can listen to:
18320 * - "clicked" - This is called when a user has clicked the map without
18322 * - "press" - This is called when a user has pressed down on the map.
18323 * - "longpressed" - This is called when a user has pressed down on the map
18324 * for a long time without dragging around.
18325 * - "clicked,double" - This is called when a user has double-clicked
18327 * - "load,detail" - Map detailed data load begins.
18328 * - "loaded,detail" - This is called when all currently visible parts of
18329 * the map are loaded.
18330 * - "zoom,start" - Zoom animation started.
18331 * - "zoom,stop" - Zoom animation stopped.
18332 * - "zoom,change" - Zoom changed when using an auto zoom mode.
18333 * - "scroll" - the content has been scrolled (moved).
18334 * - "scroll,anim,start" - scrolling animation has started.
18335 * - "scroll,anim,stop" - scrolling animation has stopped.
18336 * - "scroll,drag,start" - dragging the contents around has started.
18337 * - "scroll,drag,stop" - dragging the contents around has stopped.
18338 * - "downloaded" - This is called when all currently required map images
18340 * - "route,load" - This is called when route request begins.
18341 * - "route,loaded" - This is called when route request ends.
18342 * - "name,load" - This is called when name request begins.
18343 * - "name,loaded- This is called when name request ends.
18345 * Available style for map widget:
18348 * Available style for markers:
18353 * Available style for marker bubble:
18356 * List of examples:
18357 * @li @ref map_example_01
18358 * @li @ref map_example_02
18359 * @li @ref map_example_03
18368 * @enum _Elm_Map_Zoom_Mode
18369 * @typedef Elm_Map_Zoom_Mode
18371 * Set map's zoom behavior. It can be set to manual or automatic.
18373 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
18375 * Values <b> don't </b> work as bitmask, only one can be choosen.
18377 * @note Valid sizes are 2^zoom, consequently the map may be smaller
18378 * than the scroller view.
18380 * @see elm_map_zoom_mode_set()
18381 * @see elm_map_zoom_mode_get()
18385 typedef enum _Elm_Map_Zoom_Mode
18387 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
18388 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
18389 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
18390 ELM_MAP_ZOOM_MODE_LAST
18391 } Elm_Map_Zoom_Mode;
18394 * @enum _Elm_Map_Route_Sources
18395 * @typedef Elm_Map_Route_Sources
18397 * Set route service to be used. By default used source is
18398 * #ELM_MAP_ROUTE_SOURCE_YOURS.
18400 * @see elm_map_route_source_set()
18401 * @see elm_map_route_source_get()
18405 typedef enum _Elm_Map_Route_Sources
18407 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
18408 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. */
18409 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
18410 ELM_MAP_ROUTE_SOURCE_LAST
18411 } Elm_Map_Route_Sources;
18413 typedef enum _Elm_Map_Name_Sources
18415 ELM_MAP_NAME_SOURCE_NOMINATIM,
18416 ELM_MAP_NAME_SOURCE_LAST
18417 } Elm_Map_Name_Sources;
18420 * @enum _Elm_Map_Route_Type
18421 * @typedef Elm_Map_Route_Type
18423 * Set type of transport used on route.
18425 * @see elm_map_route_add()
18429 typedef enum _Elm_Map_Route_Type
18431 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
18432 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
18433 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
18434 ELM_MAP_ROUTE_TYPE_LAST
18435 } Elm_Map_Route_Type;
18438 * @enum _Elm_Map_Route_Method
18439 * @typedef Elm_Map_Route_Method
18441 * Set the routing method, what should be priorized, time or distance.
18443 * @see elm_map_route_add()
18447 typedef enum _Elm_Map_Route_Method
18449 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
18450 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
18451 ELM_MAP_ROUTE_METHOD_LAST
18452 } Elm_Map_Route_Method;
18454 typedef enum _Elm_Map_Name_Method
18456 ELM_MAP_NAME_METHOD_SEARCH,
18457 ELM_MAP_NAME_METHOD_REVERSE,
18458 ELM_MAP_NAME_METHOD_LAST
18459 } Elm_Map_Name_Method;
18461 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(). */
18462 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(). */
18463 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(). */
18464 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(). */
18465 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
18466 typedef struct _Elm_Map_Track Elm_Map_Track;
18468 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. */
18469 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
18470 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
18471 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
18473 typedef char *(*ElmMapModuleSourceFunc) (void);
18474 typedef int (*ElmMapModuleZoomMinFunc) (void);
18475 typedef int (*ElmMapModuleZoomMaxFunc) (void);
18476 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18477 typedef int (*ElmMapModuleRouteSourceFunc) (void);
18478 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18479 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18480 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18481 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18484 * Add a new map widget to the given parent Elementary (container) object.
18486 * @param parent The parent object.
18487 * @return a new map widget handle or @c NULL, on errors.
18489 * This function inserts a new map widget on the canvas.
18493 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18496 * Set the zoom level of the map.
18498 * @param obj The map object.
18499 * @param zoom The zoom level to set.
18501 * This sets the zoom level.
18503 * It will respect limits defined by elm_map_source_zoom_min_set() and
18504 * elm_map_source_zoom_max_set().
18506 * By default these values are 0 (world map) and 18 (maximum zoom).
18508 * This function should be used when zoom mode is set to
18509 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
18510 * with elm_map_zoom_mode_set().
18512 * @see elm_map_zoom_mode_set().
18513 * @see elm_map_zoom_get().
18517 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18520 * Get the zoom level of the map.
18522 * @param obj The map object.
18523 * @return The current zoom level.
18525 * This returns the current zoom level of the map object.
18527 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
18528 * (which is the default), the zoom level may be changed at any time by the
18529 * map object itself to account for map size and map viewport size.
18531 * @see elm_map_zoom_set() for details.
18535 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18538 * Set the zoom mode used by the map object.
18540 * @param obj The map object.
18541 * @param mode The zoom mode of the map, being it one of
18542 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18543 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18545 * This sets the zoom mode to manual or one of the automatic levels.
18546 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
18547 * elm_map_zoom_set() and will stay at that level until changed by code
18548 * or until zoom mode is changed. This is the default mode.
18550 * The Automatic modes will allow the map object to automatically
18551 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
18552 * adjust zoom so the map fits inside the scroll frame with no pixels
18553 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
18554 * ensure no pixels within the frame are left unfilled. Do not forget that
18555 * the valid sizes are 2^zoom, consequently the map may be smaller than
18556 * the scroller view.
18558 * @see elm_map_zoom_set()
18562 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18565 * Get the zoom mode used by the map object.
18567 * @param obj The map object.
18568 * @return The zoom mode of the map, being it one of
18569 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18570 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18572 * This function returns the current zoom mode used by the map object.
18574 * @see elm_map_zoom_mode_set() for more details.
18578 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18581 * Get the current coordinates of the map.
18583 * @param obj The map object.
18584 * @param lon Pointer where to store longitude.
18585 * @param lat Pointer where to store latitude.
18587 * This gets the current center coordinates of the map object. It can be
18588 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
18590 * @see elm_map_geo_region_bring_in()
18591 * @see elm_map_geo_region_show()
18595 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18598 * Animatedly bring in given coordinates to the center of the map.
18600 * @param obj The map object.
18601 * @param lon Longitude to center at.
18602 * @param lat Latitude to center at.
18604 * This causes map to jump to the given @p lat and @p lon coordinates
18605 * and show it (by scrolling) in the center of the viewport, if it is not
18606 * already centered. This will use animation to do so and take a period
18607 * of time to complete.
18609 * @see elm_map_geo_region_show() for a function to avoid animation.
18610 * @see elm_map_geo_region_get()
18614 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18617 * Show the given coordinates at the center of the map, @b immediately.
18619 * @param obj The map object.
18620 * @param lon Longitude to center at.
18621 * @param lat Latitude to center at.
18623 * This causes map to @b redraw its viewport's contents to the
18624 * region contining the given @p lat and @p lon, that will be moved to the
18625 * center of the map.
18627 * @see elm_map_geo_region_bring_in() for a function to move with animation.
18628 * @see elm_map_geo_region_get()
18632 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18635 * Pause or unpause the map.
18637 * @param obj The map object.
18638 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
18641 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18644 * The default is off.
18646 * This will stop zooming using animation, changing zoom levels will
18647 * change instantly. This will stop any existing animations that are running.
18649 * @see elm_map_paused_get()
18653 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18656 * Get a value whether map is paused or not.
18658 * @param obj The map object.
18659 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
18660 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
18662 * This gets the current paused state for the map object.
18664 * @see elm_map_paused_set() for details.
18668 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18671 * Set to show markers during zoom level changes or not.
18673 * @param obj The map object.
18674 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
18677 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18680 * The default is off.
18682 * This will stop zooming using animation, changing zoom levels will
18683 * change instantly. This will stop any existing animations that are running.
18685 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18688 * The default is off.
18690 * Enabling it will force the map to stop displaying the markers during
18691 * zoom level changes. Set to on if you have a large number of markers.
18693 * @see elm_map_paused_markers_get()
18697 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18700 * Get a value whether markers will be displayed on zoom level changes or not
18702 * @param obj The map object.
18703 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
18704 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
18706 * This gets the current markers paused state for the map object.
18708 * @see elm_map_paused_markers_set() for details.
18712 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18715 * Get the information of downloading status.
18717 * @param obj The map object.
18718 * @param try_num Pointer where to store number of tiles being downloaded.
18719 * @param finish_num Pointer where to store number of tiles successfully
18722 * This gets the current downloading status for the map object, the number
18723 * of tiles being downloaded and the number of tiles already downloaded.
18727 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
18730 * Convert a pixel coordinate (x,y) into a geographic coordinate
18731 * (longitude, latitude).
18733 * @param obj The map object.
18734 * @param x the coordinate.
18735 * @param y the coordinate.
18736 * @param size the size in pixels of the map.
18737 * The map is a square and generally his size is : pow(2.0, zoom)*256.
18738 * @param lon Pointer where to store the longitude that correspond to x.
18739 * @param lat Pointer where to store the latitude that correspond to y.
18741 * @note Origin pixel point is the top left corner of the viewport.
18742 * Map zoom and size are taken on account.
18744 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
18748 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);
18751 * Convert a geographic coordinate (longitude, latitude) into a pixel
18752 * coordinate (x, y).
18754 * @param obj The map object.
18755 * @param lon the longitude.
18756 * @param lat the latitude.
18757 * @param size the size in pixels of the map. The map is a square
18758 * and generally his size is : pow(2.0, zoom)*256.
18759 * @param x Pointer where to store the horizontal pixel coordinate that
18760 * correspond to the longitude.
18761 * @param y Pointer where to store the vertical pixel coordinate that
18762 * correspond to the latitude.
18764 * @note Origin pixel point is the top left corner of the viewport.
18765 * Map zoom and size are taken on account.
18767 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
18771 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);
18774 * Convert a geographic coordinate (longitude, latitude) into a name
18777 * @param obj The map object.
18778 * @param lon the longitude.
18779 * @param lat the latitude.
18780 * @return name A #Elm_Map_Name handle for this coordinate.
18782 * To get the string for this address, elm_map_name_address_get()
18785 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
18789 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18792 * Convert a name (address) into a geographic coordinate
18793 * (longitude, latitude).
18795 * @param obj The map object.
18796 * @param name The address.
18797 * @return name A #Elm_Map_Name handle for this address.
18799 * To get the longitude and latitude, elm_map_name_region_get()
18802 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
18806 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
18809 * Convert a pixel coordinate into a rotated pixel coordinate.
18811 * @param obj The map object.
18812 * @param x horizontal coordinate of the point to rotate.
18813 * @param y vertical coordinate of the point to rotate.
18814 * @param cx rotation's center horizontal position.
18815 * @param cy rotation's center vertical position.
18816 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
18817 * @param xx Pointer where to store rotated x.
18818 * @param yy Pointer where to store rotated y.
18822 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);
18825 * Add a new marker to the map object.
18827 * @param obj The map object.
18828 * @param lon The longitude of the marker.
18829 * @param lat The latitude of the marker.
18830 * @param clas The class, to use when marker @b isn't grouped to others.
18831 * @param clas_group The class group, to use when marker is grouped to others
18832 * @param data The data passed to the callbacks.
18834 * @return The created marker or @c NULL upon failure.
18836 * A marker will be created and shown in a specific point of the map, defined
18837 * by @p lon and @p lat.
18839 * It will be displayed using style defined by @p class when this marker
18840 * is displayed alone (not grouped). A new class can be created with
18841 * elm_map_marker_class_new().
18843 * If the marker is grouped to other markers, it will be displayed with
18844 * style defined by @p class_group. Markers with the same group are grouped
18845 * if they are close. A new group class can be created with
18846 * elm_map_marker_group_class_new().
18848 * Markers created with this method can be deleted with
18849 * elm_map_marker_remove().
18851 * A marker can have associated content to be displayed by a bubble,
18852 * when a user click over it, as well as an icon. These objects will
18853 * be fetch using class' callback functions.
18855 * @see elm_map_marker_class_new()
18856 * @see elm_map_marker_group_class_new()
18857 * @see elm_map_marker_remove()
18861 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);
18864 * Set the maximum numbers of markers' content to be displayed in a group.
18866 * @param obj The map object.
18867 * @param max The maximum numbers of items displayed in a bubble.
18869 * A bubble will be displayed when the user clicks over the group,
18870 * and will place the content of markers that belong to this group
18873 * A group can have a long list of markers, consequently the creation
18874 * of the content of the bubble can be very slow.
18876 * In order to avoid this, a maximum number of items is displayed
18879 * By default this number is 30.
18881 * Marker with the same group class are grouped if they are close.
18883 * @see elm_map_marker_add()
18887 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
18890 * Remove a marker from the map.
18892 * @param marker The marker to remove.
18894 * @see elm_map_marker_add()
18898 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18901 * Get the current coordinates of the marker.
18903 * @param marker marker.
18904 * @param lat Pointer where to store the marker's latitude.
18905 * @param lon Pointer where to store the marker's longitude.
18907 * These values are set when adding markers, with function
18908 * elm_map_marker_add().
18910 * @see elm_map_marker_add()
18914 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
18917 * Animatedly bring in given marker to the center of the map.
18919 * @param marker The marker to center at.
18921 * This causes map to jump to the given @p marker's coordinates
18922 * and show it (by scrolling) in the center of the viewport, if it is not
18923 * already centered. This will use animation to do so and take a period
18924 * of time to complete.
18926 * @see elm_map_marker_show() for a function to avoid animation.
18927 * @see elm_map_marker_region_get()
18931 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18934 * Show the given marker at the center of the map, @b immediately.
18936 * @param marker The marker to center at.
18938 * This causes map to @b redraw its viewport's contents to the
18939 * region contining the given @p marker's coordinates, that will be
18940 * moved to the center of the map.
18942 * @see elm_map_marker_bring_in() for a function to move with animation.
18943 * @see elm_map_markers_list_show() if more than one marker need to be
18945 * @see elm_map_marker_region_get()
18949 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18952 * Move and zoom the map to display a list of markers.
18954 * @param markers A list of #Elm_Map_Marker handles.
18956 * The map will be centered on the center point of the markers in the list.
18957 * Then the map will be zoomed in order to fit the markers using the maximum
18958 * zoom which allows display of all the markers.
18960 * @warning All the markers should belong to the same map object.
18962 * @see elm_map_marker_show() to show a single marker.
18963 * @see elm_map_marker_bring_in()
18967 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
18970 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
18972 * @param marker The marker wich content should be returned.
18973 * @return Return the evas object if it exists, else @c NULL.
18975 * To set callback function #ElmMapMarkerGetFunc for the marker class,
18976 * elm_map_marker_class_get_cb_set() should be used.
18978 * This content is what will be inside the bubble that will be displayed
18979 * when an user clicks over the marker.
18981 * This returns the actual Evas object used to be placed inside
18982 * the bubble. This may be @c NULL, as it may
18983 * not have been created or may have been deleted, at any time, by
18984 * the map. <b>Do not modify this object</b> (move, resize,
18985 * show, hide, etc.), as the map is controlling it. This
18986 * function is for querying, emitting custom signals or hooking
18987 * lower level callbacks for events on that object. Do not delete
18988 * this object under any circumstances.
18992 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18995 * Update the marker
18997 * @param marker The marker to be updated.
18999 * If a content is set to this marker, it will call function to delete it,
19000 * #ElmMapMarkerDelFunc, and then will fetch the content again with
19001 * #ElmMapMarkerGetFunc.
19003 * These functions are set for the marker class with
19004 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
19008 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19011 * Close all the bubbles opened by the user.
19013 * @param obj The map object.
19015 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
19016 * when the user clicks on a marker.
19018 * This functions is set for the marker class with
19019 * elm_map_marker_class_get_cb_set().
19023 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
19026 * Create a new group class.
19028 * @param obj The map object.
19029 * @return Returns the new group class.
19031 * Each marker must be associated to a group class. Markers in the same
19032 * group are grouped if they are close.
19034 * The group class defines the style of the marker when a marker is grouped
19035 * to others markers. When it is alone, another class will be used.
19037 * A group class will need to be provided when creating a marker with
19038 * elm_map_marker_add().
19040 * Some properties and functions can be set by class, as:
19041 * - style, with elm_map_group_class_style_set()
19042 * - data - to be associated to the group class. It can be set using
19043 * elm_map_group_class_data_set().
19044 * - min zoom to display markers, set with
19045 * elm_map_group_class_zoom_displayed_set().
19046 * - max zoom to group markers, set using
19047 * elm_map_group_class_zoom_grouped_set().
19048 * - visibility - set if markers will be visible or not, set with
19049 * elm_map_group_class_hide_set().
19050 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
19051 * It can be set using elm_map_group_class_icon_cb_set().
19053 * @see elm_map_marker_add()
19054 * @see elm_map_group_class_style_set()
19055 * @see elm_map_group_class_data_set()
19056 * @see elm_map_group_class_zoom_displayed_set()
19057 * @see elm_map_group_class_zoom_grouped_set()
19058 * @see elm_map_group_class_hide_set()
19059 * @see elm_map_group_class_icon_cb_set()
19063 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19066 * Set the marker's style of a group class.
19068 * @param clas The group class.
19069 * @param style The style to be used by markers.
19071 * Each marker must be associated to a group class, and will use the style
19072 * defined by such class when grouped to other markers.
19074 * The following styles are provided by default theme:
19075 * @li @c radio - blue circle
19076 * @li @c radio2 - green circle
19079 * @see elm_map_group_class_new() for more details.
19080 * @see elm_map_marker_add()
19084 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19087 * Set the icon callback function of a group class.
19089 * @param clas The group class.
19090 * @param icon_get The callback function that will return the icon.
19092 * Each marker must be associated to a group class, and it can display a
19093 * custom icon. The function @p icon_get must return this icon.
19095 * @see elm_map_group_class_new() for more details.
19096 * @see elm_map_marker_add()
19100 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19103 * Set the data associated to the group class.
19105 * @param clas The group class.
19106 * @param data The new user data.
19108 * This data will be passed for callback functions, like icon get callback,
19109 * that can be set with elm_map_group_class_icon_cb_set().
19111 * If a data was previously set, the object will lose the pointer for it,
19112 * so if needs to be freed, you must do it yourself.
19114 * @see elm_map_group_class_new() for more details.
19115 * @see elm_map_group_class_icon_cb_set()
19116 * @see elm_map_marker_add()
19120 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
19123 * Set the minimum zoom from where the markers are displayed.
19125 * @param clas The group class.
19126 * @param zoom The minimum zoom.
19128 * Markers only will be displayed when the map is displayed at @p zoom
19131 * @see elm_map_group_class_new() for more details.
19132 * @see elm_map_marker_add()
19136 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19139 * Set the zoom from where the markers are no more grouped.
19141 * @param clas The group class.
19142 * @param zoom The maximum zoom.
19144 * Markers only will be grouped when the map is displayed at
19145 * less than @p zoom.
19147 * @see elm_map_group_class_new() for more details.
19148 * @see elm_map_marker_add()
19152 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19155 * Set if the markers associated to the group class @clas are hidden or not.
19157 * @param clas The group class.
19158 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
19161 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
19166 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
19169 * Create a new marker class.
19171 * @param obj The map object.
19172 * @return Returns the new group class.
19174 * Each marker must be associated to a class.
19176 * The marker class defines the style of the marker when a marker is
19177 * displayed alone, i.e., not grouped to to others markers. When grouped
19178 * it will use group class style.
19180 * A marker class will need to be provided when creating a marker with
19181 * elm_map_marker_add().
19183 * Some properties and functions can be set by class, as:
19184 * - style, with elm_map_marker_class_style_set()
19185 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
19186 * It can be set using elm_map_marker_class_icon_cb_set().
19187 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
19188 * Set using elm_map_marker_class_get_cb_set().
19189 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
19190 * Set using elm_map_marker_class_del_cb_set().
19192 * @see elm_map_marker_add()
19193 * @see elm_map_marker_class_style_set()
19194 * @see elm_map_marker_class_icon_cb_set()
19195 * @see elm_map_marker_class_get_cb_set()
19196 * @see elm_map_marker_class_del_cb_set()
19200 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19203 * Set the marker's style of a marker class.
19205 * @param clas The marker class.
19206 * @param style The style to be used by markers.
19208 * Each marker must be associated to a marker class, and will use the style
19209 * defined by such class when alone, i.e., @b not grouped to other markers.
19211 * The following styles are provided by default theme:
19216 * @see elm_map_marker_class_new() for more details.
19217 * @see elm_map_marker_add()
19221 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19224 * Set the icon callback function of a marker class.
19226 * @param clas The marker class.
19227 * @param icon_get The callback function that will return the icon.
19229 * Each marker must be associated to a marker class, and it can display a
19230 * custom icon. The function @p icon_get must return this icon.
19232 * @see elm_map_marker_class_new() for more details.
19233 * @see elm_map_marker_add()
19237 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19240 * Set the bubble content callback function of a marker class.
19242 * @param clas The marker class.
19243 * @param get The callback function that will return the content.
19245 * Each marker must be associated to a marker class, and it can display a
19246 * a content on a bubble that opens when the user click over the marker.
19247 * The function @p get must return this content object.
19249 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
19252 * @see elm_map_marker_class_new() for more details.
19253 * @see elm_map_marker_class_del_cb_set()
19254 * @see elm_map_marker_add()
19258 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
19261 * Set the callback function used to delete bubble content of a marker class.
19263 * @param clas The marker class.
19264 * @param del The callback function that will delete the content.
19266 * Each marker must be associated to a marker class, and it can display a
19267 * a content on a bubble that opens when the user click over the marker.
19268 * The function to return such content can be set with
19269 * elm_map_marker_class_get_cb_set().
19271 * If this content must be freed, a callback function need to be
19272 * set for that task with this function.
19274 * If this callback is defined it will have to delete (or not) the
19275 * object inside, but if the callback is not defined the object will be
19276 * destroyed with evas_object_del().
19278 * @see elm_map_marker_class_new() for more details.
19279 * @see elm_map_marker_class_get_cb_set()
19280 * @see elm_map_marker_add()
19284 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
19287 * Get the list of available sources.
19289 * @param obj The map object.
19290 * @return The source names list.
19292 * It will provide a list with all available sources, that can be set as
19293 * current source with elm_map_source_name_set(), or get with
19294 * elm_map_source_name_get().
19296 * Available sources:
19302 * @see elm_map_source_name_set() for more details.
19303 * @see elm_map_source_name_get()
19307 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19310 * Set the source of the map.
19312 * @param obj The map object.
19313 * @param source The source to be used.
19315 * Map widget retrieves images that composes the map from a web service.
19316 * This web service can be set with this method.
19318 * A different service can return a different maps with different
19319 * information and it can use different zoom values.
19321 * The @p source_name need to match one of the names provided by
19322 * elm_map_source_names_get().
19324 * The current source can be get using elm_map_source_name_get().
19326 * @see elm_map_source_names_get()
19327 * @see elm_map_source_name_get()
19332 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
19335 * Get the name of currently used source.
19337 * @param obj The map object.
19338 * @return Returns the name of the source in use.
19340 * @see elm_map_source_name_set() for more details.
19344 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19347 * Set the source of the route service to be used by the map.
19349 * @param obj The map object.
19350 * @param source The route service to be used, being it one of
19351 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
19352 * and #ELM_MAP_ROUTE_SOURCE_ORS.
19354 * Each one has its own algorithm, so the route retrieved may
19355 * differ depending on the source route. Now, only the default is working.
19357 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
19358 * http://www.yournavigation.org/.
19360 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
19361 * assumptions. Its routing core is based on Contraction Hierarchies.
19363 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
19365 * @see elm_map_route_source_get().
19369 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
19372 * Get the current route source.
19374 * @param obj The map object.
19375 * @return The source of the route service used by the map.
19377 * @see elm_map_route_source_set() for details.
19381 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19384 * Set the minimum zoom of the source.
19386 * @param obj The map object.
19387 * @param zoom New minimum zoom value to be used.
19389 * By default, it's 0.
19393 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19396 * Get the minimum zoom of the source.
19398 * @param obj The map object.
19399 * @return Returns the minimum zoom of the source.
19401 * @see elm_map_source_zoom_min_set() for details.
19405 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19408 * Set the maximum zoom of the source.
19410 * @param obj The map object.
19411 * @param zoom New maximum zoom value to be used.
19413 * By default, it's 18.
19417 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19420 * Get the maximum zoom of the source.
19422 * @param obj The map object.
19423 * @return Returns the maximum zoom of the source.
19425 * @see elm_map_source_zoom_min_set() for details.
19429 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19432 * Set the user agent used by the map object to access routing services.
19434 * @param obj The map object.
19435 * @param user_agent The user agent to be used by the map.
19437 * User agent is a client application implementing a network protocol used
19438 * in communications within a client–server distributed computing system
19440 * The @p user_agent identification string will transmitted in a header
19441 * field @c User-Agent.
19443 * @see elm_map_user_agent_get()
19447 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
19450 * Get the user agent used by the map object.
19452 * @param obj The map object.
19453 * @return The user agent identification string used by the map.
19455 * @see elm_map_user_agent_set() for details.
19459 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19462 * Add a new route to the map object.
19464 * @param obj The map object.
19465 * @param type The type of transport to be considered when tracing a route.
19466 * @param method The routing method, what should be priorized.
19467 * @param flon The start longitude.
19468 * @param flat The start latitude.
19469 * @param tlon The destination longitude.
19470 * @param tlat The destination latitude.
19472 * @return The created route or @c NULL upon failure.
19474 * A route will be traced by point on coordinates (@p flat, @p flon)
19475 * to point on coordinates (@p tlat, @p tlon), using the route service
19476 * set with elm_map_route_source_set().
19478 * It will take @p type on consideration to define the route,
19479 * depending if the user will be walking or driving, the route may vary.
19480 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
19481 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
19483 * Another parameter is what the route should priorize, the minor distance
19484 * or the less time to be spend on the route. So @p method should be one
19485 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
19487 * Routes created with this method can be deleted with
19488 * elm_map_route_remove(), colored with elm_map_route_color_set(),
19489 * and distance can be get with elm_map_route_distance_get().
19491 * @see elm_map_route_remove()
19492 * @see elm_map_route_color_set()
19493 * @see elm_map_route_distance_get()
19494 * @see elm_map_route_source_set()
19498 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);
19501 * Remove a route from the map.
19503 * @param route The route to remove.
19505 * @see elm_map_route_add()
19509 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19512 * Set the route color.
19514 * @param route The route object.
19515 * @param r Red channel value, from 0 to 255.
19516 * @param g Green channel value, from 0 to 255.
19517 * @param b Blue channel value, from 0 to 255.
19518 * @param a Alpha channel value, from 0 to 255.
19520 * It uses an additive color model, so each color channel represents
19521 * how much of each primary colors must to be used. 0 represents
19522 * ausence of this color, so if all of the three are set to 0,
19523 * the color will be black.
19525 * These component values should be integers in the range 0 to 255,
19526 * (single 8-bit byte).
19528 * This sets the color used for the route. By default, it is set to
19529 * solid red (r = 255, g = 0, b = 0, a = 255).
19531 * For alpha channel, 0 represents completely transparent, and 255, opaque.
19533 * @see elm_map_route_color_get()
19537 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
19540 * Get the route color.
19542 * @param route The route object.
19543 * @param r Pointer where to store the red channel value.
19544 * @param g Pointer where to store the green channel value.
19545 * @param b Pointer where to store the blue channel value.
19546 * @param a Pointer where to store the alpha channel value.
19548 * @see elm_map_route_color_set() for details.
19552 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
19555 * Get the route distance in kilometers.
19557 * @param route The route object.
19558 * @return The distance of route (unit : km).
19562 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19565 * Get the information of route nodes.
19567 * @param route The route object.
19568 * @return Returns a string with the nodes of route.
19572 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19575 * Get the information of route waypoint.
19577 * @param route the route object.
19578 * @return Returns a string with information about waypoint of route.
19582 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19585 * Get the address of the name.
19587 * @param name The name handle.
19588 * @return Returns the address string of @p name.
19590 * This gets the coordinates of the @p name, created with one of the
19591 * conversion functions.
19593 * @see elm_map_utils_convert_name_into_coord()
19594 * @see elm_map_utils_convert_coord_into_name()
19598 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19601 * Get the current coordinates of the name.
19603 * @param name The name handle.
19604 * @param lat Pointer where to store the latitude.
19605 * @param lon Pointer where to store The longitude.
19607 * This gets the coordinates of the @p name, created with one of the
19608 * conversion functions.
19610 * @see elm_map_utils_convert_name_into_coord()
19611 * @see elm_map_utils_convert_coord_into_name()
19615 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
19618 * Remove a name from the map.
19620 * @param name The name to remove.
19622 * Basically the struct handled by @p name will be freed, so convertions
19623 * between address and coordinates will be lost.
19625 * @see elm_map_utils_convert_name_into_coord()
19626 * @see elm_map_utils_convert_coord_into_name()
19630 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19635 * @param obj The map object.
19636 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
19637 * @param cx Rotation's center horizontal position.
19638 * @param cy Rotation's center vertical position.
19640 * @see elm_map_rotate_get()
19644 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
19647 * Get the rotate degree of the map
19649 * @param obj The map object
19650 * @param degree Pointer where to store degrees from 0.0 to 360.0
19651 * to rotate arount Z axis.
19652 * @param cx Pointer where to store rotation's center horizontal position.
19653 * @param cy Pointer where to store rotation's center vertical position.
19655 * @see elm_map_rotate_set() to set map rotation.
19659 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);
19662 * Enable or disable mouse wheel to be used to zoom in / out the map.
19664 * @param obj The map object.
19665 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
19668 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19670 * It's disabled by default.
19672 * @see elm_map_wheel_disabled_get()
19676 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19679 * Get a value whether mouse wheel is enabled or not.
19681 * @param obj The map object.
19682 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
19683 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19685 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19687 * @see elm_map_wheel_disabled_set() for details.
19691 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19695 * Add a track on the map
19697 * @param obj The map object.
19698 * @param emap The emap route object.
19699 * @return The route object. This is an elm object of type Route.
19701 * @see elm_route_add() for details.
19705 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
19709 * Remove a track from the map
19711 * @param obj The map object.
19712 * @param route The track to remove.
19716 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
19723 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
19725 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
19727 EAPI double elm_route_lon_min_get(Evas_Object *obj);
19728 EAPI double elm_route_lat_min_get(Evas_Object *obj);
19729 EAPI double elm_route_lon_max_get(Evas_Object *obj);
19730 EAPI double elm_route_lat_max_get(Evas_Object *obj);
19734 * @defgroup Panel Panel
19736 * @image html img/widget/panel/preview-00.png
19737 * @image latex img/widget/panel/preview-00.eps
19739 * @brief A panel is a type of animated container that contains subobjects.
19740 * It can be expanded or contracted by clicking the button on it's edge.
19742 * Orientations are as follows:
19743 * @li ELM_PANEL_ORIENT_TOP
19744 * @li ELM_PANEL_ORIENT_LEFT
19745 * @li ELM_PANEL_ORIENT_RIGHT
19747 * @ref tutorial_panel shows one way to use this widget.
19750 typedef enum _Elm_Panel_Orient
19752 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
19753 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
19754 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
19755 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
19756 } Elm_Panel_Orient;
19758 * @brief Adds a panel object
19760 * @param parent The parent object
19762 * @return The panel object, or NULL on failure
19764 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19766 * @brief Sets the orientation of the panel
19768 * @param parent The parent object
19769 * @param orient The panel orientation. Can be one of the following:
19770 * @li ELM_PANEL_ORIENT_TOP
19771 * @li ELM_PANEL_ORIENT_LEFT
19772 * @li ELM_PANEL_ORIENT_RIGHT
19774 * Sets from where the panel will (dis)appear.
19776 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
19778 * @brief Get the orientation of the panel.
19780 * @param obj The panel object
19781 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
19783 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19785 * @brief Set the content of the panel.
19787 * @param obj The panel object
19788 * @param content The panel content
19790 * Once the content object is set, a previously set one will be deleted.
19791 * If you want to keep that old content object, use the
19792 * elm_panel_content_unset() function.
19794 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19796 * @brief Get the content of the panel.
19798 * @param obj The panel object
19799 * @return The content that is being used
19801 * Return the content object which is set for this widget.
19803 * @see elm_panel_content_set()
19805 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19807 * @brief Unset the content of the panel.
19809 * @param obj The panel object
19810 * @return The content that was being used
19812 * Unparent and return the content object which was set for this widget.
19814 * @see elm_panel_content_set()
19816 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19818 * @brief Set the state of the panel.
19820 * @param obj The panel object
19821 * @param hidden If true, the panel will run the animation to contract
19823 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
19825 * @brief Get the state of the panel.
19827 * @param obj The panel object
19828 * @param hidden If true, the panel is in the "hide" state
19830 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19832 * @brief Toggle the hidden state of the panel from code
19834 * @param obj The panel object
19836 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
19842 * @defgroup Panes Panes
19843 * @ingroup Elementary
19845 * @image html img/widget/panes/preview-00.png
19846 * @image latex img/widget/panes/preview-00.eps width=\textwidth
19848 * @image html img/panes.png
19849 * @image latex img/panes.eps width=\textwidth
19851 * The panes adds a dragable bar between two contents. When dragged
19852 * this bar will resize contents size.
19854 * Panes can be displayed vertically or horizontally, and contents
19855 * size proportion can be customized (homogeneous by default).
19857 * Smart callbacks one can listen to:
19858 * - "press" - The panes has been pressed (button wasn't released yet).
19859 * - "unpressed" - The panes was released after being pressed.
19860 * - "clicked" - The panes has been clicked>
19861 * - "clicked,double" - The panes has been double clicked
19863 * Available styles for it:
19866 * Here is an example on its usage:
19867 * @li @ref panes_example
19871 * @addtogroup Panes
19876 * Add a new panes widget to the given parent Elementary
19877 * (container) object.
19879 * @param parent The parent object.
19880 * @return a new panes widget handle or @c NULL, on errors.
19882 * This function inserts a new panes widget on the canvas.
19886 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19889 * Set the left content of the panes widget.
19891 * @param obj The panes object.
19892 * @param content The new left content object.
19894 * Once the content object is set, a previously set one will be deleted.
19895 * If you want to keep that old content object, use the
19896 * elm_panes_content_left_unset() function.
19898 * If panes is displayed vertically, left content will be displayed at
19901 * @see elm_panes_content_left_get()
19902 * @see elm_panes_content_right_set() to set content on the other side.
19906 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19909 * Set the right content of the panes widget.
19911 * @param obj The panes object.
19912 * @param content The new right content object.
19914 * Once the content object is set, a previously set one will be deleted.
19915 * If you want to keep that old content object, use the
19916 * elm_panes_content_right_unset() function.
19918 * If panes is displayed vertically, left content will be displayed at
19921 * @see elm_panes_content_right_get()
19922 * @see elm_panes_content_left_set() to set content on the other side.
19926 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19929 * Get the left content of the panes.
19931 * @param obj The panes object.
19932 * @return The left content object that is being used.
19934 * Return the left content object which is set for this widget.
19936 * @see elm_panes_content_left_set() for details.
19940 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19943 * Get the right content of the panes.
19945 * @param obj The panes object
19946 * @return The right content object that is being used
19948 * Return the right content object which is set for this widget.
19950 * @see elm_panes_content_right_set() for details.
19954 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19957 * Unset the left content used for the panes.
19959 * @param obj The panes object.
19960 * @return The left content object that was being used.
19962 * Unparent and return the left content object which was set for this widget.
19964 * @see elm_panes_content_left_set() for details.
19965 * @see elm_panes_content_left_get().
19969 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19972 * Unset the right content used for the panes.
19974 * @param obj The panes object.
19975 * @return The right content object that was being used.
19977 * Unparent and return the right content object which was set for this
19980 * @see elm_panes_content_right_set() for details.
19981 * @see elm_panes_content_right_get().
19985 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19988 * Get the size proportion of panes widget's left side.
19990 * @param obj The panes object.
19991 * @return float value between 0.0 and 1.0 representing size proportion
19994 * @see elm_panes_content_left_size_set() for more details.
19998 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20001 * Set the size proportion of panes widget's left side.
20003 * @param obj The panes object.
20004 * @param size Value between 0.0 and 1.0 representing size proportion
20007 * By default it's homogeneous, i.e., both sides have the same size.
20009 * If something different is required, it can be set with this function.
20010 * For example, if the left content should be displayed over
20011 * 75% of the panes size, @p size should be passed as @c 0.75.
20012 * This way, right content will be resized to 25% of panes size.
20014 * If displayed vertically, left content is displayed at top, and
20015 * right content at bottom.
20017 * @note This proportion will change when user drags the panes bar.
20019 * @see elm_panes_content_left_size_get()
20023 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
20026 * Set the orientation of a given panes widget.
20028 * @param obj The panes object.
20029 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20030 * @b horizontal, @c EINA_FALSE to make it @b vertical.
20032 * Use this function to change how your panes is to be
20033 * disposed: vertically or horizontally.
20035 * By default it's displayed horizontally.
20037 * @see elm_panes_horizontal_get()
20041 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20044 * Retrieve the orientation of a given panes widget.
20046 * @param obj The panes object.
20047 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20048 * @c EINA_FALSE if it's @b vertical (and on errors).
20050 * @see elm_panes_horizontal_set() for more details.
20054 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20061 * @defgroup Flip Flip
20063 * @image html img/widget/flip/preview-00.png
20064 * @image latex img/widget/flip/preview-00.eps
20066 * This widget holds 2 content objects(Evas_Object): one on the front and one
20067 * on the back. It allows you to flip from front to back and vice-versa using
20068 * various animations.
20070 * If either the front or back contents are not set the flip will treat that
20071 * as transparent. So if you wore to set the front content but not the back,
20072 * and then call elm_flip_go() you would see whatever is below the flip.
20074 * For a list of supported animations see elm_flip_go().
20076 * Signals that you can add callbacks for are:
20077 * "animate,begin" - when a flip animation was started
20078 * "animate,done" - when a flip animation is finished
20080 * @ref tutorial_flip show how to use most of the API.
20084 typedef enum _Elm_Flip_Mode
20086 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
20087 ELM_FLIP_ROTATE_X_CENTER_AXIS,
20088 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
20089 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
20090 ELM_FLIP_CUBE_LEFT,
20091 ELM_FLIP_CUBE_RIGHT,
20093 ELM_FLIP_CUBE_DOWN,
20094 ELM_FLIP_PAGE_LEFT,
20095 ELM_FLIP_PAGE_RIGHT,
20099 typedef enum _Elm_Flip_Interaction
20101 ELM_FLIP_INTERACTION_NONE,
20102 ELM_FLIP_INTERACTION_ROTATE,
20103 ELM_FLIP_INTERACTION_CUBE,
20104 ELM_FLIP_INTERACTION_PAGE
20105 } Elm_Flip_Interaction;
20106 typedef enum _Elm_Flip_Direction
20108 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
20109 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
20110 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
20111 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
20112 } Elm_Flip_Direction;
20114 * @brief Add a new flip to the parent
20116 * @param parent The parent object
20117 * @return The new object or NULL if it cannot be created
20119 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20121 * @brief Set the front content of the flip widget.
20123 * @param obj The flip object
20124 * @param content The new front content object
20126 * Once the content object is set, a previously set one will be deleted.
20127 * If you want to keep that old content object, use the
20128 * elm_flip_content_front_unset() function.
20130 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20132 * @brief Set the back content of the flip widget.
20134 * @param obj The flip object
20135 * @param content The new back content object
20137 * Once the content object is set, a previously set one will be deleted.
20138 * If you want to keep that old content object, use the
20139 * elm_flip_content_back_unset() function.
20141 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20143 * @brief Get the front content used for the flip
20145 * @param obj The flip object
20146 * @return The front content object that is being used
20148 * Return the front content object which is set for this widget.
20150 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20152 * @brief Get the back content used for the flip
20154 * @param obj The flip object
20155 * @return The back content object that is being used
20157 * Return the back content object which is set for this widget.
20159 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20161 * @brief Unset the front content used for the flip
20163 * @param obj The flip object
20164 * @return The front content object that was being used
20166 * Unparent and return the front content object which was set for this widget.
20168 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20170 * @brief Unset the back content used for the flip
20172 * @param obj The flip object
20173 * @return The back content object that was being used
20175 * Unparent and return the back content object which was set for this widget.
20177 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20179 * @brief Get flip front visibility state
20181 * @param obj The flip objct
20182 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
20185 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20187 * @brief Set flip perspective
20189 * @param obj The flip object
20190 * @param foc The coordinate to set the focus on
20191 * @param x The X coordinate
20192 * @param y The Y coordinate
20194 * @warning This function currently does nothing.
20196 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
20198 * @brief Runs the flip animation
20200 * @param obj The flip object
20201 * @param mode The mode type
20203 * Flips the front and back contents using the @p mode animation. This
20204 * efectively hides the currently visible content and shows the hidden one.
20206 * There a number of possible animations to use for the flipping:
20207 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
20208 * around a horizontal axis in the middle of its height, the other content
20209 * is shown as the other side of the flip.
20210 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
20211 * around a vertical axis in the middle of its width, the other content is
20212 * shown as the other side of the flip.
20213 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
20214 * around a diagonal axis in the middle of its width, the other content is
20215 * shown as the other side of the flip.
20216 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
20217 * around a diagonal axis in the middle of its height, the other content is
20218 * shown as the other side of the flip.
20219 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
20220 * as if the flip was a cube, the other content is show as the right face of
20222 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
20223 * right as if the flip was a cube, the other content is show as the left
20224 * face of the cube.
20225 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
20226 * flip was a cube, the other content is show as the bottom face of the cube.
20227 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
20228 * the flip was a cube, the other content is show as the upper face of the
20230 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
20231 * if the flip was a book, the other content is shown as the page below that.
20232 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
20233 * as if the flip was a book, the other content is shown as the page below
20235 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
20236 * flip was a book, the other content is shown as the page below that.
20237 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
20238 * flip was a book, the other content is shown as the page below that.
20240 * @image html elm_flip.png
20241 * @image latex elm_flip.eps width=\textwidth
20243 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
20245 * @brief Set the interactive flip mode
20247 * @param obj The flip object
20248 * @param mode The interactive flip mode to use
20250 * This sets if the flip should be interactive (allow user to click and
20251 * drag a side of the flip to reveal the back page and cause it to flip).
20252 * By default a flip is not interactive. You may also need to set which
20253 * sides of the flip are "active" for flipping and how much space they use
20254 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
20255 * and elm_flip_interacton_direction_hitsize_set()
20257 * The four avilable mode of interaction are:
20258 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
20259 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
20260 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
20261 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
20263 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
20264 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20265 * happen, those can only be acheived with elm_flip_go();
20267 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
20269 * @brief Get the interactive flip mode
20271 * @param obj The flip object
20272 * @return The interactive flip mode
20274 * Returns the interactive flip mode set by elm_flip_interaction_set()
20276 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
20278 * @brief Set which directions of the flip respond to interactive flip
20280 * @param obj The flip object
20281 * @param dir The direction to change
20282 * @param enabled If that direction is enabled or not
20284 * By default all directions are disabled, so you may want to enable the
20285 * desired directions for flipping if you need interactive flipping. You must
20286 * call this function once for each direction that should be enabled.
20288 * @see elm_flip_interaction_set()
20290 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
20292 * @brief Get the enabled state of that flip direction
20294 * @param obj The flip object
20295 * @param dir The direction to check
20296 * @return If that direction is enabled or not
20298 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
20300 * @see elm_flip_interaction_set()
20302 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
20304 * @brief Set the amount of the flip that is sensitive to interactive flip
20306 * @param obj The flip object
20307 * @param dir The direction to modify
20308 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
20310 * Set the amount of the flip that is sensitive to interactive flip, with 0
20311 * representing no area in the flip and 1 representing the entire flip. There
20312 * is however a consideration to be made in that the area will never be
20313 * smaller than the finger size set(as set in your Elementary configuration).
20315 * @see elm_flip_interaction_set()
20317 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
20319 * @brief Get the amount of the flip that is sensitive to interactive flip
20321 * @param obj The flip object
20322 * @param dir The direction to check
20323 * @return The size set for that direction
20325 * Returns the amount os sensitive area set by
20326 * elm_flip_interacton_direction_hitsize_set().
20328 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
20333 /* scrolledentry */
20334 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20335 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
20336 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20337 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
20338 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20339 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20340 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20341 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20342 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20343 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20344 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20345 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
20346 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20347 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20348 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
20349 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
20350 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20351 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20352 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
20353 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
20354 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20355 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20356 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20357 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20358 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
20359 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
20360 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20361 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20362 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20363 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20364 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20365 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
20366 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
20367 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
20368 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20369 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);
20370 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20371 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20372 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);
20373 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20374 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);
20375 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
20376 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20377 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20378 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20379 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
20380 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20381 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20382 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20383 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);
20384 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);
20385 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);
20386 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);
20387 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);
20388 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);
20389 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
20390 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
20391 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
20392 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
20393 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20394 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
20395 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
20398 * @defgroup Conformant Conformant
20399 * @ingroup Elementary
20401 * @image html img/widget/conformant/preview-00.png
20402 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
20404 * @image html img/conformant.png
20405 * @image latex img/conformant.eps width=\textwidth
20407 * The aim is to provide a widget that can be used in elementary apps to
20408 * account for space taken up by the indicator, virtual keypad & softkey
20409 * windows when running the illume2 module of E17.
20411 * So conformant content will be sized and positioned considering the
20412 * space required for such stuff, and when they popup, as a keyboard
20413 * shows when an entry is selected, conformant content won't change.
20415 * Available styles for it:
20418 * See how to use this widget in this example:
20419 * @ref conformant_example
20423 * @addtogroup Conformant
20428 * Add a new conformant widget to the given parent Elementary
20429 * (container) object.
20431 * @param parent The parent object.
20432 * @return A new conformant widget handle or @c NULL, on errors.
20434 * This function inserts a new conformant widget on the canvas.
20436 * @ingroup Conformant
20438 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20441 * Set the content of the conformant widget.
20443 * @param obj The conformant object.
20444 * @param content The content to be displayed by the conformant.
20446 * Content will be sized and positioned considering the space required
20447 * to display a virtual keyboard. So it won't fill all the conformant
20448 * size. This way is possible to be sure that content won't resize
20449 * or be re-positioned after the keyboard is displayed.
20451 * Once the content object is set, a previously set one will be deleted.
20452 * If you want to keep that old content object, use the
20453 * elm_conformat_content_unset() function.
20455 * @see elm_conformant_content_unset()
20456 * @see elm_conformant_content_get()
20458 * @ingroup Conformant
20460 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20463 * Get the content of the conformant widget.
20465 * @param obj The conformant object.
20466 * @return The content that is being used.
20468 * Return the content object which is set for this widget.
20469 * It won't be unparent from conformant. For that, use
20470 * elm_conformant_content_unset().
20472 * @see elm_conformant_content_set() for more details.
20473 * @see elm_conformant_content_unset()
20475 * @ingroup Conformant
20477 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20480 * Unset the content of the conformant widget.
20482 * @param obj The conformant object.
20483 * @return The content that was being used.
20485 * Unparent and return the content object which was set for this widget.
20487 * @see elm_conformant_content_set() for more details.
20489 * @ingroup Conformant
20491 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20494 * Returns the Evas_Object that represents the content area.
20496 * @param obj The conformant object.
20497 * @return The content area of the widget.
20499 * @ingroup Conformant
20501 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20508 * @defgroup Mapbuf Mapbuf
20509 * @ingroup Elementary
20511 * @image html img/widget/mapbuf/preview-00.png
20512 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
20514 * This holds one content object and uses an Evas Map of transformation
20515 * points to be later used with this content. So the content will be
20516 * moved, resized, etc as a single image. So it will improve performance
20517 * when you have a complex interafce, with a lot of elements, and will
20518 * need to resize or move it frequently (the content object and its
20521 * See how to use this widget in this example:
20522 * @ref mapbuf_example
20526 * @addtogroup Mapbuf
20531 * Add a new mapbuf widget to the given parent Elementary
20532 * (container) object.
20534 * @param parent The parent object.
20535 * @return A new mapbuf widget handle or @c NULL, on errors.
20537 * This function inserts a new mapbuf widget on the canvas.
20541 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20544 * Set the content of the mapbuf.
20546 * @param obj The mapbuf object.
20547 * @param content The content that will be filled in this mapbuf object.
20549 * Once the content object is set, a previously set one will be deleted.
20550 * If you want to keep that old content object, use the
20551 * elm_mapbuf_content_unset() function.
20553 * To enable map, elm_mapbuf_enabled_set() should be used.
20557 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20560 * Get the content of the mapbuf.
20562 * @param obj The mapbuf object.
20563 * @return The content that is being used.
20565 * Return the content object which is set for this widget.
20567 * @see elm_mapbuf_content_set() for details.
20571 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20574 * Unset the content of the mapbuf.
20576 * @param obj The mapbuf object.
20577 * @return The content that was being used.
20579 * Unparent and return the content object which was set for this widget.
20581 * @see elm_mapbuf_content_set() for details.
20585 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20588 * Enable or disable the map.
20590 * @param obj The mapbuf object.
20591 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
20593 * This enables the map that is set or disables it. On enable, the object
20594 * geometry will be saved, and the new geometry will change (position and
20595 * size) to reflect the map geometry set.
20597 * Also, when enabled, alpha and smooth states will be used, so if the
20598 * content isn't solid, alpha should be enabled, for example, otherwise
20599 * a black retangle will fill the content.
20601 * When disabled, the stored map will be freed and geometry prior to
20602 * enabling the map will be restored.
20604 * It's disabled by default.
20606 * @see elm_mapbuf_alpha_set()
20607 * @see elm_mapbuf_smooth_set()
20611 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20614 * Get a value whether map is enabled or not.
20616 * @param obj The mapbuf object.
20617 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
20618 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20620 * @see elm_mapbuf_enabled_set() for details.
20624 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20627 * Enable or disable smooth map rendering.
20629 * @param obj The mapbuf object.
20630 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
20633 * This sets smoothing for map rendering. If the object is a type that has
20634 * its own smoothing settings, then both the smooth settings for this object
20635 * and the map must be turned off.
20637 * By default smooth maps are enabled.
20641 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
20644 * Get a value whether smooth map rendering is enabled or not.
20646 * @param obj The mapbuf object.
20647 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
20648 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20650 * @see elm_mapbuf_smooth_set() for details.
20654 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20657 * Set or unset alpha flag for map rendering.
20659 * @param obj The mapbuf object.
20660 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
20663 * This sets alpha flag for map rendering. If the object is a type that has
20664 * its own alpha settings, then this will take precedence. Only image objects
20665 * have this currently. It stops alpha blending of the map area, and is
20666 * useful if you know the object and/or all sub-objects is 100% solid.
20668 * Alpha is enabled by default.
20672 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
20675 * Get a value whether alpha blending is enabled or not.
20677 * @param obj The mapbuf object.
20678 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
20679 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20681 * @see elm_mapbuf_alpha_set() for details.
20685 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20692 * @defgroup Flipselector Flip Selector
20694 * @image html img/widget/flipselector/preview-00.png
20695 * @image latex img/widget/flipselector/preview-00.eps
20697 * A flip selector is a widget to show a set of @b text items, one
20698 * at a time, with the same sheet switching style as the @ref Clock
20699 * "clock" widget, when one changes the current displaying sheet
20700 * (thus, the "flip" in the name).
20702 * User clicks to flip sheets which are @b held for some time will
20703 * make the flip selector to flip continuosly and automatically for
20704 * the user. The interval between flips will keep growing in time,
20705 * so that it helps the user to reach an item which is distant from
20706 * the current selection.
20708 * Smart callbacks one can register to:
20709 * - @c "selected" - when the widget's selected text item is changed
20710 * - @c "overflowed" - when the widget's current selection is changed
20711 * from the first item in its list to the last
20712 * - @c "underflowed" - when the widget's current selection is changed
20713 * from the last item in its list to the first
20715 * Available styles for it:
20718 * Here is an example on its usage:
20719 * @li @ref flipselector_example
20723 * @addtogroup Flipselector
20727 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
20730 * Add a new flip selector widget to the given parent Elementary
20731 * (container) widget
20733 * @param parent The parent object
20734 * @return a new flip selector widget handle or @c NULL, on errors
20736 * This function inserts a new flip selector widget on the canvas.
20738 * @ingroup Flipselector
20740 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20743 * Programmatically select the next item of a flip selector widget
20745 * @param obj The flipselector object
20747 * @note The selection will be animated. Also, if it reaches the
20748 * end of its list of member items, it will continue with the first
20751 * @ingroup Flipselector
20753 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20756 * Programmatically select the previous item of a flip selector
20759 * @param obj The flipselector object
20761 * @note The selection will be animated. Also, if it reaches the
20762 * beginning of its list of member items, it will continue with the
20763 * last one backwards.
20765 * @ingroup Flipselector
20767 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20770 * Append a (text) item to a flip selector widget
20772 * @param obj The flipselector object
20773 * @param label The (text) label of the new item
20774 * @param func Convenience callback function to take place when
20776 * @param data Data passed to @p func, above
20777 * @return A handle to the item added or @c NULL, on errors
20779 * The widget's list of labels to show will be appended with the
20780 * given value. If the user wishes so, a callback function pointer
20781 * can be passed, which will get called when this same item is
20784 * @note The current selection @b won't be modified by appending an
20785 * element to the list.
20787 * @note The maximum length of the text label is going to be
20788 * determined <b>by the widget's theme</b>. Strings larger than
20789 * that value are going to be @b truncated.
20791 * @ingroup Flipselector
20793 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20796 * Prepend a (text) item to a flip selector widget
20798 * @param obj The flipselector object
20799 * @param label The (text) label of the new item
20800 * @param func Convenience callback function to take place when
20802 * @param data Data passed to @p func, above
20803 * @return A handle to the item added or @c NULL, on errors
20805 * The widget's list of labels to show will be prepended with the
20806 * given value. If the user wishes so, a callback function pointer
20807 * can be passed, which will get called when this same item is
20810 * @note The current selection @b won't be modified by prepending
20811 * an element to the list.
20813 * @note The maximum length of the text label is going to be
20814 * determined <b>by the widget's theme</b>. Strings larger than
20815 * that value are going to be @b truncated.
20817 * @ingroup Flipselector
20819 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20822 * Get the internal list of items in a given flip selector widget.
20824 * @param obj The flipselector object
20825 * @return The list of items (#Elm_Flipselector_Item as data) or
20826 * @c NULL on errors.
20828 * This list is @b not to be modified in any way and must not be
20829 * freed. Use the list members with functions like
20830 * elm_flipselector_item_label_set(),
20831 * elm_flipselector_item_label_get(),
20832 * elm_flipselector_item_del(),
20833 * elm_flipselector_item_selected_get(),
20834 * elm_flipselector_item_selected_set().
20836 * @warning This list is only valid until @p obj object's internal
20837 * items list is changed. It should be fetched again with another
20838 * call to this function when changes happen.
20840 * @ingroup Flipselector
20842 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20845 * Get the first item in the given flip selector widget's list of
20848 * @param obj The flipselector object
20849 * @return The first item or @c NULL, if it has no items (and on
20852 * @see elm_flipselector_item_append()
20853 * @see elm_flipselector_last_item_get()
20855 * @ingroup Flipselector
20857 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20860 * Get the last item in the given flip selector widget's list of
20863 * @param obj The flipselector object
20864 * @return The last item or @c NULL, if it has no items (and on
20867 * @see elm_flipselector_item_prepend()
20868 * @see elm_flipselector_first_item_get()
20870 * @ingroup Flipselector
20872 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20875 * Get the currently selected item in a flip selector widget.
20877 * @param obj The flipselector object
20878 * @return The selected item or @c NULL, if the widget has no items
20881 * @ingroup Flipselector
20883 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20886 * Set whether a given flip selector widget's item should be the
20887 * currently selected one.
20889 * @param item The flip selector item
20890 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
20892 * This sets whether @p item is or not the selected (thus, under
20893 * display) one. If @p item is different than one under display,
20894 * the latter will be unselected. If the @p item is set to be
20895 * unselected, on the other hand, the @b first item in the widget's
20896 * internal members list will be the new selected one.
20898 * @see elm_flipselector_item_selected_get()
20900 * @ingroup Flipselector
20902 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20905 * Get whether a given flip selector widget's item is the currently
20908 * @param item The flip selector item
20909 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
20912 * @see elm_flipselector_item_selected_set()
20914 * @ingroup Flipselector
20916 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20919 * Delete a given item from a flip selector widget.
20921 * @param item The item to delete
20923 * @ingroup Flipselector
20925 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20928 * Get the label of a given flip selector widget's item.
20930 * @param item The item to get label from
20931 * @return The text label of @p item or @c NULL, on errors
20933 * @see elm_flipselector_item_label_set()
20935 * @ingroup Flipselector
20937 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20940 * Set the label of a given flip selector widget's item.
20942 * @param item The item to set label on
20943 * @param label The text label string, in UTF-8 encoding
20945 * @see elm_flipselector_item_label_get()
20947 * @ingroup Flipselector
20949 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
20952 * Gets the item before @p item in a flip selector widget's
20953 * internal list of items.
20955 * @param item The item to fetch previous from
20956 * @return The item before the @p item, in its parent's list. If
20957 * there is no previous item for @p item or there's an
20958 * error, @c NULL is returned.
20960 * @see elm_flipselector_item_next_get()
20962 * @ingroup Flipselector
20964 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20967 * Gets the item after @p item in a flip selector widget's
20968 * internal list of items.
20970 * @param item The item to fetch next from
20971 * @return The item after the @p item, in its parent's list. If
20972 * there is no next item for @p item or there's an
20973 * error, @c NULL is returned.
20975 * @see elm_flipselector_item_next_get()
20977 * @ingroup Flipselector
20979 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20982 * Set the interval on time updates for an user mouse button hold
20983 * on a flip selector widget.
20985 * @param obj The flip selector object
20986 * @param interval The (first) interval value in seconds
20988 * This interval value is @b decreased while the user holds the
20989 * mouse pointer either flipping up or flipping doww a given flip
20992 * This helps the user to get to a given item distant from the
20993 * current one easier/faster, as it will start to flip quicker and
20994 * quicker on mouse button holds.
20996 * The calculation for the next flip interval value, starting from
20997 * the one set with this call, is the previous interval divided by
20998 * 1.05, so it decreases a little bit.
21000 * The default starting interval value for automatic flips is
21003 * @see elm_flipselector_interval_get()
21005 * @ingroup Flipselector
21007 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21010 * Get the interval on time updates for an user mouse button hold
21011 * on a flip selector widget.
21013 * @param obj The flip selector object
21014 * @return The (first) interval value, in seconds, set on it
21016 * @see elm_flipselector_interval_set() for more details
21018 * @ingroup Flipselector
21020 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21027 * @addtogroup Animator Animator
21028 * @ingroup Elementary
21030 * @brief Functions to ease creation of animations.
21032 * elm_animator is designed to provide an easy way to create animations.
21033 * Creating an animation with elm_animator is as simple as setting a
21034 * duration, an operating callback and telling it to run the animation.
21035 * However that is not the full extent of elm_animator's ability, animations
21036 * can be paused and resumed, reversed and the animation need not be linear.
21038 * To run an animation you must specify at least a duration and operation
21039 * callback, not setting any other properties will create a linear animation
21040 * that runs once and is not reversed.
21042 * @ref elm_animator_example_page_01 "This" example should make all of that
21045 * @warning elm_animator is @b not a widget.
21049 * @brief Type of curve desired for animation.
21051 * The speed in which an animation happens doesn't have to be linear, some
21052 * animations will look better if they're accelerating or decelerating, so
21053 * elm_animator provides four options in this regard:
21055 * @image html elm_animator_curve_style.png
21056 * @image latex elm_animator_curve_style.eps width=\textwidth
21057 * As can be seen in the image the speed of the animation will be:
21058 * @li ELM_ANIMATOR_CURVE_LINEAR constant
21059 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
21060 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
21061 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
21065 ELM_ANIMATOR_CURVE_LINEAR,
21066 ELM_ANIMATOR_CURVE_IN_OUT,
21067 ELM_ANIMATOR_CURVE_IN,
21068 ELM_ANIMATOR_CURVE_OUT
21069 } Elm_Animator_Curve_Style;
21070 typedef struct _Elm_Animator Elm_Animator;
21072 * Called back per loop of an elementary animators cycle
21073 * @param data user-data given to elm_animator_operation_callback_set()
21074 * @param animator the animator being run
21075 * @param double the position in the animation
21077 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
21079 * Called back when an elementary animator finishes
21080 * @param data user-data given to elm_animator_completion_callback_set()
21082 typedef void (*Elm_Animator_Completion_Cb) (void *data);
21085 * @brief Create a new animator.
21087 * @param[in] parent Parent object
21089 * The @a parent argument can be set to NULL for no parent. If a parent is set
21090 * there is no need to call elm_animator_del(), when the parent is deleted it
21091 * will delete the animator.
21092 * @deprecated Use @ref Transit instead.
21094 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
21096 * Deletes the animator freeing any resources it used. If the animator was
21097 * created with a NULL parent this must be called, otherwise it will be
21098 * automatically called when the parent is deleted.
21100 * @param[in] animator Animator object
21101 * @deprecated Use @ref Transit instead.
21103 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21105 * Set the duration of the animation.
21107 * @param[in] animator Animator object
21108 * @param[in] duration Duration in second
21109 * @deprecated Use @ref Transit instead.
21111 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
21113 * @brief Set the callback function for animator operation.
21115 * @param[in] animator Animator object
21116 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
21117 * @param[in] data Callback function user argument
21119 * The @p func callback will be called with a frame value in range [0, 1] which
21120 * indicates how far along the animation should be. It is the job of @p func to
21121 * actually change the state of any object(or objects) that are being animated.
21122 * @deprecated Use @ref Transit instead.
21124 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
21126 * Set the callback function for the when the animation ends.
21128 * @param[in] animator Animator object
21129 * @param[in] func Callback function pointe
21130 * @param[in] data Callback function user argument
21132 * @warning @a func will not be executed if elm_animator_stop() is called.
21133 * @deprecated Use @ref Transit instead.
21135 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
21137 * @brief Stop animator.
21139 * @param[in] animator Animator object
21141 * If called before elm_animator_animate() it does nothing. If there is an
21142 * animation in progress the animation will be stopped(the operation callback
21143 * will not be executed again) and it can't be restarted using
21144 * elm_animator_resume().
21145 * @deprecated Use @ref Transit instead.
21147 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21149 * Set the animator repeat count.
21151 * @param[in] animator Animator object
21152 * @param[in] repeat_cnt Repeat count
21153 * @deprecated Use @ref Transit instead.
21155 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
21157 * @brief Start animation.
21159 * @param[in] animator Animator object
21161 * This function starts the animation if the nescessary properties(duration
21162 * and operation callback) have been set. Once started the animation will
21163 * run until complete or elm_animator_stop() is called.
21164 * @deprecated Use @ref Transit instead.
21166 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21168 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21170 * @param[in] animator Animator object
21171 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21172 * @deprecated Use @ref Transit instead.
21174 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
21176 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21178 * @param[in] animator Animator object
21179 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21180 * @deprecated Use @ref Transit instead.
21182 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21184 * @brief Sets wether the animation should be automatically reversed.
21186 * @param[in] animator Animator object
21187 * @param[in] reverse Reverse or not
21189 * This controls wether the animation will be run on reverse imediately after
21190 * running forward. When this is set together with repetition the animation
21191 * will run in reverse once for each time it ran forward.@n
21192 * Runnin an animation in reverse is accomplished by calling the operation
21193 * callback with a frame value starting at 1 and diminshing until 0.
21194 * @deprecated Use @ref Transit instead.
21196 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
21198 * Gets wether the animation will automatically reversed
21200 * @param[in] animator Animator object
21201 * @deprecated Use @ref Transit instead.
21203 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21205 * Gets the status for the animator operation. The status of the animator @b
21206 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
21207 * only informs if the animation was started and has not ended(either normally
21208 * or through elm_animator_stop()).
21210 * @param[in] animator Animator object
21211 * @deprecated Use @ref Transit instead.
21213 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21215 * Gets how many times the animation will be repeated
21217 * @param[in] animator Animator object
21218 * @deprecated Use @ref Transit instead.
21220 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21222 * Pause the animator.
21224 * @param[in] animator Animator object
21226 * This causes the animation to be temporarily stopped(the operation callback
21227 * will not be called). If the animation is not yet running this is a no-op.
21228 * Once an animation has been paused with this function it can be resumed
21229 * using elm_animator_resume().
21230 * @deprecated Use @ref Transit instead.
21232 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21234 * @brief Resumes the animator.
21236 * @param[in] animator Animator object
21238 * Resumes an animation that was paused using elm_animator_pause(), after
21239 * calling this function calls to the operation callback will happen
21240 * normally. If an animation is stopped by means of elm_animator_stop it
21241 * @b can't be restarted with this function.@n
21243 * @warning When an animation is resumed it doesn't start from where it was paused, it
21244 * will go to where it would have been if it had not been paused. If an
21245 * animation with a duration of 3 seconds is paused after 1 second for 1 second
21246 * it will resume as if it had ben animating for 2 seconds, the operating
21247 * callback will be called with a frame value of aproximately 2/3.
21248 * @deprecated Use @ref Transit instead.
21250 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21256 * @defgroup Calendar Calendar
21257 * @ingroup Elementary
21259 * @image html img/widget/calendar/preview-00.png
21260 * @image latex img/widget/calendar/preview-00.eps
21262 * A calendar is a widget that displays a regular calendar, one
21263 * month at a time, to the user, and can allows the user to select a date.
21265 * It has support to adding check marks (holidays and checks are supported
21266 * by default theme).
21268 * Weekday names and the function used to format month and year to
21269 * be displayed can be set, giving more flexibility to this widget.
21271 * Smart callbacks one can register to:
21272 * - "changed" - emitted when the user selects a day or changes the
21273 * displayed month, what actually changes the selected day as well.
21275 * Available styles for it:
21278 * List of examples:
21279 * @li @ref calendar_example_01
21280 * @li @ref calendar_example_02
21281 * @li @ref calendar_example_03
21282 * @li @ref calendar_example_04
21283 * @li @ref calendar_example_05
21284 * @li @ref calendar_example_06
21288 * @addtogroup Calendar
21293 * @enum _Elm_Calendar_Mark_Repeat
21294 * @typedef Elm_Calendar_Mark_Repeat
21296 * Event periodicity, used to define if a mark should be repeated
21297 * @b beyond event's day. It's set when a mark is added.
21299 * So, for a mark added to 13th May with periodicity set to WEEKLY,
21300 * there will be marks every week after this date. Marks will be displayed
21301 * at 13th, 20th, 27th, 3rd June ...
21303 * Values don't work as bitmask, only one can be choosen.
21305 * @see elm_calendar_mark_add()
21307 * @ingroup Calendar
21309 typedef enum _Elm_Calendar_Mark_Repeat
21311 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
21312 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
21313 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
21314 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*/
21315 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. */
21316 } Elm_Calendar_Mark_Repeat;
21318 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(). */
21321 * Add a new calendar widget to the given parent Elementary
21322 * (container) object.
21324 * @param parent The parent object.
21325 * @return a new calendar widget handle or @c NULL, on errors.
21327 * This function inserts a new calendar widget on the canvas.
21329 * @ref calendar_example_01
21331 * @ingroup Calendar
21333 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21336 * Get weekdays names displayed by the calendar.
21338 * @param obj The calendar object.
21339 * @return Array of seven strings to be used as weekday names.
21341 * By default, weekdays abbreviations get from system are displayed:
21342 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21343 * The first string is related to Sunday, the second to Monday...
21345 * @see elm_calendar_weekdays_name_set()
21347 * @ref calendar_example_05
21349 * @ingroup Calendar
21351 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21354 * Set weekdays names to be displayed by the calendar.
21356 * @param obj The calendar object.
21357 * @param weekdays Array of seven strings to be used as weekday names.
21358 * @warning It must have 7 elements, or it will access invalid memory.
21359 * @warning The strings must be NULL terminated ('@\0').
21361 * By default, weekdays abbreviations get from system are displayed:
21362 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21364 * The first string should be related to Sunday, the second to Monday...
21366 * The usage should be like this:
21368 * const char *weekdays[] =
21370 * "Sunday", "Monday", "Tuesday", "Wednesday",
21371 * "Thursday", "Friday", "Saturday"
21373 * elm_calendar_weekdays_names_set(calendar, weekdays);
21376 * @see elm_calendar_weekdays_name_get()
21378 * @ref calendar_example_02
21380 * @ingroup Calendar
21382 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
21385 * Set the minimum and maximum values for the year
21387 * @param obj The calendar object
21388 * @param min The minimum year, greater than 1901;
21389 * @param max The maximum year;
21391 * Maximum must be greater than minimum, except if you don't wan't to set
21393 * Default values are 1902 and -1.
21395 * If the maximum year is a negative value, it will be limited depending
21396 * on the platform architecture (year 2037 for 32 bits);
21398 * @see elm_calendar_min_max_year_get()
21400 * @ref calendar_example_03
21402 * @ingroup Calendar
21404 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
21407 * Get the minimum and maximum values for the year
21409 * @param obj The calendar object.
21410 * @param min The minimum year.
21411 * @param max The maximum year.
21413 * Default values are 1902 and -1.
21415 * @see elm_calendar_min_max_year_get() for more details.
21417 * @ref calendar_example_05
21419 * @ingroup Calendar
21421 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
21424 * Enable or disable day selection
21426 * @param obj The calendar object.
21427 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
21430 * Enabled by default. If disabled, the user still can select months,
21431 * but not days. Selected days are highlighted on calendar.
21432 * It should be used if you won't need such selection for the widget usage.
21434 * When a day is selected, or month is changed, smart callbacks for
21435 * signal "changed" will be called.
21437 * @see elm_calendar_day_selection_enable_get()
21439 * @ref calendar_example_04
21441 * @ingroup Calendar
21443 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21446 * Get a value whether day selection is enabled or not.
21448 * @see elm_calendar_day_selection_enable_set() for details.
21450 * @param obj The calendar object.
21451 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
21452 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
21454 * @ref calendar_example_05
21456 * @ingroup Calendar
21458 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21462 * Set selected date to be highlighted on calendar.
21464 * @param obj The calendar object.
21465 * @param selected_time A @b tm struct to represent the selected date.
21467 * Set the selected date, changing the displayed month if needed.
21468 * Selected date changes when the user goes to next/previous month or
21469 * select a day pressing over it on calendar.
21471 * @see elm_calendar_selected_time_get()
21473 * @ref calendar_example_04
21475 * @ingroup Calendar
21477 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
21480 * Get selected date.
21482 * @param obj The calendar object
21483 * @param selected_time A @b tm struct to point to selected date
21484 * @return EINA_FALSE means an error ocurred and returned time shouldn't
21487 * Get date selected by the user or set by function
21488 * elm_calendar_selected_time_set().
21489 * Selected date changes when the user goes to next/previous month or
21490 * select a day pressing over it on calendar.
21492 * @see elm_calendar_selected_time_get()
21494 * @ref calendar_example_05
21496 * @ingroup Calendar
21498 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
21501 * Set a function to format the string that will be used to display
21504 * @param obj The calendar object
21505 * @param format_function Function to set the month-year string given
21506 * the selected date
21508 * By default it uses strftime with "%B %Y" format string.
21509 * It should allocate the memory that will be used by the string,
21510 * that will be freed by the widget after usage.
21511 * A pointer to the string and a pointer to the time struct will be provided.
21516 * _format_month_year(struct tm *selected_time)
21519 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
21520 * return strdup(buf);
21523 * elm_calendar_format_function_set(calendar, _format_month_year);
21526 * @ref calendar_example_02
21528 * @ingroup Calendar
21530 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
21533 * Add a new mark to the calendar
21535 * @param obj The calendar object
21536 * @param mark_type A string used to define the type of mark. It will be
21537 * emitted to the theme, that should display a related modification on these
21538 * days representation.
21539 * @param mark_time A time struct to represent the date of inclusion of the
21540 * mark. For marks that repeats it will just be displayed after the inclusion
21541 * date in the calendar.
21542 * @param repeat Repeat the event following this periodicity. Can be a unique
21543 * mark (that don't repeat), daily, weekly, monthly or annually.
21544 * @return The created mark or @p NULL upon failure.
21546 * Add a mark that will be drawn in the calendar respecting the insertion
21547 * time and periodicity. It will emit the type as signal to the widget theme.
21548 * Default theme supports "holiday" and "checked", but it can be extended.
21550 * It won't immediately update the calendar, drawing the marks.
21551 * For this, call elm_calendar_marks_draw(). However, when user selects
21552 * next or previous month calendar forces marks drawn.
21554 * Marks created with this method can be deleted with
21555 * elm_calendar_mark_del().
21559 * struct tm selected_time;
21560 * time_t current_time;
21562 * current_time = time(NULL) + 5 * 84600;
21563 * localtime_r(¤t_time, &selected_time);
21564 * elm_calendar_mark_add(cal, "holiday", selected_time,
21565 * ELM_CALENDAR_ANNUALLY);
21567 * current_time = time(NULL) + 1 * 84600;
21568 * localtime_r(¤t_time, &selected_time);
21569 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
21571 * elm_calendar_marks_draw(cal);
21574 * @see elm_calendar_marks_draw()
21575 * @see elm_calendar_mark_del()
21577 * @ref calendar_example_06
21579 * @ingroup Calendar
21581 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);
21584 * Delete mark from the calendar.
21586 * @param mark The mark to be deleted.
21588 * If deleting all calendar marks is required, elm_calendar_marks_clear()
21589 * should be used instead of getting marks list and deleting each one.
21591 * @see elm_calendar_mark_add()
21593 * @ref calendar_example_06
21595 * @ingroup Calendar
21597 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
21600 * Remove all calendar's marks
21602 * @param obj The calendar object.
21604 * @see elm_calendar_mark_add()
21605 * @see elm_calendar_mark_del()
21607 * @ingroup Calendar
21609 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21613 * Get a list of all the calendar marks.
21615 * @param obj The calendar object.
21616 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
21618 * @see elm_calendar_mark_add()
21619 * @see elm_calendar_mark_del()
21620 * @see elm_calendar_marks_clear()
21622 * @ingroup Calendar
21624 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21627 * Draw calendar marks.
21629 * @param obj The calendar object.
21631 * Should be used after adding, removing or clearing marks.
21632 * It will go through the entire marks list updating the calendar.
21633 * If lots of marks will be added, add all the marks and then call
21636 * When the month is changed, i.e. user selects next or previous month,
21637 * marks will be drawed.
21639 * @see elm_calendar_mark_add()
21640 * @see elm_calendar_mark_del()
21641 * @see elm_calendar_marks_clear()
21643 * @ref calendar_example_06
21645 * @ingroup Calendar
21647 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
21650 * Set a day text color to the same that represents Saturdays.
21652 * @param obj The calendar object.
21653 * @param pos The text position. Position is the cell counter, from left
21654 * to right, up to down. It starts on 0 and ends on 41.
21656 * @deprecated use elm_calendar_mark_add() instead like:
21659 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
21660 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21663 * @see elm_calendar_mark_add()
21665 * @ingroup Calendar
21667 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21670 * Set a day text color to the same that represents Sundays.
21672 * @param obj The calendar object.
21673 * @param pos The text position. Position is the cell counter, from left
21674 * to right, up to down. It starts on 0 and ends on 41.
21676 * @deprecated use elm_calendar_mark_add() instead like:
21679 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
21680 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21683 * @see elm_calendar_mark_add()
21685 * @ingroup Calendar
21687 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21690 * Set a day text color to the same that represents Weekdays.
21692 * @param obj The calendar object
21693 * @param pos The text position. Position is the cell counter, from left
21694 * to right, up to down. It starts on 0 and ends on 41.
21696 * @deprecated use elm_calendar_mark_add() instead like:
21699 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
21701 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
21702 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21703 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
21704 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21705 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
21706 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21707 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
21708 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21709 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
21712 * @see elm_calendar_mark_add()
21714 * @ingroup Calendar
21716 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21719 * Set the interval on time updates for an user mouse button hold
21720 * on calendar widgets' month selection.
21722 * @param obj The calendar object
21723 * @param interval The (first) interval value in seconds
21725 * This interval value is @b decreased while the user holds the
21726 * mouse pointer either selecting next or previous month.
21728 * This helps the user to get to a given month distant from the
21729 * current one easier/faster, as it will start to change quicker and
21730 * quicker on mouse button holds.
21732 * The calculation for the next change interval value, starting from
21733 * the one set with this call, is the previous interval divided by
21734 * 1.05, so it decreases a little bit.
21736 * The default starting interval value for automatic changes is
21739 * @see elm_calendar_interval_get()
21741 * @ingroup Calendar
21743 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21746 * Get the interval on time updates for an user mouse button hold
21747 * on calendar widgets' month selection.
21749 * @param obj The calendar object
21750 * @return The (first) interval value, in seconds, set on it
21752 * @see elm_calendar_interval_set() for more details
21754 * @ingroup Calendar
21756 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21763 * @defgroup Diskselector Diskselector
21764 * @ingroup Elementary
21766 * @image html img/widget/diskselector/preview-00.png
21767 * @image latex img/widget/diskselector/preview-00.eps
21769 * A diskselector is a kind of list widget. It scrolls horizontally,
21770 * and can contain label and icon objects. Three items are displayed
21771 * with the selected one in the middle.
21773 * It can act like a circular list with round mode and labels can be
21774 * reduced for a defined length for side items.
21776 * Smart callbacks one can listen to:
21777 * - "selected" - when item is selected, i.e. scroller stops.
21779 * Available styles for it:
21782 * List of examples:
21783 * @li @ref diskselector_example_01
21784 * @li @ref diskselector_example_02
21788 * @addtogroup Diskselector
21792 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(). */
21795 * Add a new diskselector widget to the given parent Elementary
21796 * (container) object.
21798 * @param parent The parent object.
21799 * @return a new diskselector widget handle or @c NULL, on errors.
21801 * This function inserts a new diskselector widget on the canvas.
21803 * @ingroup Diskselector
21805 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21808 * Enable or disable round mode.
21810 * @param obj The diskselector object.
21811 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
21814 * Disabled by default. If round mode is enabled the items list will
21815 * work like a circle list, so when the user reaches the last item,
21816 * the first one will popup.
21818 * @see elm_diskselector_round_get()
21820 * @ingroup Diskselector
21822 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
21825 * Get a value whether round mode is enabled or not.
21827 * @see elm_diskselector_round_set() for details.
21829 * @param obj The diskselector object.
21830 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
21831 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21833 * @ingroup Diskselector
21835 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21838 * Get the side labels max length.
21840 * @deprecated use elm_diskselector_side_label_length_get() instead:
21842 * @param obj The diskselector object.
21843 * @return The max length defined for side labels, or 0 if not a valid
21846 * @ingroup Diskselector
21848 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21851 * Set the side labels max length.
21853 * @deprecated use elm_diskselector_side_label_length_set() instead:
21855 * @param obj The diskselector object.
21856 * @param len The max length defined for side labels.
21858 * @ingroup Diskselector
21860 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21863 * Get the side labels max length.
21865 * @see elm_diskselector_side_label_length_set() for details.
21867 * @param obj The diskselector object.
21868 * @return The max length defined for side labels, or 0 if not a valid
21871 * @ingroup Diskselector
21873 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21876 * Set the side labels max length.
21878 * @param obj The diskselector object.
21879 * @param len The max length defined for side labels.
21881 * Length is the number of characters of items' label that will be
21882 * visible when it's set on side positions. It will just crop
21883 * the string after defined size. E.g.:
21885 * An item with label "January" would be displayed on side position as
21886 * "Jan" if max length is set to 3, or "Janu", if this property
21889 * When it's selected, the entire label will be displayed, except for
21890 * width restrictions. In this case label will be cropped and "..."
21891 * will be concatenated.
21893 * Default side label max length is 3.
21895 * This property will be applyed over all items, included before or
21896 * later this function call.
21898 * @ingroup Diskselector
21900 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21903 * Set the number of items to be displayed.
21905 * @param obj The diskselector object.
21906 * @param num The number of items the diskselector will display.
21908 * Default value is 3, and also it's the minimun. If @p num is less
21909 * than 3, it will be set to 3.
21911 * Also, it can be set on theme, using data item @c display_item_num
21912 * on group "elm/diskselector/item/X", where X is style set.
21915 * group { name: "elm/diskselector/item/X";
21917 * item: "display_item_num" "5";
21920 * @ingroup Diskselector
21922 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
21925 * Set bouncing behaviour when the scrolled content reaches an edge.
21927 * Tell the internal scroller object whether it should bounce or not
21928 * when it reaches the respective edges for each axis.
21930 * @param obj The diskselector object.
21931 * @param h_bounce Whether to bounce or not in the horizontal axis.
21932 * @param v_bounce Whether to bounce or not in the vertical axis.
21934 * @see elm_scroller_bounce_set()
21936 * @ingroup Diskselector
21938 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21941 * Get the bouncing behaviour of the internal scroller.
21943 * Get whether the internal scroller should bounce when the edge of each
21944 * axis is reached scrolling.
21946 * @param obj The diskselector object.
21947 * @param h_bounce Pointer where to store the bounce state of the horizontal
21949 * @param v_bounce Pointer where to store the bounce state of the vertical
21952 * @see elm_scroller_bounce_get()
21953 * @see elm_diskselector_bounce_set()
21955 * @ingroup Diskselector
21957 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21960 * Get the scrollbar policy.
21962 * @see elm_diskselector_scroller_policy_get() for details.
21964 * @param obj The diskselector object.
21965 * @param policy_h Pointer where to store horizontal scrollbar policy.
21966 * @param policy_v Pointer where to store vertical scrollbar policy.
21968 * @ingroup Diskselector
21970 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);
21973 * Set the scrollbar policy.
21975 * @param obj The diskselector object.
21976 * @param policy_h Horizontal scrollbar policy.
21977 * @param policy_v Vertical scrollbar policy.
21979 * This sets the scrollbar visibility policy for the given scroller.
21980 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
21981 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
21982 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
21983 * This applies respectively for the horizontal and vertical scrollbars.
21985 * The both are disabled by default, i.e., are set to
21986 * #ELM_SCROLLER_POLICY_OFF.
21988 * @ingroup Diskselector
21990 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
21993 * Remove all diskselector's items.
21995 * @param obj The diskselector object.
21997 * @see elm_diskselector_item_del()
21998 * @see elm_diskselector_item_append()
22000 * @ingroup Diskselector
22002 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22005 * Get a list of all the diskselector items.
22007 * @param obj The diskselector object.
22008 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
22009 * or @c NULL on failure.
22011 * @see elm_diskselector_item_append()
22012 * @see elm_diskselector_item_del()
22013 * @see elm_diskselector_clear()
22015 * @ingroup Diskselector
22017 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22020 * Appends a new item to the diskselector object.
22022 * @param obj The diskselector object.
22023 * @param label The label of the diskselector item.
22024 * @param icon The icon object to use at left side of the item. An
22025 * icon can be any Evas object, but usually it is an icon created
22026 * with elm_icon_add().
22027 * @param func The function to call when the item is selected.
22028 * @param data The data to associate with the item for related callbacks.
22030 * @return The created item or @c NULL upon failure.
22032 * A new item will be created and appended to the diskselector, i.e., will
22033 * be set as last item. Also, if there is no selected item, it will
22034 * be selected. This will always happens for the first appended item.
22036 * If no icon is set, label will be centered on item position, otherwise
22037 * the icon will be placed at left of the label, that will be shifted
22040 * Items created with this method can be deleted with
22041 * elm_diskselector_item_del().
22043 * Associated @p data can be properly freed when item is deleted if a
22044 * callback function is set with elm_diskselector_item_del_cb_set().
22046 * If a function is passed as argument, it will be called everytime this item
22047 * is selected, i.e., the user stops the diskselector with this
22048 * item on center position. If such function isn't needed, just passing
22049 * @c NULL as @p func is enough. The same should be done for @p data.
22051 * Simple example (with no function callback or data associated):
22053 * disk = elm_diskselector_add(win);
22054 * ic = elm_icon_add(win);
22055 * elm_icon_file_set(ic, "path/to/image", NULL);
22056 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
22057 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
22060 * @see elm_diskselector_item_del()
22061 * @see elm_diskselector_item_del_cb_set()
22062 * @see elm_diskselector_clear()
22063 * @see elm_icon_add()
22065 * @ingroup Diskselector
22067 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);
22071 * Delete them item from the diskselector.
22073 * @param it The item of diskselector to be deleted.
22075 * If deleting all diskselector items is required, elm_diskselector_clear()
22076 * should be used instead of getting items list and deleting each one.
22078 * @see elm_diskselector_clear()
22079 * @see elm_diskselector_item_append()
22080 * @see elm_diskselector_item_del_cb_set()
22082 * @ingroup Diskselector
22084 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22087 * Set the function called when a diskselector item is freed.
22089 * @param it The item to set the callback on
22090 * @param func The function called
22092 * If there is a @p func, then it will be called prior item's memory release.
22093 * That will be called with the following arguments:
22095 * @li item's Evas object;
22098 * This way, a data associated to a diskselector item could be properly
22101 * @ingroup Diskselector
22103 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22106 * Get the data associated to the item.
22108 * @param it The diskselector item
22109 * @return The data associated to @p it
22111 * The return value is a pointer to data associated to @p item when it was
22112 * created, with function elm_diskselector_item_append(). If no data
22113 * was passed as argument, it will return @c NULL.
22115 * @see elm_diskselector_item_append()
22117 * @ingroup Diskselector
22119 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22122 * Set the icon associated to the item.
22124 * @param it The diskselector item
22125 * @param icon The icon object to associate with @p it
22127 * The icon object to use at left side of the item. An
22128 * icon can be any Evas object, but usually it is an icon created
22129 * with elm_icon_add().
22131 * Once the icon object is set, a previously set one will be deleted.
22132 * @warning Setting the same icon for two items will cause the icon to
22133 * dissapear from the first item.
22135 * If an icon was passed as argument on item creation, with function
22136 * elm_diskselector_item_append(), it will be already
22137 * associated to the item.
22139 * @see elm_diskselector_item_append()
22140 * @see elm_diskselector_item_icon_get()
22142 * @ingroup Diskselector
22144 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22147 * Get the icon associated to the item.
22149 * @param it The diskselector item
22150 * @return The icon associated to @p it
22152 * The return value is a pointer to the icon associated to @p item when it was
22153 * created, with function elm_diskselector_item_append(), or later
22154 * with function elm_diskselector_item_icon_set. If no icon
22155 * was passed as argument, it will return @c NULL.
22157 * @see elm_diskselector_item_append()
22158 * @see elm_diskselector_item_icon_set()
22160 * @ingroup Diskselector
22162 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22165 * Set the label of item.
22167 * @param it The item of diskselector.
22168 * @param label The label of item.
22170 * The label to be displayed by the item.
22172 * If no icon is set, label will be centered on item position, otherwise
22173 * the icon will be placed at left of the label, that will be shifted
22176 * An item with label "January" would be displayed on side position as
22177 * "Jan" if max length is set to 3 with function
22178 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
22181 * When this @p item is selected, the entire label will be displayed,
22182 * except for width restrictions.
22183 * In this case label will be cropped and "..." will be concatenated,
22184 * but only for display purposes. It will keep the entire string, so
22185 * if diskselector is resized the remaining characters will be displayed.
22187 * If a label was passed as argument on item creation, with function
22188 * elm_diskselector_item_append(), it will be already
22189 * displayed by the item.
22191 * @see elm_diskselector_side_label_lenght_set()
22192 * @see elm_diskselector_item_label_get()
22193 * @see elm_diskselector_item_append()
22195 * @ingroup Diskselector
22197 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
22200 * Get the label of item.
22202 * @param it The item of diskselector.
22203 * @return The label of item.
22205 * The return value is a pointer to the label associated to @p item when it was
22206 * created, with function elm_diskselector_item_append(), or later
22207 * with function elm_diskselector_item_label_set. If no label
22208 * was passed as argument, it will return @c NULL.
22210 * @see elm_diskselector_item_label_set() for more details.
22211 * @see elm_diskselector_item_append()
22213 * @ingroup Diskselector
22215 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22218 * Get the selected item.
22220 * @param obj The diskselector object.
22221 * @return The selected diskselector item.
22223 * The selected item can be unselected with function
22224 * elm_diskselector_item_selected_set(), and the first item of
22225 * diskselector will be selected.
22227 * The selected item always will be centered on diskselector, with
22228 * full label displayed, i.e., max lenght set to side labels won't
22229 * apply on the selected item. More details on
22230 * elm_diskselector_side_label_length_set().
22232 * @ingroup Diskselector
22234 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22237 * Set the selected state of an item.
22239 * @param it The diskselector item
22240 * @param selected The selected state
22242 * This sets the selected state of the given item @p it.
22243 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22245 * If a new item is selected the previosly selected will be unselected.
22246 * Previoulsy selected item can be get with function
22247 * elm_diskselector_selected_item_get().
22249 * If the item @p it is unselected, the first item of diskselector will
22252 * Selected items will be visible on center position of diskselector.
22253 * So if it was on another position before selected, or was invisible,
22254 * diskselector will animate items until the selected item reaches center
22257 * @see elm_diskselector_item_selected_get()
22258 * @see elm_diskselector_selected_item_get()
22260 * @ingroup Diskselector
22262 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
22265 * Get whether the @p item is selected or not.
22267 * @param it The diskselector item.
22268 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
22269 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22271 * @see elm_diskselector_selected_item_set() for details.
22272 * @see elm_diskselector_item_selected_get()
22274 * @ingroup Diskselector
22276 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22279 * Get the first item of the diskselector.
22281 * @param obj The diskselector object.
22282 * @return The first item, or @c NULL if none.
22284 * The list of items follows append order. So it will return the first
22285 * item appended to the widget that wasn't deleted.
22287 * @see elm_diskselector_item_append()
22288 * @see elm_diskselector_items_get()
22290 * @ingroup Diskselector
22292 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22295 * Get the last item of the diskselector.
22297 * @param obj The diskselector object.
22298 * @return The last item, or @c NULL if none.
22300 * The list of items follows append order. So it will return last first
22301 * item appended to the widget that wasn't deleted.
22303 * @see elm_diskselector_item_append()
22304 * @see elm_diskselector_items_get()
22306 * @ingroup Diskselector
22308 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22311 * Get the item before @p item in diskselector.
22313 * @param it The diskselector item.
22314 * @return The item before @p item, or @c NULL if none or on failure.
22316 * The list of items follows append order. So it will return item appended
22317 * just before @p item and that wasn't deleted.
22319 * If it is the first item, @c NULL will be returned.
22320 * First item can be get by elm_diskselector_first_item_get().
22322 * @see elm_diskselector_item_append()
22323 * @see elm_diskselector_items_get()
22325 * @ingroup Diskselector
22327 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22330 * Get the item after @p item in diskselector.
22332 * @param it The diskselector item.
22333 * @return The item after @p item, or @c NULL if none or on failure.
22335 * The list of items follows append order. So it will return item appended
22336 * just after @p item and that wasn't deleted.
22338 * If it is the last item, @c NULL will be returned.
22339 * Last item can be get by elm_diskselector_last_item_get().
22341 * @see elm_diskselector_item_append()
22342 * @see elm_diskselector_items_get()
22344 * @ingroup Diskselector
22346 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22349 * Set the text to be shown in the diskselector item.
22351 * @param item Target item
22352 * @param text The text to set in the content
22354 * Setup the text as tooltip to object. The item can have only one tooltip,
22355 * so any previous tooltip data is removed.
22357 * @see elm_object_tooltip_text_set() for more details.
22359 * @ingroup Diskselector
22361 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
22364 * Set the content to be shown in the tooltip item.
22366 * Setup the tooltip to item. The item can have only one tooltip,
22367 * so any previous tooltip data is removed. @p func(with @p data) will
22368 * be called every time that need show the tooltip and it should
22369 * return a valid Evas_Object. This object is then managed fully by
22370 * tooltip system and is deleted when the tooltip is gone.
22372 * @param item the diskselector item being attached a tooltip.
22373 * @param func the function used to create the tooltip contents.
22374 * @param data what to provide to @a func as callback data/context.
22375 * @param del_cb called when data is not needed anymore, either when
22376 * another callback replaces @p func, the tooltip is unset with
22377 * elm_diskselector_item_tooltip_unset() or the owner @a item
22378 * dies. This callback receives as the first parameter the
22379 * given @a data, and @c event_info is the item.
22381 * @see elm_object_tooltip_content_cb_set() for more details.
22383 * @ingroup Diskselector
22385 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);
22388 * Unset tooltip from item.
22390 * @param item diskselector item to remove previously set tooltip.
22392 * Remove tooltip from item. The callback provided as del_cb to
22393 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
22394 * it is not used anymore.
22396 * @see elm_object_tooltip_unset() for more details.
22397 * @see elm_diskselector_item_tooltip_content_cb_set()
22399 * @ingroup Diskselector
22401 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22405 * Sets a different style for this item tooltip.
22407 * @note before you set a style you should define a tooltip with
22408 * elm_diskselector_item_tooltip_content_cb_set() or
22409 * elm_diskselector_item_tooltip_text_set()
22411 * @param item diskselector item with tooltip already set.
22412 * @param style the theme style to use (default, transparent, ...)
22414 * @see elm_object_tooltip_style_set() for more details.
22416 * @ingroup Diskselector
22418 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22421 * Get the style for this item tooltip.
22423 * @param item diskselector item with tooltip already set.
22424 * @return style the theme style in use, defaults to "default". If the
22425 * object does not have a tooltip set, then NULL is returned.
22427 * @see elm_object_tooltip_style_get() for more details.
22428 * @see elm_diskselector_item_tooltip_style_set()
22430 * @ingroup Diskselector
22432 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22435 * Set the cursor to be shown when mouse is over the diskselector item
22437 * @param item Target item
22438 * @param cursor the cursor name to be used.
22440 * @see elm_object_cursor_set() for more details.
22442 * @ingroup Diskselector
22444 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
22447 * Get the cursor to be shown when mouse is over the diskselector item
22449 * @param item diskselector item with cursor already set.
22450 * @return the cursor name.
22452 * @see elm_object_cursor_get() for more details.
22453 * @see elm_diskselector_cursor_set()
22455 * @ingroup Diskselector
22457 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22461 * Unset the cursor to be shown when mouse is over the diskselector item
22463 * @param item Target item
22465 * @see elm_object_cursor_unset() for more details.
22466 * @see elm_diskselector_cursor_set()
22468 * @ingroup Diskselector
22470 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22473 * Sets a different style for this item cursor.
22475 * @note before you set a style you should define a cursor with
22476 * elm_diskselector_item_cursor_set()
22478 * @param item diskselector item with cursor already set.
22479 * @param style the theme style to use (default, transparent, ...)
22481 * @see elm_object_cursor_style_set() for more details.
22483 * @ingroup Diskselector
22485 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22489 * Get the style for this item cursor.
22491 * @param item diskselector item with cursor already set.
22492 * @return style the theme style in use, defaults to "default". If the
22493 * object does not have a cursor set, then @c NULL is returned.
22495 * @see elm_object_cursor_style_get() for more details.
22496 * @see elm_diskselector_item_cursor_style_set()
22498 * @ingroup Diskselector
22500 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22504 * Set if the cursor set should be searched on the theme or should use
22505 * the provided by the engine, only.
22507 * @note before you set if should look on theme you should define a cursor
22508 * with elm_diskselector_item_cursor_set().
22509 * By default it will only look for cursors provided by the engine.
22511 * @param item widget item with cursor already set.
22512 * @param engine_only boolean to define if cursors set with
22513 * elm_diskselector_item_cursor_set() should be searched only
22514 * between cursors provided by the engine or searched on widget's
22517 * @see elm_object_cursor_engine_only_set() for more details.
22519 * @ingroup Diskselector
22521 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
22524 * Get the cursor engine only usage for this item cursor.
22526 * @param item widget item with cursor already set.
22527 * @return engine_only boolean to define it cursors should be looked only
22528 * between the provided by the engine or searched on widget's theme as well.
22529 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
22531 * @see elm_object_cursor_engine_only_get() for more details.
22532 * @see elm_diskselector_item_cursor_engine_only_set()
22534 * @ingroup Diskselector
22536 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22543 * @defgroup Colorselector Colorselector
22547 * @image html img/widget/colorselector/preview-00.png
22549 * @brief Widget for user to select a color.
22551 * Signals that you can add callbacks for are:
22552 * "changed" - When the color value changes(event_info is NULL).
22554 * See @ref tutorial_colorselector.
22557 * @brief Add a new colorselector to the parent
22559 * @param parent The parent object
22560 * @return The new object or NULL if it cannot be created
22562 * @ingroup Colorselector
22564 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22566 * Set a color for the colorselector
22568 * @param obj Colorselector object
22569 * @param r r-value of color
22570 * @param g g-value of color
22571 * @param b b-value of color
22572 * @param a a-value of color
22574 * @ingroup Colorselector
22576 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22578 * Get a color from the colorselector
22580 * @param obj Colorselector object
22581 * @param r integer pointer for r-value of color
22582 * @param g integer pointer for g-value of color
22583 * @param b integer pointer for b-value of color
22584 * @param a integer pointer for a-value of color
22586 * @ingroup Colorselector
22588 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22594 * @defgroup Ctxpopup Ctxpopup
22596 * @image html img/widget/ctxpopup/preview-00.png
22597 * @image latex img/widget/ctxpopup/preview-00.eps
22599 * @brief Context popup widet.
22601 * A ctxpopup is a widget that, when shown, pops up a list of items.
22602 * It automatically chooses an area inside its parent object's view
22603 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
22604 * optimally fit into it. In the default theme, it will also point an
22605 * arrow to it's top left position at the time one shows it. Ctxpopup
22606 * items have a label and/or an icon. It is intended for a small
22607 * number of items (hence the use of list, not genlist).
22609 * @note Ctxpopup is a especialization of @ref Hover.
22611 * Signals that you can add callbacks for are:
22612 * "dismissed" - the ctxpopup was dismissed
22614 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
22617 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
22619 typedef enum _Elm_Ctxpopup_Direction
22621 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
22623 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
22624 the clicked area */
22625 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
22626 the clicked area */
22627 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
22629 } Elm_Ctxpopup_Direction;
22632 * @brief Add a new Ctxpopup object to the parent.
22634 * @param parent Parent object
22635 * @return New object or @c NULL, if it cannot be created
22637 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22639 * @brief Set the Ctxpopup's parent
22641 * @param obj The ctxpopup object
22642 * @param area The parent to use
22644 * Set the parent object.
22646 * @note elm_ctxpopup_add() will automatically call this function
22647 * with its @c parent argument.
22649 * @see elm_ctxpopup_add()
22650 * @see elm_hover_parent_set()
22652 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
22654 * @brief Get the Ctxpopup's parent
22656 * @param obj The ctxpopup object
22658 * @see elm_ctxpopup_hover_parent_set() for more information
22660 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22662 * @brief Clear all items in the given ctxpopup object.
22664 * @param obj Ctxpopup object
22666 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22668 * @brief Change the ctxpopup's orientation to horizontal or vertical.
22670 * @param obj Ctxpopup object
22671 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
22673 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22675 * @brief Get the value of current ctxpopup object's orientation.
22677 * @param obj Ctxpopup object
22678 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
22680 * @see elm_ctxpopup_horizontal_set()
22682 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22684 * @brief Add a new item to a ctxpopup object.
22686 * @param obj Ctxpopup object
22687 * @param icon Icon to be set on new item
22688 * @param label The Label of the new item
22689 * @param func Convenience function called when item selected
22690 * @param data Data passed to @p func
22691 * @return A handle to the item added or @c NULL, on errors
22693 * @warning Ctxpopup can't hold both an item list and a content at the same
22694 * time. When an item is added, any previous content will be removed.
22696 * @see elm_ctxpopup_content_set()
22698 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);
22700 * @brief Delete the given item in a ctxpopup object.
22702 * @param item Ctxpopup item to be deleted
22704 * @see elm_ctxpopup_item_append()
22706 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22708 * @brief Set the ctxpopup item's state as disabled or enabled.
22710 * @param item Ctxpopup item to be enabled/disabled
22711 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
22713 * When disabled the item is greyed out to indicate it's state.
22715 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22717 * @brief Get the ctxpopup item's disabled/enabled state.
22719 * @param item Ctxpopup item to be enabled/disabled
22720 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
22722 * @see elm_ctxpopup_item_disabled_set()
22724 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22726 * @brief Get the icon object for the given ctxpopup item.
22728 * @param item Ctxpopup item
22729 * @return icon object or @c NULL, if the item does not have icon or an error
22732 * @see elm_ctxpopup_item_append()
22733 * @see elm_ctxpopup_item_icon_set()
22735 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22737 * @brief Sets the side icon associated with the ctxpopup item
22739 * @param item Ctxpopup item
22740 * @param icon Icon object to be set
22742 * Once the icon object is set, a previously set one will be deleted.
22743 * @warning Setting the same icon for two items will cause the icon to
22744 * dissapear from the first item.
22746 * @see elm_ctxpopup_item_append()
22748 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22750 * @brief Get the label for the given ctxpopup item.
22752 * @param item Ctxpopup item
22753 * @return label string or @c NULL, if the item does not have label or an
22756 * @see elm_ctxpopup_item_append()
22757 * @see elm_ctxpopup_item_label_set()
22759 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22761 * @brief (Re)set the label on the given ctxpopup item.
22763 * @param item Ctxpopup item
22764 * @param label String to set as label
22766 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
22768 * @brief Set an elm widget as the content of the ctxpopup.
22770 * @param obj Ctxpopup object
22771 * @param content Content to be swallowed
22773 * If the content object is already set, a previous one will bedeleted. If
22774 * you want to keep that old content object, use the
22775 * elm_ctxpopup_content_unset() function.
22777 * @deprecated use elm_object_content_set()
22779 * @warning Ctxpopup can't hold both a item list and a content at the same
22780 * time. When a content is set, any previous items will be removed.
22782 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
22784 * @brief Unset the ctxpopup content
22786 * @param obj Ctxpopup object
22787 * @return The content that was being used
22789 * Unparent and return the content object which was set for this widget.
22791 * @deprecated use elm_object_content_unset()
22793 * @see elm_ctxpopup_content_set()
22795 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22797 * @brief Set the direction priority of a ctxpopup.
22799 * @param obj Ctxpopup object
22800 * @param first 1st priority of direction
22801 * @param second 2nd priority of direction
22802 * @param third 3th priority of direction
22803 * @param fourth 4th priority of direction
22805 * This functions gives a chance to user to set the priority of ctxpopup
22806 * showing direction. This doesn't guarantee the ctxpopup will appear in the
22807 * requested direction.
22809 * @see Elm_Ctxpopup_Direction
22811 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);
22813 * @brief Get the direction priority of a ctxpopup.
22815 * @param obj Ctxpopup object
22816 * @param first 1st priority of direction to be returned
22817 * @param second 2nd priority of direction to be returned
22818 * @param third 3th priority of direction to be returned
22819 * @param fourth 4th priority of direction to be returned
22821 * @see elm_ctxpopup_direction_priority_set() for more information.
22823 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);
22831 * @defgroup Transit Transit
22832 * @ingroup Elementary
22834 * Transit is designed to apply various animated transition effects to @c
22835 * Evas_Object, such like translation, rotation, etc. For using these
22836 * effects, create an @ref Elm_Transit and add the desired transition effects.
22838 * Once the effects are added into transit, they will be automatically
22839 * managed (their callback will be called until the duration is ended, and
22840 * they will be deleted on completion).
22844 * Elm_Transit *trans = elm_transit_add();
22845 * elm_transit_object_add(trans, obj);
22846 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
22847 * elm_transit_duration_set(transit, 1);
22848 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
22849 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22850 * elm_transit_repeat_times_set(transit, 3);
22853 * Some transition effects are used to change the properties of objects. They
22855 * @li @ref elm_transit_effect_translation_add
22856 * @li @ref elm_transit_effect_color_add
22857 * @li @ref elm_transit_effect_rotation_add
22858 * @li @ref elm_transit_effect_wipe_add
22859 * @li @ref elm_transit_effect_zoom_add
22860 * @li @ref elm_transit_effect_resizing_add
22862 * Other transition effects are used to make one object disappear and another
22863 * object appear on its old place. These effects are:
22865 * @li @ref elm_transit_effect_flip_add
22866 * @li @ref elm_transit_effect_resizable_flip_add
22867 * @li @ref elm_transit_effect_fade_add
22868 * @li @ref elm_transit_effect_blend_add
22870 * It's also possible to make a transition chain with @ref
22871 * elm_transit_chain_transit_add.
22873 * @warning We strongly recommend to use elm_transit just when edje can not do
22874 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
22875 * animations can be manipulated inside the theme.
22877 * List of examples:
22878 * @li @ref transit_example_01_explained
22879 * @li @ref transit_example_02_explained
22880 * @li @ref transit_example_03_c
22881 * @li @ref transit_example_04_c
22887 * @enum Elm_Transit_Tween_Mode
22889 * The type of acceleration used in the transition.
22893 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
22894 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
22895 over time, then decrease again
22897 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
22899 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
22901 } Elm_Transit_Tween_Mode;
22904 * @enum Elm_Transit_Effect_Flip_Axis
22906 * The axis where flip effect should be applied.
22910 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
22911 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
22912 } Elm_Transit_Effect_Flip_Axis;
22914 * @enum Elm_Transit_Effect_Wipe_Dir
22916 * The direction where the wipe effect should occur.
22920 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
22921 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
22922 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
22923 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
22924 } Elm_Transit_Effect_Wipe_Dir;
22925 /** @enum Elm_Transit_Effect_Wipe_Type
22927 * Whether the wipe effect should show or hide the object.
22931 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
22933 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
22935 } Elm_Transit_Effect_Wipe_Type;
22938 * @typedef Elm_Transit
22940 * The Transit created with elm_transit_add(). This type has the information
22941 * about the objects which the transition will be applied, and the
22942 * transition effects that will be used. It also contains info about
22943 * duration, number of repetitions, auto-reverse, etc.
22945 typedef struct _Elm_Transit Elm_Transit;
22946 typedef void Elm_Transit_Effect;
22948 * @typedef Elm_Transit_Effect_Transition_Cb
22950 * Transition callback called for this effect on each transition iteration.
22952 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
22954 * Elm_Transit_Effect_End_Cb
22956 * Transition callback called for this effect when the transition is over.
22958 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
22961 * Elm_Transit_Del_Cb
22963 * A callback called when the transit is deleted.
22965 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
22970 * @note Is not necessary to delete the transit object, it will be deleted at
22971 * the end of its operation.
22972 * @note The transit will start playing when the program enter in the main loop, is not
22973 * necessary to give a start to the transit.
22975 * @return The transit object.
22979 EAPI Elm_Transit *elm_transit_add(void);
22982 * Stops the animation and delete the @p transit object.
22984 * Call this function if you wants to stop the animation before the duration
22985 * time. Make sure the @p transit object is still alive with
22986 * elm_transit_del_cb_set() function.
22987 * All added effects will be deleted, calling its repective data_free_cb
22988 * functions. The function setted by elm_transit_del_cb_set() will be called.
22990 * @see elm_transit_del_cb_set()
22992 * @param transit The transit object to be deleted.
22995 * @warning Just call this function if you are sure the transit is alive.
22997 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23000 * Add a new effect to the transit.
23002 * @note The cb function and the data are the key to the effect. If you try to
23003 * add an already added effect, nothing is done.
23004 * @note After the first addition of an effect in @p transit, if its
23005 * effect list become empty again, the @p transit will be killed by
23006 * elm_transit_del(transit) function.
23010 * Elm_Transit *transit = elm_transit_add();
23011 * elm_transit_effect_add(transit,
23012 * elm_transit_effect_blend_op,
23013 * elm_transit_effect_blend_context_new(),
23014 * elm_transit_effect_blend_context_free);
23017 * @param transit The transit object.
23018 * @param transition_cb The operation function. It is called when the
23019 * animation begins, it is the function that actually performs the animation.
23020 * It is called with the @p data, @p transit and the time progression of the
23021 * animation (a double value between 0.0 and 1.0).
23022 * @param effect The context data of the effect.
23023 * @param end_cb The function to free the context data, it will be called
23024 * at the end of the effect, it must finalize the animation and free the
23028 * @warning The transit free the context data at the and of the transition with
23029 * the data_free_cb function, do not use the context data in another transit.
23031 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);
23034 * Delete an added effect.
23036 * This function will remove the effect from the @p transit, calling the
23037 * data_free_cb to free the @p data.
23039 * @see elm_transit_effect_add()
23041 * @note If the effect is not found, nothing is done.
23042 * @note If the effect list become empty, this function will call
23043 * elm_transit_del(transit), that is, it will kill the @p transit.
23045 * @param transit The transit object.
23046 * @param transition_cb The operation function.
23047 * @param effect The context data of the effect.
23051 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);
23054 * Add new object to apply the effects.
23056 * @note After the first addition of an object in @p transit, if its
23057 * object list become empty again, the @p transit will be killed by
23058 * elm_transit_del(transit) function.
23059 * @note If the @p obj belongs to another transit, the @p obj will be
23060 * removed from it and it will only belong to the @p transit. If the old
23061 * transit stays without objects, it will die.
23062 * @note When you add an object into the @p transit, its state from
23063 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23064 * transit ends, if you change this state whith evas_object_pass_events_set()
23065 * after add the object, this state will change again when @p transit stops to
23068 * @param transit The transit object.
23069 * @param obj Object to be animated.
23072 * @warning It is not allowed to add a new object after transit begins to go.
23074 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23077 * Removes an added object from the transit.
23079 * @note If the @p obj is not in the @p transit, nothing is done.
23080 * @note If the list become empty, this function will call
23081 * elm_transit_del(transit), that is, it will kill the @p transit.
23083 * @param transit The transit object.
23084 * @param obj Object to be removed from @p transit.
23087 * @warning It is not allowed to remove objects after transit begins to go.
23089 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23092 * Get the objects of the transit.
23094 * @param transit The transit object.
23095 * @return a Eina_List with the objects from the transit.
23099 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23102 * Enable/disable keeping up the objects states.
23103 * If it is not kept, the objects states will be reset when transition ends.
23105 * @note @p transit can not be NULL.
23106 * @note One state includes geometry, color, map data.
23108 * @param transit The transit object.
23109 * @param state_keep Keeping or Non Keeping.
23113 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
23116 * Get a value whether the objects states will be reset or not.
23118 * @note @p transit can not be NULL
23120 * @see elm_transit_objects_final_state_keep_set()
23122 * @param transit The transit object.
23123 * @return EINA_TRUE means the states of the objects will be reset.
23124 * If @p transit is NULL, EINA_FALSE is returned
23128 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23131 * Set the event enabled when transit is operating.
23133 * If @p enabled is EINA_TRUE, the objects of the transit will receives
23134 * events from mouse and keyboard during the animation.
23135 * @note When you add an object with elm_transit_object_add(), its state from
23136 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23137 * transit ends, if you change this state with evas_object_pass_events_set()
23138 * after adding the object, this state will change again when @p transit stops
23141 * @param transit The transit object.
23142 * @param enabled Events are received when enabled is @c EINA_TRUE, and
23143 * ignored otherwise.
23147 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23150 * Get the value of event enabled status.
23152 * @see elm_transit_event_enabled_set()
23154 * @param transit The Transit object
23155 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
23156 * EINA_FALSE is returned
23160 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23163 * Set the user-callback function when the transit is deleted.
23165 * @note Using this function twice will overwrite the first function setted.
23166 * @note the @p transit object will be deleted after call @p cb function.
23168 * @param transit The transit object.
23169 * @param cb Callback function pointer. This function will be called before
23170 * the deletion of the transit.
23171 * @param data Callback funtion user data. It is the @p op parameter.
23175 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
23178 * Set reverse effect automatically.
23180 * If auto reverse is setted, after running the effects with the progress
23181 * parameter from 0 to 1, it will call the effecs again with the progress
23182 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
23183 * where the duration was setted with the function elm_transit_add and
23184 * the repeat with the function elm_transit_repeat_times_set().
23186 * @param transit The transit object.
23187 * @param reverse EINA_TRUE means the auto_reverse is on.
23191 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
23194 * Get if the auto reverse is on.
23196 * @see elm_transit_auto_reverse_set()
23198 * @param transit The transit object.
23199 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
23200 * EINA_FALSE is returned
23204 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23207 * Set the transit repeat count. Effect will be repeated by repeat count.
23209 * This function sets the number of repetition the transit will run after
23210 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
23211 * If the @p repeat is a negative number, it will repeat infinite times.
23213 * @note If this function is called during the transit execution, the transit
23214 * will run @p repeat times, ignoring the times it already performed.
23216 * @param transit The transit object
23217 * @param repeat Repeat count
23221 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
23224 * Get the transit repeat count.
23226 * @see elm_transit_repeat_times_set()
23228 * @param transit The Transit object.
23229 * @return The repeat count. If @p transit is NULL
23234 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23237 * Set the transit animation acceleration type.
23239 * This function sets the tween mode of the transit that can be:
23240 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
23241 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
23242 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
23243 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
23245 * @param transit The transit object.
23246 * @param tween_mode The tween type.
23250 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
23253 * Get the transit animation acceleration type.
23255 * @note @p transit can not be NULL
23257 * @param transit The transit object.
23258 * @return The tween type. If @p transit is NULL
23259 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
23263 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23266 * Set the transit animation time
23268 * @note @p transit can not be NULL
23270 * @param transit The transit object.
23271 * @param duration The animation time.
23275 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
23278 * Get the transit animation time
23280 * @note @p transit can not be NULL
23282 * @param transit The transit object.
23284 * @return The transit animation time.
23288 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23291 * Starts the transition.
23292 * Once this API is called, the transit begins to measure the time.
23294 * @note @p transit can not be NULL
23296 * @param transit The transit object.
23300 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23303 * Pause/Resume the transition.
23305 * If you call elm_transit_go again, the transit will be started from the
23306 * beginning, and will be unpaused.
23308 * @note @p transit can not be NULL
23310 * @param transit The transit object.
23311 * @param paused Whether the transition should be paused or not.
23315 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
23318 * Get the value of paused status.
23320 * @see elm_transit_paused_set()
23322 * @note @p transit can not be NULL
23324 * @param transit The transit object.
23325 * @return EINA_TRUE means transition is paused. If @p transit is NULL
23326 * EINA_FALSE is returned
23330 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23333 * Get the time progression of the animation (a double value between 0.0 and 1.0).
23335 * The value returned is a fraction (current time / total time). It
23336 * represents the progression position relative to the total.
23338 * @note @p transit can not be NULL
23340 * @param transit The transit object.
23342 * @return The time progression value. If @p transit is NULL
23347 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23350 * Makes the chain relationship between two transits.
23352 * @note @p transit can not be NULL. Transit would have multiple chain transits.
23353 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
23355 * @param transit The transit object.
23356 * @param chain_transit The chain transit object. This transit will be operated
23357 * after transit is done.
23359 * This function adds @p chain_transit transition to a chain after the @p
23360 * transit, and will be started as soon as @p transit ends. See @ref
23361 * transit_example_02_explained for a full example.
23365 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
23368 * Cut off the chain relationship between two transits.
23370 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
23371 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
23373 * @param transit The transit object.
23374 * @param chain_transit The chain transit object.
23376 * This function remove the @p chain_transit transition from the @p transit.
23380 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
23383 * Get the current chain transit list.
23385 * @note @p transit can not be NULL.
23387 * @param transit The transit object.
23388 * @return chain transit list.
23392 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
23395 * Add the Resizing Effect to Elm_Transit.
23397 * @note This API is one of the facades. It creates resizing effect context
23398 * and add it's required APIs to elm_transit_effect_add.
23400 * @see elm_transit_effect_add()
23402 * @param transit Transit object.
23403 * @param from_w Object width size when effect begins.
23404 * @param from_h Object height size when effect begins.
23405 * @param to_w Object width size when effect ends.
23406 * @param to_h Object height size when effect ends.
23407 * @return Resizing effect context data.
23411 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);
23414 * Add the Translation Effect to Elm_Transit.
23416 * @note This API is one of the facades. It creates translation effect context
23417 * and add it's required APIs to elm_transit_effect_add.
23419 * @see elm_transit_effect_add()
23421 * @param transit Transit object.
23422 * @param from_dx X Position variation when effect begins.
23423 * @param from_dy Y Position variation when effect begins.
23424 * @param to_dx X Position variation when effect ends.
23425 * @param to_dy Y Position variation when effect ends.
23426 * @return Translation effect context data.
23429 * @warning It is highly recommended just create a transit with this effect when
23430 * the window that the objects of the transit belongs has already been created.
23431 * This is because this effect needs the geometry information about the objects,
23432 * and if the window was not created yet, it can get a wrong information.
23434 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);
23437 * Add the Zoom Effect to Elm_Transit.
23439 * @note This API is one of the facades. It creates zoom effect context
23440 * and add it's required APIs to elm_transit_effect_add.
23442 * @see elm_transit_effect_add()
23444 * @param transit Transit object.
23445 * @param from_rate Scale rate when effect begins (1 is current rate).
23446 * @param to_rate Scale rate when effect ends.
23447 * @return Zoom effect context data.
23450 * @warning It is highly recommended just create a transit with this effect when
23451 * the window that the objects of the transit belongs has already been created.
23452 * This is because this effect needs the geometry information about the objects,
23453 * and if the window was not created yet, it can get a wrong information.
23455 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
23458 * Add the Flip Effect to Elm_Transit.
23460 * @note This API is one of the facades. It creates flip effect context
23461 * and add it's required APIs to elm_transit_effect_add.
23462 * @note This effect is applied to each pair of objects in the order they are listed
23463 * in the transit list of objects. The first object in the pair will be the
23464 * "front" object and the second will be the "back" object.
23466 * @see elm_transit_effect_add()
23468 * @param transit Transit object.
23469 * @param axis Flipping Axis(X or Y).
23470 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23471 * @return Flip effect context data.
23474 * @warning It is highly recommended just create a transit with this effect when
23475 * the window that the objects of the transit belongs has already been created.
23476 * This is because this effect needs the geometry information about the objects,
23477 * and if the window was not created yet, it can get a wrong information.
23479 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23482 * Add the Resizable Flip Effect to Elm_Transit.
23484 * @note This API is one of the facades. It creates resizable flip effect context
23485 * and add it's required APIs to elm_transit_effect_add.
23486 * @note This effect is applied to each pair of objects in the order they are listed
23487 * in the transit list of objects. The first object in the pair will be the
23488 * "front" object and the second will be the "back" object.
23490 * @see elm_transit_effect_add()
23492 * @param transit Transit object.
23493 * @param axis Flipping Axis(X or Y).
23494 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23495 * @return Resizable flip effect context data.
23498 * @warning It is highly recommended just create a transit with this effect when
23499 * the window that the objects of the transit belongs has already been created.
23500 * This is because this effect needs the geometry information about the objects,
23501 * and if the window was not created yet, it can get a wrong information.
23503 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23506 * Add the Wipe Effect to Elm_Transit.
23508 * @note This API is one of the facades. It creates wipe effect context
23509 * and add it's required APIs to elm_transit_effect_add.
23511 * @see elm_transit_effect_add()
23513 * @param transit Transit object.
23514 * @param type Wipe type. Hide or show.
23515 * @param dir Wipe Direction.
23516 * @return Wipe effect context data.
23519 * @warning It is highly recommended just create a transit with this effect when
23520 * the window that the objects of the transit belongs has already been created.
23521 * This is because this effect needs the geometry information about the objects,
23522 * and if the window was not created yet, it can get a wrong information.
23524 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
23527 * Add the Color Effect to Elm_Transit.
23529 * @note This API is one of the facades. It creates color effect context
23530 * and add it's required APIs to elm_transit_effect_add.
23532 * @see elm_transit_effect_add()
23534 * @param transit Transit object.
23535 * @param from_r RGB R when effect begins.
23536 * @param from_g RGB G when effect begins.
23537 * @param from_b RGB B when effect begins.
23538 * @param from_a RGB A when effect begins.
23539 * @param to_r RGB R when effect ends.
23540 * @param to_g RGB G when effect ends.
23541 * @param to_b RGB B when effect ends.
23542 * @param to_a RGB A when effect ends.
23543 * @return Color effect context data.
23547 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);
23550 * Add the Fade Effect to Elm_Transit.
23552 * @note This API is one of the facades. It creates fade effect context
23553 * and add it's required APIs to elm_transit_effect_add.
23554 * @note This effect is applied to each pair of objects in the order they are listed
23555 * in the transit list of objects. The first object in the pair will be the
23556 * "before" object and the second will be the "after" object.
23558 * @see elm_transit_effect_add()
23560 * @param transit Transit object.
23561 * @return Fade effect context data.
23564 * @warning It is highly recommended just create a transit with this effect when
23565 * the window that the objects of the transit belongs has already been created.
23566 * This is because this effect needs the color information about the objects,
23567 * and if the window was not created yet, it can get a wrong information.
23569 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
23572 * Add the Blend Effect to Elm_Transit.
23574 * @note This API is one of the facades. It creates blend effect context
23575 * and add it's required APIs to elm_transit_effect_add.
23576 * @note This effect is applied to each pair of objects in the order they are listed
23577 * in the transit list of objects. The first object in the pair will be the
23578 * "before" object and the second will be the "after" object.
23580 * @see elm_transit_effect_add()
23582 * @param transit Transit object.
23583 * @return Blend effect context data.
23586 * @warning It is highly recommended just create a transit with this effect when
23587 * the window that the objects of the transit belongs has already been created.
23588 * This is because this effect needs the color information about the objects,
23589 * and if the window was not created yet, it can get a wrong information.
23591 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
23594 * Add the Rotation Effect to Elm_Transit.
23596 * @note This API is one of the facades. It creates rotation effect context
23597 * and add it's required APIs to elm_transit_effect_add.
23599 * @see elm_transit_effect_add()
23601 * @param transit Transit object.
23602 * @param from_degree Degree when effect begins.
23603 * @param to_degree Degree when effect is ends.
23604 * @return Rotation effect context data.
23607 * @warning It is highly recommended just create a transit with this effect when
23608 * the window that the objects of the transit belongs has already been created.
23609 * This is because this effect needs the geometry information about the objects,
23610 * and if the window was not created yet, it can get a wrong information.
23612 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
23615 * Add the ImageAnimation Effect to Elm_Transit.
23617 * @note This API is one of the facades. It creates image animation effect context
23618 * and add it's required APIs to elm_transit_effect_add.
23619 * The @p images parameter is a list images paths. This list and
23620 * its contents will be deleted at the end of the effect by
23621 * elm_transit_effect_image_animation_context_free() function.
23625 * char buf[PATH_MAX];
23626 * Eina_List *images = NULL;
23627 * Elm_Transit *transi = elm_transit_add();
23629 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
23630 * images = eina_list_append(images, eina_stringshare_add(buf));
23632 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
23633 * images = eina_list_append(images, eina_stringshare_add(buf));
23634 * elm_transit_effect_image_animation_add(transi, images);
23638 * @see elm_transit_effect_add()
23640 * @param transit Transit object.
23641 * @param images Eina_List of images file paths. This list and
23642 * its contents will be deleted at the end of the effect by
23643 * elm_transit_effect_image_animation_context_free() function.
23644 * @return Image Animation effect context data.
23648 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
23653 typedef struct _Elm_Store Elm_Store;
23654 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
23655 typedef struct _Elm_Store_Item Elm_Store_Item;
23656 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
23657 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
23658 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
23659 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
23660 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
23661 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
23662 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
23663 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
23665 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
23666 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
23667 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
23668 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
23672 ELM_STORE_ITEM_MAPPING_NONE = 0,
23673 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
23674 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
23675 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
23676 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
23677 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
23678 // can add more here as needed by common apps
23679 ELM_STORE_ITEM_MAPPING_LAST
23680 } Elm_Store_Item_Mapping_Type;
23682 struct _Elm_Store_Item_Mapping_Icon
23684 // FIXME: allow edje file icons
23686 Elm_Icon_Lookup_Order lookup_order;
23687 Eina_Bool standard_name : 1;
23688 Eina_Bool no_scale : 1;
23689 Eina_Bool smooth : 1;
23690 Eina_Bool scale_up : 1;
23691 Eina_Bool scale_down : 1;
23694 struct _Elm_Store_Item_Mapping_Empty
23699 struct _Elm_Store_Item_Mapping_Photo
23704 struct _Elm_Store_Item_Mapping_Custom
23706 Elm_Store_Item_Mapping_Cb func;
23709 struct _Elm_Store_Item_Mapping
23711 Elm_Store_Item_Mapping_Type type;
23716 Elm_Store_Item_Mapping_Empty empty;
23717 Elm_Store_Item_Mapping_Icon icon;
23718 Elm_Store_Item_Mapping_Photo photo;
23719 Elm_Store_Item_Mapping_Custom custom;
23720 // add more types here
23724 struct _Elm_Store_Item_Info
23726 Elm_Genlist_Item_Class *item_class;
23727 const Elm_Store_Item_Mapping *mapping;
23732 struct _Elm_Store_Item_Info_Filesystem
23734 Elm_Store_Item_Info base;
23738 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
23739 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
23741 EAPI void elm_store_free(Elm_Store *st);
23743 EAPI Elm_Store *elm_store_filesystem_new(void);
23744 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
23745 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23746 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23748 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
23750 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
23751 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23752 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23753 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23754 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
23755 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23757 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23758 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
23759 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23760 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
23761 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23762 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23763 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23766 * @defgroup SegmentControl SegmentControl
23767 * @ingroup Elementary
23769 * @image html img/widget/segment_control/preview-00.png
23770 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
23772 * @image html img/segment_control.png
23773 * @image latex img/segment_control.eps width=\textwidth
23775 * Segment control widget is a horizontal control made of multiple segment
23776 * items, each segment item functioning similar to discrete two state button.
23777 * A segment control groups the items together and provides compact
23778 * single button with multiple equal size segments.
23780 * Segment item size is determined by base widget
23781 * size and the number of items added.
23782 * Only one segment item can be at selected state. A segment item can display
23783 * combination of Text and any Evas_Object like Images or other widget.
23785 * Smart callbacks one can listen to:
23786 * - "changed" - When the user clicks on a segment item which is not
23787 * previously selected and get selected. The event_info parameter is the
23788 * segment item index.
23790 * Available styles for it:
23793 * Here is an example on its usage:
23794 * @li @ref segment_control_example
23798 * @addtogroup SegmentControl
23802 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
23805 * Add a new segment control widget to the given parent Elementary
23806 * (container) object.
23808 * @param parent The parent object.
23809 * @return a new segment control widget handle or @c NULL, on errors.
23811 * This function inserts a new segment control widget on the canvas.
23813 * @ingroup SegmentControl
23815 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23818 * Append a new item to the segment control object.
23820 * @param obj The segment control object.
23821 * @param icon The icon object to use for the left side of the item. An
23822 * icon can be any Evas object, but usually it is an icon created
23823 * with elm_icon_add().
23824 * @param label The label of the item.
23825 * Note that, NULL is different from empty string "".
23826 * @return The created item or @c NULL upon failure.
23828 * A new item will be created and appended to the segment control, i.e., will
23829 * be set as @b last item.
23831 * If it should be inserted at another position,
23832 * elm_segment_control_item_insert_at() should be used instead.
23834 * Items created with this function can be deleted with function
23835 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23837 * @note @p label set to @c NULL is different from empty string "".
23839 * only has icon, it will be displayed bigger and centered. If it has
23840 * icon and label, even that an empty string, icon will be smaller and
23841 * positioned at left.
23845 * sc = elm_segment_control_add(win);
23846 * ic = elm_icon_add(win);
23847 * elm_icon_file_set(ic, "path/to/image", NULL);
23848 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23849 * elm_segment_control_item_add(sc, ic, "label");
23850 * evas_object_show(sc);
23853 * @see elm_segment_control_item_insert_at()
23854 * @see elm_segment_control_item_del()
23856 * @ingroup SegmentControl
23858 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
23861 * Insert a new item to the segment control object at specified position.
23863 * @param obj The segment control object.
23864 * @param icon The icon object to use for the left side of the item. An
23865 * icon can be any Evas object, but usually it is an icon created
23866 * with elm_icon_add().
23867 * @param label The label of the item.
23868 * @param index Item position. Value should be between 0 and items count.
23869 * @return The created item or @c NULL upon failure.
23871 * Index values must be between @c 0, when item will be prepended to
23872 * segment control, and items count, that can be get with
23873 * elm_segment_control_item_count_get(), case when item will be appended
23874 * to segment control, just like elm_segment_control_item_add().
23876 * Items created with this function can be deleted with function
23877 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23879 * @note @p label set to @c NULL is different from empty string "".
23881 * only has icon, it will be displayed bigger and centered. If it has
23882 * icon and label, even that an empty string, icon will be smaller and
23883 * positioned at left.
23885 * @see elm_segment_control_item_add()
23886 * @see elm_segment_control_count_get()
23887 * @see elm_segment_control_item_del()
23889 * @ingroup SegmentControl
23891 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);
23894 * Remove a segment control item from its parent, deleting it.
23896 * @param it The item to be removed.
23898 * Items can be added with elm_segment_control_item_add() or
23899 * elm_segment_control_item_insert_at().
23901 * @ingroup SegmentControl
23903 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23906 * Remove a segment control item at given index from its parent,
23909 * @param obj The segment control object.
23910 * @param index The position of the segment control item to be deleted.
23912 * Items can be added with elm_segment_control_item_add() or
23913 * elm_segment_control_item_insert_at().
23915 * @ingroup SegmentControl
23917 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23920 * Get the Segment items count from segment control.
23922 * @param obj The segment control object.
23923 * @return Segment items count.
23925 * It will just return the number of items added to segment control @p obj.
23927 * @ingroup SegmentControl
23929 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23932 * Get the item placed at specified index.
23934 * @param obj The segment control object.
23935 * @param index The index of the segment item.
23936 * @return The segment control item or @c NULL on failure.
23938 * Index is the position of an item in segment control widget. Its
23939 * range is from @c 0 to <tt> count - 1 </tt>.
23940 * Count is the number of items, that can be get with
23941 * elm_segment_control_item_count_get().
23943 * @ingroup SegmentControl
23945 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23948 * Get the label of item.
23950 * @param obj The segment control object.
23951 * @param index The index of the segment item.
23952 * @return The label of the item at @p index.
23954 * The return value is a pointer to the label associated to the item when
23955 * it was created, with function elm_segment_control_item_add(), or later
23956 * with function elm_segment_control_item_label_set. If no label
23957 * was passed as argument, it will return @c NULL.
23959 * @see elm_segment_control_item_label_set() for more details.
23960 * @see elm_segment_control_item_add()
23962 * @ingroup SegmentControl
23964 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23967 * Set the label of item.
23969 * @param it The item of segment control.
23970 * @param text The label of item.
23972 * The label to be displayed by the item.
23973 * Label will be at right of the icon (if set).
23975 * If a label was passed as argument on item creation, with function
23976 * elm_control_segment_item_add(), it will be already
23977 * displayed by the item.
23979 * @see elm_segment_control_item_label_get()
23980 * @see elm_segment_control_item_add()
23982 * @ingroup SegmentControl
23984 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
23987 * Get the icon associated to the item.
23989 * @param obj The segment control object.
23990 * @param index The index of the segment item.
23991 * @return The left side icon associated to the item at @p index.
23993 * The return value is a pointer to the icon associated to the item when
23994 * it was created, with function elm_segment_control_item_add(), or later
23995 * with function elm_segment_control_item_icon_set(). If no icon
23996 * was passed as argument, it will return @c NULL.
23998 * @see elm_segment_control_item_add()
23999 * @see elm_segment_control_item_icon_set()
24001 * @ingroup SegmentControl
24003 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24006 * Set the icon associated to the item.
24008 * @param it The segment control item.
24009 * @param icon The icon object to associate with @p it.
24011 * The icon object to use at left side of the item. An
24012 * icon can be any Evas object, but usually it is an icon created
24013 * with elm_icon_add().
24015 * Once the icon object is set, a previously set one will be deleted.
24016 * @warning Setting the same icon for two items will cause the icon to
24017 * dissapear from the first item.
24019 * If an icon was passed as argument on item creation, with function
24020 * elm_segment_control_item_add(), it will be already
24021 * associated to the item.
24023 * @see elm_segment_control_item_add()
24024 * @see elm_segment_control_item_icon_get()
24026 * @ingroup SegmentControl
24028 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24031 * Get the index of an item.
24033 * @param it The segment control item.
24034 * @return The position of item in segment control widget.
24036 * Index is the position of an item in segment control widget. Its
24037 * range is from @c 0 to <tt> count - 1 </tt>.
24038 * Count is the number of items, that can be get with
24039 * elm_segment_control_item_count_get().
24041 * @ingroup SegmentControl
24043 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24046 * Get the base object of the item.
24048 * @param it The segment control item.
24049 * @return The base object associated with @p it.
24051 * Base object is the @c Evas_Object that represents that item.
24053 * @ingroup SegmentControl
24055 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24058 * Get the selected item.
24060 * @param obj The segment control object.
24061 * @return The selected item or @c NULL if none of segment items is
24064 * The selected item can be unselected with function
24065 * elm_segment_control_item_selected_set().
24067 * The selected item always will be highlighted on segment control.
24069 * @ingroup SegmentControl
24071 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24074 * Set the selected state of an item.
24076 * @param it The segment control item
24077 * @param select The selected state
24079 * This sets the selected state of the given item @p it.
24080 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24082 * If a new item is selected the previosly selected will be unselected.
24083 * Previoulsy selected item can be get with function
24084 * elm_segment_control_item_selected_get().
24086 * The selected item always will be highlighted on segment control.
24088 * @see elm_segment_control_item_selected_get()
24090 * @ingroup SegmentControl
24092 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
24099 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
24100 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
24101 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
24102 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
24103 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
24104 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
24105 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
24106 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
24108 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
24109 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
24111 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
24112 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
24113 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
24114 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
24115 EAPI void elm_video_play(Evas_Object *video);
24116 EAPI void elm_video_pause(Evas_Object *video);
24117 EAPI void elm_video_stop(Evas_Object *video);
24118 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
24119 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
24120 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
24121 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
24122 EAPI double elm_video_audio_level_get(Evas_Object *video);
24123 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
24124 EAPI double elm_video_play_position_get(Evas_Object *video);
24125 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
24126 EAPI double elm_video_play_length_get(Evas_Object *video);
24127 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
24128 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
24129 EAPI const char *elm_video_title_get(Evas_Object *video);
24131 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
24132 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
24135 typedef struct _Elm_Naviframe_Item Elm_Naviframe_Item;
24139 ELM_NAVIFRAME_PREV_BUTTON,
24140 ELM_NAVIFRAME_NEXT_BUTTON
24141 } Elm_Naviframe_Button_Type;
24143 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24144 EAPI Elm_Naviframe_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);
24145 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
24146 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
24147 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24148 EAPI void elm_naviframe_item_content_set(Elm_Naviframe_Item *item, Evas_Object *content) EINA_ARG_NONNULL(1);
24149 EAPI Evas_Object *elm_naviframe_item_content_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
24150 EAPI void elm_naviframe_item_title_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
24151 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
24152 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
24153 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
24154 EAPI Elm_Naviframe_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24155 EAPI Elm_Naviframe_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24156 EAPI void elm_naviframe_item_button_set(Elm_Naviframe_Item *it, Evas_Object *btn, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
24157 EAPI Evas_Object *elm_naviframe_item_button_get(const Elm_Naviframe_Item *it, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
24158 EAPI void elm_naviframe_item_icon_set(Elm_Naviframe_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24159 EAPI Evas_Object *elm_naviframe_item_icon_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
24160 EAPI void elm_naviframe_item_style_set(Elm_Naviframe_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
24161 EAPI const char *elm_naviframe_item_style_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
24162 EAPI void elm_naviframe_item_title_visible_set(Elm_Naviframe_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
24163 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);