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@
15 @author Carsten Haitzler <raster@@rasterman.com>
16 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
17 @author Cedric Bail <cedric.bail@@free.fr>
18 @author Vincent Torri <vtorri@@univ-evry.fr>
19 @author Daniel Kolesa <quaker66@@gmail.com>
20 @author Jaime Thomas <avi.thomas@@gmail.com>
21 @author Swisscom - http://www.swisscom.ch/
22 @author Christopher Michael <devilhorns@@comcast.net>
23 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
24 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
25 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
26 @author Brian Wang <brian.wang.0721@@gmail.com>
27 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
28 @author Samsung Electronics <tbd>
29 @author Samsung SAIT <tbd>
30 @author Brett Nash <nash@@nash.id.au>
31 @author Bruno Dilly <bdilly@@profusion.mobi>
32 @author Rafael Fonseca <rfonseca@@profusion.mobi>
33 @author Chuneon Park <hermet@@hermet.pe.kr>
34 @author Woohyun Jung <wh0705.jung@@samsung.com>
35 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
36 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
37 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
38 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
39 @author Gustavo Lima Chaves <glima@@profusion.mobi>
40 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
41 @author Tiago Falcão <tiago@@profusion.mobi>
42 @author Otavio Pontes <otavio@@profusion.mobi>
43 @author Viktor Kojouharov <vkojouharov@@gmail.com>
44 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
45 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
46 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
47 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
48 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
49 @author Jihoon Kim <jihoon48.kim@@samsung.com>
50 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
51 @author Tom Hacohen <tom@@stosb.com>
52 @author Aharon Hillel <a.hillel@@partner.samsung.com>
53 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
54 @author Shinwoo Kim <kimcinoo@@gmail.com>
55 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
56 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
59 @section intro What is Elementary?
61 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
62 applications (yet). Small simple ones with simple needs.
64 It is meant to make the programmers work almost brainless but give them lots
67 License: LGPL v2 (see COPYING in the base of Elementary's source). This
68 applies to all files in the source here.
70 Acknowledgements: There is a lot that goes into making a widget set, and
71 they don't happen out of nothing. It's like trying to make everyone
72 everywhere happy, regardless of age, gender, race or nationality - and
73 that is really tough. So thanks to people and organisations behind this,
74 aslisted in the Authors section above.
86 * @brief Elementary's API
91 @ELM_UNIX_DEF@ ELM_UNIX
92 @ELM_WIN32_DEF@ ELM_WIN32
93 @ELM_WINCE_DEF@ ELM_WINCE
94 @ELM_EDBUS_DEF@ ELM_EDBUS
95 @ELM_EFREET_DEF@ ELM_EFREET
96 @ELM_ETHUMB_DEF@ ELM_ETHUMB
97 @ELM_EMAP_DEF@ ELM_EMAP
98 @ELM_DEBUG_DEF@ ELM_DEBUG
99 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
100 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
102 /* Standard headers for standard system calls etc. */
107 #include <sys/types.h>
108 #include <sys/stat.h>
109 #include <sys/time.h>
110 #include <sys/param.h>
123 # ifdef ELM_LIBINTL_H
124 # include <libintl.h>
135 #if defined (ELM_WIN32) || defined (ELM_WINCE)
138 # define alloca _alloca
149 #include <Ecore_Evas.h>
150 #include <Ecore_File.h>
151 #include <Ecore_IMF.h>
160 # include <Efreet_Mime.h>
161 # include <Efreet_Trash.h>
165 # include <Ethumb_Client.h>
177 # ifdef ELEMENTARY_BUILD
179 # define EAPI __declspec(dllexport)
182 # endif /* ! DLL_EXPORT */
184 # define EAPI __declspec(dllimport)
185 # endif /* ! EFL_EVAS_BUILD */
189 # define EAPI __attribute__ ((visibility("default")))
196 #endif /* ! _WIN32 */
199 /* allow usage from c++ */
204 #define ELM_VERSION_MAJOR @VMAJ@
205 #define ELM_VERSION_MINOR @VMIN@
207 typedef struct _Elm_Version
215 EAPI extern Elm_Version *elm_version;
218 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
219 #define ELM_PI 3.14159265358979323846
222 * @defgroup General General
224 * @brief General Elementary API. Functions that don't relate to
225 * Elementary objects specifically.
227 * Here are documented functions which init/shutdown the library,
228 * that apply to generic Elementary objects, that deal with
229 * configuration, et cetera.
231 * @ref general_functions_example_page "This" example contemplates
232 * some of these functions.
236 * @addtogroup General
241 * Defines couple of standard Evas_Object layers to be used
242 * with evas_object_layer_set().
244 * @note whenever extending with new values, try to keep some padding
245 * to siblings so there is room for further extensions.
247 typedef enum _Elm_Object_Layer
249 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
250 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
251 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
252 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
253 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
254 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
257 /**************************************************************************/
258 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
261 * Emitted when any Elementary's policy value is changed.
263 EAPI extern int ELM_EVENT_POLICY_CHANGED;
266 * @typedef Elm_Event_Policy_Changed
268 * Data on the event when an Elementary policy has changed
270 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
273 * @struct _Elm_Event_Policy_Changed
275 * Data on the event when an Elementary policy has changed
277 struct _Elm_Event_Policy_Changed
279 unsigned int policy; /**< the policy identifier */
280 int new_value; /**< value the policy had before the change */
281 int old_value; /**< new value the policy got */
285 * Policy identifiers.
287 typedef enum _Elm_Policy
289 ELM_POLICY_QUIT, /**< under which circunstances the application
290 * should quit automatically. @see
294 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
297 typedef enum _Elm_Policy_Quit
299 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
301 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
303 * window is closed */
304 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
306 typedef enum _Elm_Focus_Direction
310 } Elm_Focus_Direction;
312 typedef enum _Elm_Text_Format
314 ELM_TEXT_FORMAT_PLAIN_UTF8,
315 ELM_TEXT_FORMAT_MARKUP_UTF8
319 * Line wrapping types.
321 typedef enum _Elm_Wrap_Type
323 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
324 ELM_WRAP_CHAR, /**< Char wrap - wrap between graphmes */
325 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
326 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
332 * @typedef Elm_Object_Item
333 * An Elementary Object item handle.
336 typedef struct _Elm_Object_Item Elm_Object_Item;
340 * Called back when a widget's tooltip is activated and needs content.
341 * @param data user-data given to elm_object_tooltip_content_cb_set()
342 * @param obj owner widget.
344 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
347 * Called back when a widget's item tooltip is activated and needs content.
348 * @param data user-data given to elm_object_tooltip_content_cb_set()
349 * @param obj owner widget.
350 * @param item context dependent item. As an example, if tooltip was
351 * set on Elm_List_Item, then it is of this type.
353 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
355 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
357 #ifndef ELM_LIB_QUICKLAUNCH
358 #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 */
360 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
363 /**************************************************************************/
367 * Initialize Elementary
369 * @param[in] argc System's argument count value
370 * @param[in] argv System's pointer to array of argument strings
371 * @return The init counter value.
373 * This function initializes Elementary and increments a counter of
374 * the number of calls to it. It returs the new counter's value.
376 * @warning This call is exported only for use by the @c ELM_MAIN()
377 * macro. There is no need to use this if you use this macro (which
378 * is highly advisable). An elm_main() should contain the entry
379 * point code for your application, having the same prototype as
380 * elm_init(), and @b not being static (putting the @c EAPI symbol
381 * in front of its type declaration is advisable). The @c
382 * ELM_MAIN() call should be placed just after it.
385 * @dontinclude bg_example_01.c
389 * See the full @ref bg_example_01_c "example".
391 * @see elm_shutdown().
394 EAPI int elm_init(int argc, char **argv);
397 * Shut down Elementary
399 * @return The init counter value.
401 * This should be called at the end of your application, just
402 * before it ceases to do any more processing. This will clean up
403 * any permanent resources your application may have allocated via
404 * Elementary that would otherwise persist.
406 * @see elm_init() for an example
410 EAPI int elm_shutdown(void);
413 * Run Elementary's main loop
415 * This call should be issued just after all initialization is
416 * completed. This function will not return until elm_exit() is
417 * called. It will keep looping, running the main
418 * (event/processing) loop for Elementary.
420 * @see elm_init() for an example
424 EAPI void elm_run(void);
427 * Exit Elementary's main loop
429 * If this call is issued, it will flag the main loop to cease
430 * processing and return back to its parent function (usually your
431 * elm_main() function).
433 * @see elm_init() for an example. There, just after a request to
434 * close the window comes, the main loop will be left.
436 * @note By using the #ELM_POLICY_QUIT on your Elementary
437 * applications, you'll this function called automatically for you.
441 EAPI void elm_exit(void);
444 * Provide information in order to make Elementary determine the @b
445 * run time location of the software in question, so other data files
446 * such as images, sound files, executable utilities, libraries,
447 * modules and locale files can be found.
449 * @param mainfunc This is your application's main function name,
450 * whose binary's location is to be found. Providing @c NULL
451 * will make Elementary not to use it
452 * @param dom This will be used as the application's "domain", in the
453 * form of a prefix to any environment variables that may
454 * override prefix detection and the directory name, inside the
455 * standard share or data directories, where the software's
456 * data files will be looked for.
457 * @param checkfile This is an (optional) magic file's path to check
458 * for existence (and it must be located in the data directory,
459 * under the share directory provided above). Its presence will
460 * help determine the prefix found was correct. Pass @c NULL if
461 * the check is not to be done.
463 * This function allows one to re-locate the application somewhere
464 * else after compilation, if the developer wishes for easier
465 * distribution of pre-compiled binaries.
467 * The prefix system is designed to locate where the given software is
468 * installed (under a common path prefix) at run time and then report
469 * specific locations of this prefix and common directories inside
470 * this prefix like the binary, library, data and locale directories,
471 * through the @c elm_app_*_get() family of functions.
473 * Call elm_app_info_set() early on before you change working
474 * directory or anything about @c argv[0], so it gets accurate
477 * It will then try and trace back which file @p mainfunc comes from,
478 * if provided, to determine the application's prefix directory.
480 * The @p dom parameter provides a string prefix to prepend before
481 * environment variables, allowing a fallback to @b specific
482 * environment variables to locate the software. You would most
483 * probably provide a lowercase string there, because it will also
484 * serve as directory domain, explained next. For environment
485 * variables purposes, this string is made uppercase. For example if
486 * @c "myapp" is provided as the prefix, then the program would expect
487 * @c "MYAPP_PREFIX" as a master environment variable to specify the
488 * exact install prefix for the software, or more specific environment
489 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
490 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
491 * the user or scripts before launching. If not provided (@c NULL),
492 * environment variables will not be used to override compiled-in
493 * defaults or auto detections.
495 * The @p dom string also provides a subdirectory inside the system
496 * shared data directory for data files. For example, if the system
497 * directory is @c /usr/local/share, then this directory name is
498 * appended, creating @c /usr/local/share/myapp, if it @p was @c
499 * "myapp". It is expected the application installs data files in
502 * The @p checkfile is a file name or path of something inside the
503 * share or data directory to be used to test that the prefix
504 * detection worked. For example, your app will install a wallpaper
505 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
506 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
509 * @see elm_app_compile_bin_dir_set()
510 * @see elm_app_compile_lib_dir_set()
511 * @see elm_app_compile_data_dir_set()
512 * @see elm_app_compile_locale_set()
513 * @see elm_app_prefix_dir_get()
514 * @see elm_app_bin_dir_get()
515 * @see elm_app_lib_dir_get()
516 * @see elm_app_data_dir_get()
517 * @see elm_app_locale_dir_get()
519 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
522 * Provide information on the @b fallback application's binaries
523 * directory, on scenarios where they get overriden by
524 * elm_app_info_set().
526 * @param dir The path to the default binaries directory (compile time
529 * @note Elementary will as well use this path to determine actual
530 * names of binaries' directory paths, maybe changing it to be @c
531 * something/local/bin instead of @c something/bin, only, for
534 * @warning You should call this function @b before
535 * elm_app_info_set().
537 EAPI void elm_app_compile_bin_dir_set(const char *dir);
540 * Provide information on the @b fallback application's libraries
541 * directory, on scenarios where they get overriden by
542 * elm_app_info_set().
544 * @param dir The path to the default libraries directory (compile
547 * @note Elementary will as well use this path to determine actual
548 * names of libraries' directory paths, maybe changing it to be @c
549 * something/lib32 or @c something/lib64 instead of @c something/lib,
552 * @warning You should call this function @b before
553 * elm_app_info_set().
555 EAPI void elm_app_compile_lib_dir_set(const char *dir);
558 * Provide information on the @b fallback application's data
559 * directory, on scenarios where they get overriden by
560 * elm_app_info_set().
562 * @param dir The path to the default data directory (compile time
565 * @note Elementary will as well use this path to determine actual
566 * names of data directory paths, maybe changing it to be @c
567 * something/local/share instead of @c something/share, only, for
570 * @warning You should call this function @b before
571 * elm_app_info_set().
573 EAPI void elm_app_compile_data_dir_set(const char *dir);
576 * Provide information on the @b fallback application's locale
577 * directory, on scenarios where they get overriden by
578 * elm_app_info_set().
580 * @param dir The path to the default locale directory (compile time
583 * @warning You should call this function @b before
584 * elm_app_info_set().
586 EAPI void elm_app_compile_locale_set(const char *dir);
589 * Retrieve the application's run time prefix directory, as set by
590 * elm_app_info_set() and the way (environment) the application was
593 * @return The directory prefix the application is actually using
595 EAPI const char *elm_app_prefix_dir_get(void);
598 * Retrieve the application's run time binaries prefix directory, as
599 * set by elm_app_info_set() and the way (environment) the application
602 * @return The binaries directory prefix the application is actually
605 EAPI const char *elm_app_bin_dir_get(void);
608 * Retrieve the application's run time libraries prefix directory, as
609 * set by elm_app_info_set() and the way (environment) the application
612 * @return The libraries directory prefix the application is actually
615 EAPI const char *elm_app_lib_dir_get(void);
618 * Retrieve the application's run time data prefix directory, as
619 * set by elm_app_info_set() and the way (environment) the application
622 * @return The data directory prefix the application is actually
625 EAPI const char *elm_app_data_dir_get(void);
628 * Retrieve the application's run time locale prefix directory, as
629 * set by elm_app_info_set() and the way (environment) the application
632 * @return The locale directory prefix the application is actually
635 EAPI const char *elm_app_locale_dir_get(void);
637 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
638 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
639 EAPI int elm_quicklaunch_init(int argc, char **argv);
640 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
641 EAPI int elm_quicklaunch_sub_shutdown(void);
642 EAPI int elm_quicklaunch_shutdown(void);
643 EAPI void elm_quicklaunch_seed(void);
644 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
645 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
646 EAPI void elm_quicklaunch_cleanup(void);
647 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
648 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
650 EAPI Eina_Bool elm_need_efreet(void);
651 EAPI Eina_Bool elm_need_e_dbus(void);
652 EAPI Eina_Bool elm_need_ethumb(void);
655 * Set a new policy's value (for a given policy group/identifier).
657 * @param policy policy identifier, as in @ref Elm_Policy.
658 * @param value policy value, which depends on the identifier
660 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
662 * Elementary policies define applications' behavior,
663 * somehow. These behaviors are divided in policy groups (see
664 * #Elm_Policy enumeration). This call will emit the Ecore event
665 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
666 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
669 * @note Currently, we have only one policy identifier/group
670 * (#ELM_POLICY_QUIT), which has two possible values.
674 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
677 * Gets the policy value set for given policy identifier.
679 * @param policy policy identifier, as in #Elm_Policy.
680 * @return The currently set policy value, for that
681 * identifier. Will be @c 0 if @p policy passed is invalid.
685 EAPI int elm_policy_get(unsigned int policy);
688 * Set a label of an object
690 * @param obj The Elementary object
691 * @param part The text part name to set (NULL for the default label)
692 * @param label The new text of the label
694 * @note Elementary objects may have many labels (e.g. Action Slider)
698 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
700 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
703 * Get a label of an object
705 * @param obj The Elementary object
706 * @param part The text part name to get (NULL for the default label)
707 * @return text of the label or NULL for any error
709 * @note Elementary objects may have many labels (e.g. Action Slider)
713 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
715 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
718 * Set a content of an object
720 * @param obj The Elementary object
721 * @param part The content part name to set (NULL for the default content)
722 * @param content The new content of the object
724 * @note Elementary objects may have many contents
728 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
730 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
733 * Get a content of an object
735 * @param obj The Elementary object
736 * @param item The content part name to get (NULL for the default content)
737 * @return content of the object or NULL for any error
739 * @note Elementary objects may have many contents
743 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
745 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
748 * Unset a content of an object
750 * @param obj The Elementary object
751 * @param item The content part name to unset (NULL for the default content)
753 * @note Elementary objects may have many contents
757 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
759 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
762 * Set a content of an object item
764 * @param it The Elementary object item
765 * @param part The content part name to set (NULL for the default content)
766 * @param content The new content of the object item
768 * @note Elementary object items may have many contents
772 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
774 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
777 * Get a content of an object item
779 * @param it The Elementary object item
780 * @param part The content part name to unset (NULL for the default content)
781 * @return content of the object item or NULL for any error
783 * @note Elementary object items may have many contents
787 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
789 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
792 * Unset a content of an object item
794 * @param it The Elementary object item
795 * @param part The content part name to unset (NULL for the default content)
797 * @note Elementary object items may have many contents
801 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
803 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
806 * Set a label of an objec itemt
808 * @param it The Elementary object item
809 * @param part The text part name to set (NULL for the default label)
810 * @param label The new text of the label
812 * @note Elementary object items may have many labels
816 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
818 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
821 * Get a label of an object
823 * @param it The Elementary object item
824 * @param part The text part name to get (NULL for the default label)
825 * @return text of the label or NULL for any error
827 * @note Elementary object items may have many labels
831 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
834 * Set the text to read out when in accessibility mode
836 * @param obj The object which is to be described
837 * @param txt The text that describes the widget to people with poor or no vision
841 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
844 * Set the text to read out when in accessibility mode
846 * @param it The object item which is to be described
847 * @param txt The text that describes the widget to people with poor or no vision
851 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
854 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
857 * Get the data associated with an object item
858 * @param it The object item
859 * @return The data associated with @p it
863 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
866 * Set the data associated with an object item
867 * @param it The object item
868 * @param data The data to be associated with @p it
872 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
875 * Send a signal to the edje object of the widget item.
877 * This function sends a signal to the edje object of the obj item. An
878 * edje program can respond to a signal by specifying matching
879 * 'signal' and 'source' fields.
881 * @param it The Elementary object item
882 * @param emission The signal's name.
883 * @param source The signal's source.
886 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
892 EAPI void elm_all_flush(void);
893 EAPI int elm_cache_flush_interval_get(void);
894 EAPI void elm_cache_flush_interval_set(int size);
895 EAPI void elm_cache_flush_interval_all_set(int size);
896 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
897 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
898 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
899 EAPI int elm_font_cache_get(void);
900 EAPI void elm_font_cache_set(int size);
901 EAPI void elm_font_cache_all_set(int size);
902 EAPI int elm_image_cache_get(void);
903 EAPI void elm_image_cache_set(int size);
904 EAPI void elm_image_cache_all_set(int size);
905 EAPI int elm_edje_file_cache_get(void);
906 EAPI void elm_edje_file_cache_set(int size);
907 EAPI void elm_edje_file_cache_all_set(int size);
908 EAPI int elm_edje_collection_cache_get(void);
909 EAPI void elm_edje_collection_cache_set(int size);
910 EAPI void elm_edje_collection_cache_all_set(int size);
913 * @defgroup Scaling Selective Widget Scaling
915 * Different widgets can be scaled independently. These functions
916 * allow you to manipulate this scaling on a per-widget basis. The
917 * object and all its children get their scaling factors multiplied
918 * by the scale factor set. This is multiplicative, in that if a
919 * child also has a scale size set it is in turn multiplied by its
920 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
921 * double size, @c 0.5 is half, etc.
923 * @ref general_functions_example_page "This" example contemplates
924 * some of these functions.
928 * Set the scaling factor for a given Elementary object
930 * @param obj The Elementary to operate on
931 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
936 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
939 * Get the scaling factor for a given Elementary object
941 * @param obj The object
942 * @return The scaling factor set by elm_object_scale_set()
946 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
949 * @defgroup Password_last_show Password last input show
951 * Last show feature of password mode enables user to view
952 * the last input entered for few seconds before masking it.
953 * These functions allow to set this feature in password mode
954 * of entry widget and also allow to manipulate the duration
955 * for which the input has to be visible.
961 * Get show last setting of password mode.
963 * This gets the show last input setting of password mode which might be
964 * enabled or disabled.
966 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
968 * @ingroup Password_last_show
970 EAPI Eina_Bool elm_password_show_last_get(void);
973 * Set show last setting in password mode.
975 * This enables or disables show last setting of password mode.
977 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
978 * @see elm_password_show_last_timeout_set()
979 * @ingroup Password_last_show
981 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
984 * Get's the timeout value in last show password mode.
986 * This gets the time out value for which the last input entered in password
987 * mode will be visible.
989 * @return The timeout value of last show password mode.
990 * @ingroup Password_last_show
992 EAPI double elm_password_show_last_timeout_get(void);
995 * Set's the timeout value in last show password mode.
997 * This sets the time out value for which the last input entered in password
998 * mode will be visible.
1000 * @param password_show_last_timeout The timeout value.
1001 * @see elm_password_show_last_set()
1002 * @ingroup Password_last_show
1004 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1010 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1011 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1012 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1013 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1015 * Set the style to use by a widget
1017 * Sets the style name that will define the appearance of a widget. Styles
1018 * vary from widget to widget and may also be defined by other themes
1019 * by means of extensions and overlays.
1021 * @param obj The Elementary widget to style
1022 * @param style The style name to use
1024 * @see elm_theme_extension_add()
1025 * @see elm_theme_overlay_add()
1029 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1031 * Get the style used by the widget
1033 * This gets the style being used for that widget. Note that the string
1034 * pointer is only valid as longas the object is valid and the style doesn't
1037 * @param obj The Elementary widget to query for its style
1038 * @return The style name used
1040 * @see elm_object_style_set()
1044 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1047 * @defgroup Styles Styles
1049 * Widgets can have different styles of look. These generic API's
1050 * set styles of widgets, if they support them (and if the theme(s)
1053 * @ref general_functions_example_page "This" example contemplates
1054 * some of these functions.
1058 * Set the disabled state of an Elementary object.
1060 * @param obj The Elementary object to operate on
1061 * @param disabled The state to put in in: @c EINA_TRUE for
1062 * disabled, @c EINA_FALSE for enabled
1064 * Elementary objects can be @b disabled, in which state they won't
1065 * receive input and, in general, will be themed differently from
1066 * their normal state, usually greyed out. Useful for contexts
1067 * where you don't want your users to interact with some of the
1068 * parts of you interface.
1070 * This sets the state for the widget, either disabling it or
1075 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1078 * Get the disabled state of an Elementary object.
1080 * @param obj The Elementary object to operate on
1081 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1082 * if it's enabled (or on errors)
1084 * This gets the state of the widget, which might be enabled or disabled.
1088 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1091 * @defgroup WidgetNavigation Widget Tree Navigation.
1093 * How to check if an Evas Object is an Elementary widget? How to
1094 * get the first elementary widget that is parent of the given
1095 * object? These are all covered in widget tree navigation.
1097 * @ref general_functions_example_page "This" example contemplates
1098 * some of these functions.
1101 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1104 * Get the first parent of the given object that is an Elementary
1107 * @param obj the Elementary object to query parent from.
1108 * @return the parent object that is an Elementary widget, or @c
1109 * NULL, if it was not found.
1111 * Use this to query for an object's parent widget.
1113 * @note Most of Elementary users wouldn't be mixing non-Elementary
1114 * smart objects in the objects tree of an application, as this is
1115 * an advanced usage of Elementary with Evas. So, except for the
1116 * application's window, which is the root of that tree, all other
1117 * objects would have valid Elementary widget parents.
1119 * @ingroup WidgetNavigation
1121 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1122 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1123 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1125 EAPI double elm_scale_get(void);
1126 EAPI void elm_scale_set(double scale);
1127 EAPI void elm_scale_all_set(double scale);
1129 EAPI Eina_Bool elm_mirrored_get(void);
1130 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1132 EAPI Eina_Bool elm_config_save(void);
1133 EAPI void elm_config_reload(void);
1135 EAPI const char *elm_profile_current_get(void);
1136 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1137 EAPI void elm_profile_dir_free(const char *p_dir);
1138 EAPI Eina_List *elm_profile_list_get(void);
1139 EAPI void elm_profile_list_free(Eina_List *l);
1140 EAPI void elm_profile_set(const char *profile);
1141 EAPI void elm_profile_all_set(const char *profile);
1143 EAPI const char *elm_engine_current_get(void);
1144 EAPI void elm_engine_set(const char *engine);
1146 typedef struct _Elm_Text_Class
1152 typedef struct _Elm_Font_Overlay
1154 const char *text_class;
1156 Evas_Font_Size size;
1159 typedef struct _Elm_Font_Properties
1163 } Elm_Font_Properties;
1165 EAPI const Eina_List *elm_text_classes_list_get(void);
1166 EAPI void elm_text_classes_list_free(const Eina_List *list);
1168 EAPI const Eina_List *elm_font_overlay_list_get(void);
1169 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1170 EAPI void elm_font_overlay_unset(const char *text_class);
1171 EAPI void elm_font_overlay_apply(void);
1172 EAPI void elm_font_overlay_all_apply(void);
1174 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1175 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1176 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1177 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1178 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1179 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1182 * @defgroup Fingers Fingers
1184 * Elementary is designed to be finger-friendly for touchscreens,
1185 * and so in addition to scaling for display resolution, it can
1186 * also scale based on finger "resolution" (or size). You can then
1187 * customize the granularity of the areas meant to receive clicks
1190 * Different profiles may have pre-set values for finger sizes.
1192 * @ref general_functions_example_page "This" example contemplates
1193 * some of these functions.
1197 * Get the configured "finger size"
1199 * @return The finger size
1201 * This gets the globally configured finger size, <b>in pixels</b>
1205 EAPI Evas_Coord elm_finger_size_get(void);
1206 EAPI void elm_finger_size_set(Evas_Coord size);
1207 EAPI void elm_finger_size_all_set(Evas_Coord size);
1210 * @defgroup Focus Focus
1212 * An Elementary application has, at all times, one (and only one)
1213 * @b focused object. This is what determines where the input
1214 * events go to within the application's window. Also, focused
1215 * objects can be decorated differently, in order to signal to the
1216 * user where the input is, at a given moment.
1218 * Elementary applications also have the concept of <b>focus
1219 * chain</b>: one can cycle through all the windows' focusable
1220 * objects by input (tab key) or programmatically. The default
1221 * focus chain for an application is the one define by the order in
1222 * which the widgets where added in code. One will cycle through
1223 * top level widgets, and, for each one containg sub-objects, cycle
1224 * through them all, before returning to the level
1225 * above. Elementary also allows one to set @b custom focus chains
1226 * for their applications.
1228 * Besides the focused decoration a widget may exhibit, when it
1229 * gets focus, Elementary has a @b global focus highlight object
1230 * that can be enabled for a window. If one chooses to do so, this
1231 * extra highlight effect will surround the current focused object,
1234 * @note Some Elementary widgets are @b unfocusable, after
1235 * creation, by their very nature: they are not meant to be
1236 * interacted with input events, but are there just for visual
1239 * @ref general_functions_example_page "This" example contemplates
1240 * some of these functions.
1243 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1244 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1245 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1246 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1249 * Get the whether an Elementary object has the focus or not.
1251 * @param obj The Elementary object to get the information from
1252 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1253 * not (and on errors).
1255 * @see elm_object_focus()
1259 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1262 * Make a given Elementary object the focused one.
1264 * @param obj The Elementary object to make focused.
1266 * @note This object, if it can handle focus, will take the focus
1267 * away from the one who had it previously and will, for now on, be
1268 * the one receiving input events.
1270 * @see elm_object_focus_get()
1274 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1277 * Remove the focus from an Elementary object
1279 * @param obj The Elementary to take focus from
1281 * This removes the focus from @p obj, passing it back to the
1282 * previous element in the focus chain list.
1284 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1288 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1291 * Set the ability for an Element object to be focused
1293 * @param obj The Elementary object to operate on
1294 * @param enable @c EINA_TRUE if the object can be focused, @c
1295 * EINA_FALSE if not (and on errors)
1297 * This sets whether the object @p obj is able to take focus or
1298 * not. Unfocusable objects do nothing when programmatically
1299 * focused, being the nearest focusable parent object the one
1300 * really getting focus. Also, when they receive mouse input, they
1301 * will get the event, but not take away the focus from where it
1306 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1309 * Get whether an Elementary object is focusable or not
1311 * @param obj The Elementary object to operate on
1312 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1313 * EINA_FALSE if not (and on errors)
1315 * @note Objects which are meant to be interacted with by input
1316 * events are created able to be focused, by default. All the
1321 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1323 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1324 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1325 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1326 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1327 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1328 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1329 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1332 * Make the elementary object and its children to be unfocusable (or focusable).
1334 * @param obj The Elementary object to operate on
1335 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1336 * @c EINA_FALSE for focusable.
1338 * This sets whether the object @p obj and its children objects
1339 * able to take focus or not. If the tree is unfocusable,
1340 * newest focused object which is not in this tree will get focus.
1341 * This API can be helpful for an object to be deleted.
1342 * When an object will be deleted soon, it and its children may not
1343 * want to get focus (by focus reverting or by other focus controls).
1344 * Then, just use this API before deleting.
1346 * @see elm_object_tree_unfocusable_get()
1350 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1353 * Get whether an Elementary object and its children are unfocusable or not.
1355 * @param obj The Elementary object to get the information from
1356 * @return @c EINA_TRUE, if the tree is unfocussable,
1357 * @c EINA_FALSE if not (and on errors).
1359 * @see elm_object_tree_unfocusable_set()
1363 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1365 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1366 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1367 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1368 EAPI double elm_scroll_bounce_friction_get(void);
1369 EAPI void elm_scroll_bounce_friction_set(double friction);
1370 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1371 EAPI double elm_scroll_page_scroll_friction_get(void);
1372 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1373 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1374 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1375 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1376 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1377 EAPI double elm_scroll_zoom_friction_get(void);
1378 EAPI void elm_scroll_zoom_friction_set(double friction);
1379 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1380 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1381 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1382 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1383 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1384 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1385 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1386 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1387 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1388 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1389 EAPI double elm_scroll_thumbscroll_friction_get(void);
1390 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1391 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1392 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1393 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1394 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1396 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1397 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1398 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1399 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1400 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1401 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1402 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1403 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1405 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1406 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data) EINA_ARG_NONNULL(1, 4);
1407 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source)) EINA_ARG_NONNULL(1, 4);
1409 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1410 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1413 * Adjust size of an element for finger usage.
1415 * @param times_w How many fingers should fit horizontally
1416 * @param w Pointer to the width size to adjust
1417 * @param times_h How many fingers should fit vertically
1418 * @param h Pointer to the height size to adjust
1420 * This takes width and height sizes (in pixels) as input and a
1421 * size multiple (which is how many fingers you want to place
1422 * within the area, being "finger" the size set by
1423 * elm_finger_size_set()), and adjusts the size to be large enough
1424 * to accommodate the resulting size -- if it doesn't already
1425 * accommodate it. On return the @p w and @p h sizes pointed to by
1426 * these parameters will be modified, on those conditions.
1428 * @note This is kind of a low level Elementary call, most useful
1429 * on size evaluation times for widgets. An external user wouldn't
1430 * be calling, most of the time.
1434 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1436 EAPI double elm_longpress_timeout_get(void);
1437 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1440 * don't use it unless you are sure
1442 EAPI void elm_object_tree_dump(const Evas_Object *top);
1443 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1445 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
1446 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
1451 * @defgroup Theme Theme
1453 * Elementary uses Edje to theme its widgets, naturally. But for the most
1454 * part this is hidden behind a simpler interface that lets the user set
1455 * extensions and choose the style of widgets in a much easier way.
1457 * Instead of thinking in terms of paths to Edje files and their groups
1458 * each time you want to change the appearance of a widget, Elementary
1459 * works so you can add any theme file with extensions or replace the
1460 * main theme at one point in the application, and then just set the style
1461 * of widgets with elm_object_style_set() and related functions. Elementary
1462 * will then look in its list of themes for a matching group and apply it,
1463 * and when the theme changes midway through the application, all widgets
1464 * will be updated accordingly.
1466 * There are three concepts you need to know to understand how Elementary
1467 * theming works: default theme, extensions and overlays.
1469 * Default theme, obviously enough, is the one that provides the default
1470 * look of all widgets. End users can change the theme used by Elementary
1471 * by setting the @c ELM_THEME environment variable before running an
1472 * application, or globally for all programs using the @c elementary_config
1473 * utility. Applications can change the default theme using elm_theme_set(),
1474 * but this can go against the user wishes, so it's not an adviced practice.
1476 * Ideally, applications should find everything they need in the already
1477 * provided theme, but there may be occasions when that's not enough and
1478 * custom styles are required to correctly express the idea. For this
1479 * cases, Elementary has extensions.
1481 * Extensions allow the application developer to write styles of its own
1482 * to apply to some widgets. This requires knowledge of how each widget
1483 * is themed, as extensions will always replace the entire group used by
1484 * the widget, so important signals and parts need to be there for the
1485 * object to behave properly (see documentation of Edje for details).
1486 * Once the theme for the extension is done, the application needs to add
1487 * it to the list of themes Elementary will look into, using
1488 * elm_theme_extension_add(), and set the style of the desired widgets as
1489 * he would normally with elm_object_style_set().
1491 * Overlays, on the other hand, can replace the look of all widgets by
1492 * overriding the default style. Like extensions, it's up to the application
1493 * developer to write the theme for the widgets it wants, the difference
1494 * being that when looking for the theme, Elementary will check first the
1495 * list of overlays, then the set theme and lastly the list of extensions,
1496 * so with overlays it's possible to replace the default view and every
1497 * widget will be affected. This is very much alike to setting the whole
1498 * theme for the application and will probably clash with the end user
1499 * options, not to mention the risk of ending up with not matching styles
1500 * across the program. Unless there's a very special reason to use them,
1501 * overlays should be avoided for the resons exposed before.
1503 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1504 * keeps one default internally and every function that receives one of
1505 * these can be called with NULL to refer to this default (except for
1506 * elm_theme_free()). It's possible to create a new instance of a
1507 * ::Elm_Theme to set other theme for a specific widget (and all of its
1508 * children), but this is as discouraged, if not even more so, than using
1509 * overlays. Don't use this unless you really know what you are doing.
1511 * But to be less negative about things, you can look at the following
1513 * @li @ref theme_example_01 "Using extensions"
1514 * @li @ref theme_example_02 "Using overlays"
1519 * @typedef Elm_Theme
1521 * Opaque handler for the list of themes Elementary looks for when
1522 * rendering widgets.
1524 * Stay out of this unless you really know what you are doing. For most
1525 * cases, sticking to the default is all a developer needs.
1527 typedef struct _Elm_Theme Elm_Theme;
1530 * Create a new specific theme
1532 * This creates an empty specific theme that only uses the default theme. A
1533 * specific theme has its own private set of extensions and overlays too
1534 * (which are empty by default). Specific themes do not fall back to themes
1535 * of parent objects. They are not intended for this use. Use styles, overlays
1536 * and extensions when needed, but avoid specific themes unless there is no
1537 * other way (example: you want to have a preview of a new theme you are
1538 * selecting in a "theme selector" window. The preview is inside a scroller
1539 * and should display what the theme you selected will look like, but not
1540 * actually apply it yet. The child of the scroller will have a specific
1541 * theme set to show this preview before the user decides to apply it to all
1544 EAPI Elm_Theme *elm_theme_new(void);
1546 * Free a specific theme
1548 * @param th The theme to free
1550 * This frees a theme created with elm_theme_new().
1552 EAPI void elm_theme_free(Elm_Theme *th);
1554 * Copy the theme fom the source to the destination theme
1556 * @param th The source theme to copy from
1557 * @param thdst The destination theme to copy data to
1559 * This makes a one-time static copy of all the theme config, extensions
1560 * and overlays from @p th to @p thdst. If @p th references a theme, then
1561 * @p thdst is also set to reference it, with all the theme settings,
1562 * overlays and extensions that @p th had.
1564 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1566 * Tell the source theme to reference the ref theme
1568 * @param th The theme that will do the referencing
1569 * @param thref The theme that is the reference source
1571 * This clears @p th to be empty and then sets it to refer to @p thref
1572 * so @p th acts as an override to @p thref, but where its overrides
1573 * don't apply, it will fall through to @pthref for configuration.
1575 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1577 * Return the theme referred to
1579 * @param th The theme to get the reference from
1580 * @return The referenced theme handle
1582 * This gets the theme set as the reference theme by elm_theme_ref_set().
1583 * If no theme is set as a reference, NULL is returned.
1585 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1587 * Return the default theme
1589 * @return The default theme handle
1591 * This returns the internal default theme setup handle that all widgets
1592 * use implicitly unless a specific theme is set. This is also often use
1593 * as a shorthand of NULL.
1595 EAPI Elm_Theme *elm_theme_default_get(void);
1597 * Prepends a theme overlay to the list of overlays
1599 * @param th The theme to add to, or if NULL, the default theme
1600 * @param item The Edje file path to be used
1602 * Use this if your application needs to provide some custom overlay theme
1603 * (An Edje file that replaces some default styles of widgets) where adding
1604 * new styles, or changing system theme configuration is not possible. Do
1605 * NOT use this instead of a proper system theme configuration. Use proper
1606 * configuration files, profiles, environment variables etc. to set a theme
1607 * so that the theme can be altered by simple confiugration by a user. Using
1608 * this call to achieve that effect is abusing the API and will create lots
1611 * @see elm_theme_extension_add()
1613 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1615 * Delete a theme overlay from the list of overlays
1617 * @param th The theme to delete from, or if NULL, the default theme
1618 * @param item The name of the theme overlay
1620 * @see elm_theme_overlay_add()
1622 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1624 * Appends a theme extension to the list of extensions.
1626 * @param th The theme to add to, or if NULL, the default theme
1627 * @param item The Edje file path to be used
1629 * This is intended when an application needs more styles of widgets or new
1630 * widget themes that the default does not provide (or may not provide). The
1631 * application has "extended" usage by coming up with new custom style names
1632 * for widgets for specific uses, but as these are not "standard", they are
1633 * not guaranteed to be provided by a default theme. This means the
1634 * application is required to provide these extra elements itself in specific
1635 * Edje files. This call adds one of those Edje files to the theme search
1636 * path to be search after the default theme. The use of this call is
1637 * encouraged when default styles do not meet the needs of the application.
1638 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1640 * @see elm_object_style_set()
1642 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1644 * Deletes a theme extension from the list of extensions.
1646 * @param th The theme to delete from, or if NULL, the default theme
1647 * @param item The name of the theme extension
1649 * @see elm_theme_extension_add()
1651 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1653 * Set the theme search order for the given theme
1655 * @param th The theme to set the search order, or if NULL, the default theme
1656 * @param theme Theme search string
1658 * This sets the search string for the theme in path-notation from first
1659 * theme to search, to last, delimited by the : character. Example:
1661 * "shiny:/path/to/file.edj:default"
1663 * See the ELM_THEME environment variable for more information.
1665 * @see elm_theme_get()
1666 * @see elm_theme_list_get()
1668 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1670 * Return the theme search order
1672 * @param th The theme to get the search order, or if NULL, the default theme
1673 * @return The internal search order path
1675 * This function returns a colon separated string of theme elements as
1676 * returned by elm_theme_list_get().
1678 * @see elm_theme_set()
1679 * @see elm_theme_list_get()
1681 EAPI const char *elm_theme_get(Elm_Theme *th);
1683 * Return a list of theme elements to be used in a theme.
1685 * @param th Theme to get the list of theme elements from.
1686 * @return The internal list of theme elements
1688 * This returns the internal list of theme elements (will only be valid as
1689 * long as the theme is not modified by elm_theme_set() or theme is not
1690 * freed by elm_theme_free(). This is a list of strings which must not be
1691 * altered as they are also internal. If @p th is NULL, then the default
1692 * theme element list is returned.
1694 * A theme element can consist of a full or relative path to a .edj file,
1695 * or a name, without extension, for a theme to be searched in the known
1696 * theme paths for Elemementary.
1698 * @see elm_theme_set()
1699 * @see elm_theme_get()
1701 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1703 * Return the full patrh for a theme element
1705 * @param f The theme element name
1706 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1707 * @return The full path to the file found.
1709 * This returns a string you should free with free() on success, NULL on
1710 * failure. This will search for the given theme element, and if it is a
1711 * full or relative path element or a simple searchable name. The returned
1712 * path is the full path to the file, if searched, and the file exists, or it
1713 * is simply the full path given in the element or a resolved path if
1714 * relative to home. The @p in_search_path boolean pointed to is set to
1715 * EINA_TRUE if the file was a searchable file andis in the search path,
1716 * and EINA_FALSE otherwise.
1718 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1720 * Flush the current theme.
1722 * @param th Theme to flush
1724 * This flushes caches that let elementary know where to find theme elements
1725 * in the given theme. If @p th is NULL, then the default theme is flushed.
1726 * Call this function if source theme data has changed in such a way as to
1727 * make any caches Elementary kept invalid.
1729 EAPI void elm_theme_flush(Elm_Theme *th);
1731 * This flushes all themes (default and specific ones).
1733 * This will flush all themes in the current application context, by calling
1734 * elm_theme_flush() on each of them.
1736 EAPI void elm_theme_full_flush(void);
1738 * Set the theme for all elementary using applications on the current display
1740 * @param theme The name of the theme to use. Format same as the ELM_THEME
1741 * environment variable.
1743 EAPI void elm_theme_all_set(const char *theme);
1745 * Return a list of theme elements in the theme search path
1747 * @return A list of strings that are the theme element names.
1749 * This lists all available theme files in the standard Elementary search path
1750 * for theme elements, and returns them in alphabetical order as theme
1751 * element names in a list of strings. Free this with
1752 * elm_theme_name_available_list_free() when you are done with the list.
1754 EAPI Eina_List *elm_theme_name_available_list_new(void);
1756 * Free the list returned by elm_theme_name_available_list_new()
1758 * This frees the list of themes returned by
1759 * elm_theme_name_available_list_new(). Once freed the list should no longer
1760 * be used. a new list mys be created.
1762 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1764 * Set a specific theme to be used for this object and its children
1766 * @param obj The object to set the theme on
1767 * @param th The theme to set
1769 * This sets a specific theme that will be used for the given object and any
1770 * child objects it has. If @p th is NULL then the theme to be used is
1771 * cleared and the object will inherit its theme from its parent (which
1772 * ultimately will use the default theme if no specific themes are set).
1774 * Use special themes with great care as this will annoy users and make
1775 * configuration difficult. Avoid any custom themes at all if it can be
1778 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1780 * Get the specific theme to be used
1782 * @param obj The object to get the specific theme from
1783 * @return The specifc theme set.
1785 * This will return a specific theme set, or NULL if no specific theme is
1786 * set on that object. It will not return inherited themes from parents, only
1787 * the specific theme set for that specific object. See elm_object_theme_set()
1788 * for more information.
1790 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1796 typedef enum _Elm_Win_Type
1799 ELM_WIN_DIALOG_BASIC,
1806 ELM_WIN_DROPDOWN_MENU,
1809 ELM_WIN_NOTIFICATION,
1812 ELM_WIN_INLINED_IMAGE,
1815 typedef enum _Elm_Win_Keyboard_Mode
1817 ELM_WIN_KEYBOARD_UNKNOWN,
1818 ELM_WIN_KEYBOARD_OFF,
1819 ELM_WIN_KEYBOARD_ON,
1820 ELM_WIN_KEYBOARD_ALPHA,
1821 ELM_WIN_KEYBOARD_NUMERIC,
1822 ELM_WIN_KEYBOARD_PIN,
1823 ELM_WIN_KEYBOARD_PHONE_NUMBER,
1824 ELM_WIN_KEYBOARD_HEX,
1825 ELM_WIN_KEYBOARD_TERMINAL,
1826 ELM_WIN_KEYBOARD_PASSWORD,
1827 ELM_WIN_KEYBOARD_IP,
1828 ELM_WIN_KEYBOARD_HOST,
1829 ELM_WIN_KEYBOARD_FILE,
1830 ELM_WIN_KEYBOARD_URL,
1831 ELM_WIN_KEYBOARD_KEYPAD,
1832 ELM_WIN_KEYBOARD_J2ME
1833 } Elm_Win_Keyboard_Mode;
1835 typedef enum _Elm_Illume_Command
1837 ELM_ILLUME_COMMAND_FOCUS_BACK,
1838 ELM_ILLUME_COMMAND_FOCUS_FORWARD,
1839 ELM_ILLUME_COMMAND_FOCUS_HOME,
1840 ELM_ILLUME_COMMAND_CLOSE
1841 } Elm_Illume_Command;
1843 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1844 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1845 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1846 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1847 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1848 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1849 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1850 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1851 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1852 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
1853 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
1854 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1855 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
1856 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1857 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
1858 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1859 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
1860 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1861 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
1862 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1863 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
1864 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1865 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
1866 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1867 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
1868 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1869 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
1870 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1871 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1872 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1873 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1874 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
1875 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1876 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
1877 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1878 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
1879 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1880 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1881 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1882 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1883 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1884 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
1885 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1886 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
1887 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
1888 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1889 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1890 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1891 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1892 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1893 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
1894 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
1896 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1897 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1898 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1899 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1900 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1901 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1902 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1904 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1905 * (blank mouse, private mouse obj, defaultmouse)
1908 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
1909 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1910 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
1911 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1913 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
1915 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
1916 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1917 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1918 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1919 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1920 /* available styles:
1925 /* X specific calls - won't work on non-x engines (return 0) */
1926 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1927 /* smart callbacks called:
1928 * "delete,request" - the user requested to delete the window
1929 * "focus,in" - window got focus
1930 * "focus,out" - window lost focus
1931 * "moved" - window that holds the canvas was moved
1937 * @brief Background object, used for setting a solid color, image or Edje
1938 * group as background to a window or any container object.
1940 * The bg object is used for setting a solid background to a window or
1941 * packing into any container object. It works just like an image, but has
1942 * some properties useful to a background, like setting it to tiled,
1943 * centered, scaled or stretched.
1945 * Here is some sample code using it:
1946 * @li @ref bg_01_example_page
1947 * @li @ref bg_02_example_page
1948 * @li @ref bg_03_example_page
1952 typedef enum _Elm_Bg_Option
1954 ELM_BG_OPTION_CENTER, /**< center the background */
1955 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
1956 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
1957 ELM_BG_OPTION_TILE /**< tile background at its original size */
1961 * Add a new background to the parent
1963 * @param parent The parent object
1964 * @return The new object or NULL if it cannot be created
1968 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1971 * Set the file (image or edje) used for the background
1973 * @param obj The bg object
1974 * @param file The file path
1975 * @param group Optional key (group in Edje) within the file
1977 * This sets the image file used in the background object. The image (or edje)
1978 * will be stretched (retaining aspect if its an image file) to completely fill
1979 * the bg object. This may mean some parts are not visible.
1981 * @note Once the image of @p obj is set, a previously set one will be deleted,
1982 * even if @p file is NULL.
1986 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
1989 * Get the file (image or edje) used for the background
1991 * @param obj The bg object
1992 * @param file The file path
1993 * @param group Optional key (group in Edje) within the file
1997 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2000 * Set the option used for the background image
2002 * @param obj The bg object
2003 * @param option The desired background option (TILE, SCALE)
2005 * This sets the option used for manipulating the display of the background
2006 * image. The image can be tiled or scaled.
2010 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2013 * Get the option used for the background image
2015 * @param obj The bg object
2016 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2020 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2022 * Set the option used for the background color
2024 * @param obj The bg object
2029 * This sets the color used for the background rectangle. Its range goes
2034 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2036 * Get the option used for the background color
2038 * @param obj The bg object
2045 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2048 * Set the overlay object used for the background object.
2050 * @param obj The bg object
2051 * @param overlay The overlay object
2053 * This provides a way for elm_bg to have an 'overlay' that will be on top
2054 * of the bg. Once the over object is set, a previously set one will be
2055 * deleted, even if you set the new one to NULL. If you want to keep that
2056 * old content object, use the elm_bg_overlay_unset() function.
2061 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2064 * Get the overlay object used for the background object.
2066 * @param obj The bg object
2067 * @return The content that is being used
2069 * Return the content object which is set for this widget
2073 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2076 * Get the overlay object used for the background object.
2078 * @param obj The bg object
2079 * @return The content that was being used
2081 * Unparent and return the overlay object which was set for this widget
2085 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2088 * Set the size of the pixmap representation of the image.
2090 * This option just makes sense if an image is going to be set in the bg.
2092 * @param obj The bg object
2093 * @param w The new width of the image pixmap representation.
2094 * @param h The new height of the image pixmap representation.
2096 * This function sets a new size for pixmap representation of the given bg
2097 * image. It allows the image to be loaded already in the specified size,
2098 * reducing the memory usage and load time when loading a big image with load
2099 * size set to a smaller size.
2101 * NOTE: this is just a hint, the real size of the pixmap may differ
2102 * depending on the type of image being loaded, being bigger than requested.
2106 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2107 /* smart callbacks called:
2111 typedef enum _Elm_Icon_Lookup_Order
2113 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2114 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2115 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
2116 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
2117 } Elm_Icon_Lookup_Order;
2119 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2120 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2121 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2122 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2123 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2124 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2125 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2126 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2127 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2128 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2129 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2130 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2131 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2132 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2133 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2134 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2135 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
2136 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2137 EAPI Eina_Bool elm_icon_anim_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2138 EAPI void elm_icon_anim_set(Evas_Object *obj, Eina_Bool anim) EINA_ARG_NONNULL(1);
2139 EAPI Eina_Bool elm_icon_anim_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2140 EAPI void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
2141 EAPI Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2143 /* smart callbacks called:
2144 * "clicked" - the user clicked the icon
2148 typedef enum _Elm_Image_Orient
2150 ELM_IMAGE_ORIENT_NONE,
2151 ELM_IMAGE_ROTATE_90_CW,
2152 ELM_IMAGE_ROTATE_180_CW,
2153 ELM_IMAGE_ROTATE_90_CCW,
2154 ELM_IMAGE_FLIP_HORIZONTAL,
2155 ELM_IMAGE_FLIP_VERTICAL,
2156 ELM_IMAGE_FLIP_TRANSPOSE,
2157 ELM_IMAGE_FLIP_TRANSVERSE
2159 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2160 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2161 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2162 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2163 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2164 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
2165 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2166 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2167 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2168 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2169 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2170 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2171 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2172 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2173 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
2174 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2175 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2176 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2177 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2178 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
2179 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2181 /* smart callbacks called:
2182 * "clicked" - the user clicked the image
2186 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
2188 typedef enum _Elm_GLView_Mode
2190 ELM_GLVIEW_ALPHA = 1,
2191 ELM_GLVIEW_DEPTH = 2,
2192 ELM_GLVIEW_STENCIL = 4
2196 * Defines a policy for the glview resizing.
2198 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
2200 typedef enum _Elm_GLView_Resize_Policy
2202 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
2203 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
2204 } Elm_GLView_Resize_Policy;
2206 typedef enum _Elm_GLView_Render_Policy
2208 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
2209 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
2210 } Elm_GLView_Render_Policy;
2213 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2214 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2215 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2216 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2217 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
2218 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
2219 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
2220 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2221 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2222 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2223 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2224 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2230 * A box arranges objects in a linear fashion, governed by a layout function
2231 * that defines the details of this arrangement.
2233 * By default, the box will use an internal function to set the layout to
2234 * a single row, either vertical or horizontal. This layout is affected
2235 * by a number of parameters, such as the homogeneous flag set by
2236 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
2237 * elm_box_align_set() and the hints set to each object in the box.
2239 * For this default layout, it's possible to change the orientation with
2240 * elm_box_horizontal_set(). The box will start in the vertical orientation,
2241 * placing its elements ordered from top to bottom. When horizontal is set,
2242 * the order will go from left to right. If the box is set to be
2243 * homogeneous, every object in it will be assigned the same space, that
2244 * of the largest object. Padding can be used to set some spacing between
2245 * the cell given to each object. The alignment of the box, set with
2246 * elm_box_align_set(), determines how the bounding box of all the elements
2247 * will be placed within the space given to the box widget itself.
2249 * The size hints of each object also affect how they are placed and sized
2250 * within the box. evas_object_size_hint_min_set() will give the minimum
2251 * size the object can have, and the box will use it as the basis for all
2252 * latter calculations. Elementary widgets set their own minimum size as
2253 * needed, so there's rarely any need to use it manually.
2255 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2256 * used to tell whether the object will be allocated the minimum size it
2257 * needs or if the space given to it should be expanded. It's important
2258 * to realize that expanding the size given to the object is not the same
2259 * thing as resizing the object. It could very well end being a small
2260 * widget floating in a much larger empty space. If not set, the weight
2261 * for objects will normally be 0.0 for both axis, meaning the widget will
2262 * not be expanded. To take as much space possible, set the weight to
2263 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2265 * Besides how much space each object is allocated, it's possible to control
2266 * how the widget will be placed within that space using
2267 * evas_object_size_hint_align_set(). By default, this value will be 0.5
2268 * for both axis, meaning the object will be centered, but any value from
2269 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2270 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2271 * is -1.0, means the object will be resized to fill the entire space it
2274 * In addition, customized functions to define the layout can be set, which
2275 * allow the application developer to organize the objects within the box
2276 * in any number of ways.
2278 * The special elm_box_layout_transition() function can be used
2279 * to switch from one layout to another, animating the motion of the
2280 * children of the box.
2282 * @note Objects should not be added to box objects using _add() calls.
2284 * Some examples on how to use boxes follow:
2285 * @li @ref box_example_01
2286 * @li @ref box_example_02
2291 * @typedef Elm_Box_Transition
2293 * Opaque handler containing the parameters to perform an animated
2294 * transition of the layout the box uses.
2296 * @see elm_box_transition_new()
2297 * @see elm_box_layout_set()
2298 * @see elm_box_layout_transition()
2300 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2303 * Add a new box to the parent
2305 * By default, the box will be in vertical mode and non-homogeneous.
2307 * @param parent The parent object
2308 * @return The new object or NULL if it cannot be created
2310 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2312 * Set the horizontal orientation
2314 * By default, box object arranges their contents vertically from top to
2316 * By calling this function with @p horizontal as EINA_TRUE, the box will
2317 * become horizontal, arranging contents from left to right.
2319 * @note This flag is ignored if a custom layout function is set.
2321 * @param obj The box object
2322 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2323 * EINA_FALSE = vertical)
2325 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2327 * Get the horizontal orientation
2329 * @param obj The box object
2330 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
2332 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2334 * Set the box to arrange its children homogeneously
2336 * If enabled, homogeneous layout makes all items the same size, according
2337 * to the size of the largest of its children.
2339 * @note This flag is ignored if a custom layout function is set.
2341 * @param obj The box object
2342 * @param homogeneous The homogeneous flag
2344 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2346 * Get whether the box is using homogeneous mode or not
2348 * @param obj The box object
2349 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2351 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2352 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2353 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2355 * Add an object to the beginning of the pack list
2357 * Pack @p subobj into the box @p obj, placing it first in the list of
2358 * children objects. The actual position the object will get on screen
2359 * depends on the layout used. If no custom layout is set, it will be at
2360 * the top or left, depending if the box is vertical or horizontal,
2363 * @param obj The box object
2364 * @param subobj The object to add to the box
2366 * @see elm_box_pack_end()
2367 * @see elm_box_pack_before()
2368 * @see elm_box_pack_after()
2369 * @see elm_box_unpack()
2370 * @see elm_box_unpack_all()
2371 * @see elm_box_clear()
2373 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2375 * Add an object at the end of the pack list
2377 * Pack @p subobj into the box @p obj, placing it last in the list of
2378 * children objects. The actual position the object will get on screen
2379 * depends on the layout used. If no custom layout is set, it will be at
2380 * the bottom or right, depending if the box is vertical or horizontal,
2383 * @param obj The box object
2384 * @param subobj The object to add to the box
2386 * @see elm_box_pack_start()
2387 * @see elm_box_pack_before()
2388 * @see elm_box_pack_after()
2389 * @see elm_box_unpack()
2390 * @see elm_box_unpack_all()
2391 * @see elm_box_clear()
2393 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2395 * Adds an object to the box before the indicated object
2397 * This will add the @p subobj to the box indicated before the object
2398 * indicated with @p before. If @p before is not already in the box, results
2399 * are undefined. Before means either to the left of the indicated object or
2400 * above it depending on orientation.
2402 * @param obj The box object
2403 * @param subobj The object to add to the box
2404 * @param before The object before which to add it
2406 * @see elm_box_pack_start()
2407 * @see elm_box_pack_end()
2408 * @see elm_box_pack_after()
2409 * @see elm_box_unpack()
2410 * @see elm_box_unpack_all()
2411 * @see elm_box_clear()
2413 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2415 * Adds an object to the box after the indicated object
2417 * This will add the @p subobj to the box indicated after the object
2418 * indicated with @p after. If @p after is not already in the box, results
2419 * are undefined. After means either to the right of the indicated object or
2420 * below it depending on orientation.
2422 * @param obj The box object
2423 * @param subobj The object to add to the box
2424 * @param after The object after which to add it
2426 * @see elm_box_pack_start()
2427 * @see elm_box_pack_end()
2428 * @see elm_box_pack_before()
2429 * @see elm_box_unpack()
2430 * @see elm_box_unpack_all()
2431 * @see elm_box_clear()
2433 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2435 * Clear the box of all children
2437 * Remove all the elements contained by the box, deleting the respective
2440 * @param obj The box object
2442 * @see elm_box_unpack()
2443 * @see elm_box_unpack_all()
2445 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2449 * Remove the object given by @p subobj from the box @p obj without
2452 * @param obj The box object
2454 * @see elm_box_unpack_all()
2455 * @see elm_box_clear()
2457 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2459 * Remove all items from the box, without deleting them
2461 * Clear the box from all children, but don't delete the respective objects.
2462 * If no other references of the box children exist, the objects will never
2463 * be deleted, and thus the application will leak the memory. Make sure
2464 * when using this function that you hold a reference to all the objects
2465 * in the box @p obj.
2467 * @param obj The box object
2469 * @see elm_box_clear()
2470 * @see elm_box_unpack()
2472 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2474 * Retrieve a list of the objects packed into the box
2476 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2477 * The order of the list corresponds to the packing order the box uses.
2479 * You must free this list with eina_list_free() once you are done with it.
2481 * @param obj The box object
2483 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2485 * Set the space (padding) between the box's elements.
2487 * Extra space in pixels that will be added between a box child and its
2488 * neighbors after its containing cell has been calculated. This padding
2489 * is set for all elements in the box, besides any possible padding that
2490 * individual elements may have through their size hints.
2492 * @param obj The box object
2493 * @param horizontal The horizontal space between elements
2494 * @param vertical The vertical space between elements
2496 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2498 * Get the space (padding) between the box's elements.
2500 * @param obj The box object
2501 * @param horizontal The horizontal space between elements
2502 * @param vertical The vertical space between elements
2504 * @see elm_box_padding_set()
2506 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2508 * Set the alignment of the whole bouding box of contents.
2510 * Sets how the bounding box containing all the elements of the box, after
2511 * their sizes and position has been calculated, will be aligned within
2512 * the space given for the whole box widget.
2514 * @param obj The box object
2515 * @param horizontal The horizontal alignment of elements
2516 * @param vertical The vertical alignment of elements
2518 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2520 * Get the alignment of the whole bouding box of contents.
2522 * @param obj The box object
2523 * @param horizontal The horizontal alignment of elements
2524 * @param vertical The vertical alignment of elements
2526 * @see elm_box_align_set()
2528 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2531 * Set the layout defining function to be used by the box
2533 * Whenever anything changes that requires the box in @p obj to recalculate
2534 * the size and position of its elements, the function @p cb will be called
2535 * to determine what the layout of the children will be.
2537 * Once a custom function is set, everything about the children layout
2538 * is defined by it. The flags set by elm_box_horizontal_set() and
2539 * elm_box_homogeneous_set() no longer have any meaning, and the values
2540 * given by elm_box_padding_set() and elm_box_align_set() are up to this
2541 * layout function to decide if they are used and how. These last two
2542 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2543 * passed to @p cb. The @c Evas_Object the function receives is not the
2544 * Elementary widget, but the internal Evas Box it uses, so none of the
2545 * functions described here can be used on it.
2547 * Any of the layout functions in @c Evas can be used here, as well as the
2548 * special elm_box_layout_transition().
2550 * The final @p data argument received by @p cb is the same @p data passed
2551 * here, and the @p free_data function will be called to free it
2552 * whenever the box is destroyed or another layout function is set.
2554 * Setting @p cb to NULL will revert back to the default layout function.
2556 * @param obj The box object
2557 * @param cb The callback function used for layout
2558 * @param data Data that will be passed to layout function
2559 * @param free_data Function called to free @p data
2561 * @see elm_box_layout_transition()
2563 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);
2565 * Special layout function that animates the transition from one layout to another
2567 * Normally, when switching the layout function for a box, this will be
2568 * reflected immediately on screen on the next render, but it's also
2569 * possible to do this through an animated transition.
2571 * This is done by creating an ::Elm_Box_Transition and setting the box
2572 * layout to this function.
2576 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2577 * evas_object_box_layout_vertical, // start
2578 * NULL, // data for initial layout
2579 * NULL, // free function for initial data
2580 * evas_object_box_layout_horizontal, // end
2581 * NULL, // data for final layout
2582 * NULL, // free function for final data
2583 * anim_end, // will be called when animation ends
2584 * NULL); // data for anim_end function\
2585 * elm_box_layout_set(box, elm_box_layout_transition, t,
2586 * elm_box_transition_free);
2589 * @note This function can only be used with elm_box_layout_set(). Calling
2590 * it directly will not have the expected results.
2592 * @see elm_box_transition_new
2593 * @see elm_box_transition_free
2594 * @see elm_box_layout_set
2596 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
2598 * Create a new ::Elm_Box_Transition to animate the switch of layouts
2600 * If you want to animate the change from one layout to another, you need
2601 * to set the layout function of the box to elm_box_layout_transition(),
2602 * passing as user data to it an instance of ::Elm_Box_Transition with the
2603 * necessary information to perform this animation. The free function to
2604 * set for the layout is elm_box_transition_free().
2606 * The parameters to create an ::Elm_Box_Transition sum up to how long
2607 * will it be, in seconds, a layout function to describe the initial point,
2608 * another for the final position of the children and one function to be
2609 * called when the whole animation ends. This last function is useful to
2610 * set the definitive layout for the box, usually the same as the end
2611 * layout for the animation, but could be used to start another transition.
2613 * @param start_layout The layout function that will be used to start the animation
2614 * @param start_layout_data The data to be passed the @p start_layout function
2615 * @param start_layout_free_data Function to free @p start_layout_data
2616 * @param end_layout The layout function that will be used to end the animation
2617 * @param end_layout_free_data The data to be passed the @p end_layout function
2618 * @param end_layout_free_data Function to free @p end_layout_data
2619 * @param transition_end_cb Callback function called when animation ends
2620 * @param transition_end_data Data to be passed to @p transition_end_cb
2621 * @return An instance of ::Elm_Box_Transition
2623 * @see elm_box_transition_new
2624 * @see elm_box_layout_transition
2626 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);
2628 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
2630 * This function is mostly useful as the @c free_data parameter in
2631 * elm_box_layout_set() when elm_box_layout_transition().
2633 * @param data The Elm_Box_Transition instance to be freed.
2635 * @see elm_box_transition_new
2636 * @see elm_box_layout_transition
2638 EAPI void elm_box_transition_free(void *data);
2645 * @defgroup Button Button
2647 * @image html widget/button/preview-00.png
2648 * @image html widget/button/preview-01.png
2649 * @image html widget/button/preview-02.png
2651 * This is a push-button. Press it and run some function. It can contain
2652 * a simple label and icon object and it also has an autorepeat feature.
2654 * This widgets emits the following signals:
2655 * @li "clicked": the user clicked the button (press/release).
2656 * @li "repeated": the user pressed the button without releasing it.
2657 * @li "pressed": button was pressed.
2658 * @li "unpressed": button was released after being pressed.
2659 * In all three cases, the @c event parameter of the callback will be
2662 * Also, defined in the default theme, the button has the following styles
2664 * @li default: a normal button.
2665 * @li anchor: Like default, but the button fades away when the mouse is not
2666 * over it, leaving only the text or icon.
2667 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
2668 * continuous look across its options.
2669 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
2671 * Follow through a complete example @ref button_example_01 "here".
2677 UIControlStateDefault,
2678 UIControlStateHighlighted,
2679 UIControlStateDisabled,
2680 UIControlStateFocused,
2681 UIControlStateReserved
2685 * Add a new button to the parent's canvas
2687 * @param parent The parent object
2688 * @return The new object or NULL if it cannot be created
2690 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2692 * Set the label used in the button
2694 * The passed @p label can be NULL to clean any existing text in it and
2695 * leave the button as an icon only object.
2697 * @param obj The button object
2698 * @param label The text will be written on the button
2699 * @deprecated use elm_object_text_set() instead.
2701 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2703 * Get the label set for the button
2705 * The string returned is an internal pointer and should not be freed or
2706 * altered. It will also become invalid when the button is destroyed.
2707 * The string returned, if not NULL, is a stringshare, so if you need to
2708 * keep it around even after the button is destroyed, you can use
2709 * eina_stringshare_ref().
2711 * @param obj The button object
2712 * @return The text set to the label, or NULL if nothing is set
2713 * @deprecated use elm_object_text_set() instead.
2715 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2717 * Set the label for each state of button
2719 * The passed @p label can be NULL to clean any existing text in it and
2720 * leave the button as an icon only object for the state.
2722 * @param obj The button object
2723 * @param label The text will be written on the button
2724 * @param state The state of button
2728 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
2730 * Get the label of button for each state
2732 * The string returned is an internal pointer and should not be freed or
2733 * altered. It will also become invalid when the button is destroyed.
2734 * The string returned, if not NULL, is a stringshare, so if you need to
2735 * keep it around even after the button is destroyed, you can use
2736 * eina_stringshare_ref().
2738 * @param obj The button object
2739 * @param state The state of button
2740 * @return The title of button for state
2744 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
2746 * Set the icon used for the button
2748 * Setting a new icon will delete any other that was previously set, making
2749 * any reference to them invalid. If you need to maintain the previous
2750 * object alive, unset it first with elm_button_icon_unset().
2752 * @param obj The button object
2753 * @param icon The icon object for the button
2755 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2757 * Get the icon used for the button
2759 * Return the icon object which is set for this widget. If the button is
2760 * destroyed or another icon is set, the returned object will be deleted
2761 * and any reference to it will be invalid.
2763 * @param obj The button object
2764 * @return The icon object that is being used
2766 * @see elm_button_icon_unset()
2768 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2770 * Remove the icon set without deleting it and return the object
2772 * This function drops the reference the button holds of the icon object
2773 * and returns this last object. It is used in case you want to remove any
2774 * icon, or set another one, without deleting the actual object. The button
2775 * will be left without an icon set.
2777 * @param obj The button object
2778 * @return The icon object that was being used
2780 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2782 * Turn on/off the autorepeat event generated when the button is kept pressed
2784 * When off, no autorepeat is performed and buttons emit a normal @c clicked
2785 * signal when they are clicked.
2787 * When on, keeping a button pressed will continuously emit a @c repeated
2788 * signal until the button is released. The time it takes until it starts
2789 * emitting the signal is given by
2790 * elm_button_autorepeat_initial_timeout_set(), and the time between each
2791 * new emission by elm_button_autorepeat_gap_timeout_set().
2793 * @param obj The button object
2794 * @param on A bool to turn on/off the event
2796 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
2798 * Get whether the autorepeat feature is enabled
2800 * @param obj The button object
2801 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
2803 * @see elm_button_autorepeat_set()
2805 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2807 * Set the initial timeout before the autorepeat event is generated
2809 * Sets the timeout, in seconds, since the button is pressed until the
2810 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
2811 * won't be any delay and the even will be fired the moment the button is
2814 * @param obj The button object
2815 * @param t Timeout in seconds
2817 * @see elm_button_autorepeat_set()
2818 * @see elm_button_autorepeat_gap_timeout_set()
2820 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2822 * Get the initial timeout before the autorepeat event is generated
2824 * @param obj The button object
2825 * @return Timeout in seconds
2827 * @see elm_button_autorepeat_initial_timeout_set()
2829 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2831 * Set the interval between each generated autorepeat event
2833 * After the first @c repeated event is fired, all subsequent ones will
2834 * follow after a delay of @p t seconds for each.
2836 * @param obj The button object
2837 * @param t Interval in seconds
2839 * @see elm_button_autorepeat_initial_timeout_set()
2841 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2843 * Get the interval between each generated autorepeat event
2845 * @param obj The button object
2846 * @return Interval in seconds
2848 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2854 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2855 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2856 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2857 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2858 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2859 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2860 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2861 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2862 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2863 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2864 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2865 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2866 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2867 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2868 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2869 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2870 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2871 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2872 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2873 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2874 /* available styles:
2878 * hoversel_vertical_entry
2880 /* smart callbacks called:
2881 * "file,chosen" - the user has selected a path, whose string pointer comes
2885 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2886 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2887 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2888 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2889 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2890 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2891 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2892 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2893 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2894 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2895 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2896 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2897 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2898 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2899 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2900 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2901 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2902 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2903 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2904 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2905 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2906 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2908 /* scroller policy */
2909 typedef enum _Elm_Scroller_Policy
2911 ELM_SCROLLER_POLICY_AUTO = 0,
2912 ELM_SCROLLER_POLICY_ON,
2913 ELM_SCROLLER_POLICY_OFF,
2914 ELM_SCROLLER_POLICY_LAST
2915 } Elm_Scroller_Policy;
2917 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2918 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
2919 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2920 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2921 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
2922 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
2923 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);
2924 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
2925 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
2926 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);
2927 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2928 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2929 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2930 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2931 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2932 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);
2933 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
2934 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
2935 EINA_DEPRECATED EAPI void elm_scroller_page_move_set(Evas_Object *obj, Eina_Bool set);
2936 /* smart callbacks called:
2937 * "edge,left" - the left edge of the content has been reached
2938 * "edge,right" - the right edge of the content has been reached
2939 * "edge,top" - the top edge of the content has been reached
2940 * "edge,bottom" - the bottom edge of the content has been reached
2941 * "scroll" - the content has been scrolled (moved)
2942 * "scroll,anim,start" - scrolling animation has started
2943 * "scroll,anim,stop" - scrolling animation has stopped
2944 * "scroll,drag,start" - dragging the contents around has started
2945 * "scroll,drag,stop" - dragging the contents around has stopped
2949 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2950 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 */
2951 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
2952 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
2953 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2954 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
2955 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2956 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
2957 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2958 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
2959 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);
2960 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
2961 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);
2962 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
2963 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
2964 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
2965 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2966 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
2967 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2968 /* available styles:
2972 /* smart callbacks called:
2976 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2977 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2978 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2979 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2980 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2981 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2982 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
2983 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
2984 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
2985 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2986 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
2987 /* smart callbacks called:
2988 * "changed" - Whenever the toggle value has been changed. Is not called
2989 * until the toggle is released by the cursor (assuming it has been triggered
2990 * by the cursor in the first place).
2994 * @page tutorial_frame Frame example
2995 * @dontinclude frame_example_01.c
2997 * In this example we are going to create 4 Frames with different styles and
2998 * add a rectangle of different color in each.
3000 * We start we the usual setup code:
3003 * And then create one rectangle:
3006 * To add it in our first frame, which since it doesn't have it's style
3007 * specifically set uses the default style:
3010 * And then create another rectangle:
3013 * To add it in our second frame, which uses the "pad_small" style, note that
3014 * even tough we are setting a text for this frame it won't be show, only the
3015 * default style shows the Frame's title:
3017 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
3018 * very similar, their only difference is the size of the empty area around
3019 * the content of the frame.
3021 * And then create yet another rectangle:
3024 * To add it in our third frame, which uses the "outdent_top" style, note
3025 * that even tough we are setting a text for this frame it won't be show,
3026 * only the default style shows the Frame's title:
3029 * And then create one last rectangle:
3032 * To add it in our fourth and final frame, which uses the "outdent_bottom"
3033 * style, note that even tough we are setting a text for this frame it won't
3034 * be show, only the default style shows the Frame's title:
3037 * And now we are left with just some more setup code:
3040 * Our example will look like this:
3041 * @image html screenshots/frame_example_01.png
3042 * @image latex screenshots/frame_example_01.eps
3044 * @example frame_example_01.c
3047 * @defgroup Frame Frame
3049 * @brief Frame is a widget that holds some content and has a title.
3051 * The default look is a frame with a title, but Frame supports multple
3059 * @li outdent_bottom
3061 * Of all this styles only default shows the title. Frame emits no signals.
3063 * For a detailed example see the @ref tutorial_frame.
3068 * @brief Add a new frame to the parent
3070 * @param parent The parent object
3071 * @return The new object or NULL if it cannot be created
3073 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3075 * @brief Set the frame label
3077 * @param obj The frame object
3078 * @param label The label of this frame object
3080 * @deprecated use elm_object_text_set() instead.
3082 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3084 * @brief Get the frame label
3086 * @param obj The frame object
3088 * @return The label of this frame objet or NULL if unable to get frame
3090 * @deprecated use elm_object_text_get() instead.
3092 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3094 * @brief Set the content of the frame widget
3096 * Once the content object is set, a previously set one will be deleted.
3097 * If you want to keep that old content object, use the
3098 * elm_frame_content_unset() function.
3100 * @param obj The frame object
3101 * @param content The content will be filled in this frame object
3103 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3105 * @brief Get the content of the frame widget
3107 * Return the content object which is set for this widget
3109 * @param obj The frame object
3110 * @return The content that is being used
3112 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3114 * @brief Unset the content of the frame widget
3116 * Unparent and return the content object which was set for this widget
3118 * @param obj The frame object
3119 * @return The content that was being used
3121 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3127 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3128 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3129 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3130 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3131 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3132 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3133 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3134 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3135 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3136 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
3137 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3138 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
3141 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
3142 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
3143 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
3144 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
3145 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
3146 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
3147 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
3149 struct _Elm_Gengrid_Item_Class
3151 const char *item_style;
3152 struct _Elm_Gengrid_Item_Class_Func
3154 GridItemLabelGetFunc label_get;
3155 GridItemIconGetFunc icon_get;
3156 GridItemStateGetFunc state_get;
3157 GridItemDelFunc del;
3161 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3162 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
3163 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3164 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
3165 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
3167 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
3168 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3169 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
3170 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3171 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
3172 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3173 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
3174 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3175 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3176 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3177 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3178 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
3179 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3180 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
3181 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3183 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3184 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3186 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3187 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3188 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3189 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3190 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3191 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3192 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
3193 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3194 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
3195 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
3196 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3197 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3198 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3199 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3200 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3201 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3202 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3204 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
3205 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);
3206 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3207 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3208 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3209 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3210 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3211 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3212 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3213 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3214 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3215 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3217 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3218 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3219 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3221 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);
3222 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);
3223 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);
3224 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);
3225 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);
3226 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);
3227 /* smart callbacks called:
3229 * selected - User has selected an item.
3230 * unselected - User has unselected an item.
3231 * clicked,double - User has double-clicked or pressed enter on an item.
3232 * realized - An evas object for an item was built.
3233 * unrealized - An evas object for an item was deleted.
3234 * changed - An item has been added, removed, resized or moved,
3235 * or gengrid has been resized or horizontal property has been changed.
3236 * scroll - the content has been scrolled (moved).
3237 * "scroll,drag,start" - dragging the contents around has started.
3238 * "scroll,drag,stop" - dragging the contents around has stopped.
3239 * drag - Gengrid is being dragged.
3240 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
3241 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
3242 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
3243 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
3244 * "drag,stop" - Gengrid is not being dragged.
3248 * @defgroup Clock Clock
3250 * This is a @b digital clock widget. In its default theme, it has a
3251 * vintage "flipping numbers clock" appearance, which will animate
3252 * sheets of individual algarisms individually as time goes by.
3254 * A newly created clock will fetch system's time (already
3255 * considering local time adjustments) to start with, and will tick
3256 * accondingly. It may or may not show seconds.
3258 * Clocks have an @b edition mode. When in it, the sheets will
3259 * display extra arrow indications on the top and bottom and the
3260 * user may click on them to raise or lower the time values. After
3261 * it's told to exit edition mode, it will keep ticking with that
3262 * new time set (it keeps the difference from local time).
3264 * Also, when under edition mode, user clicks on the cited arrows
3265 * which are @b held for some time will make the clock to flip the
3266 * sheet, thus editing the time, continuosly and automatically for
3267 * the user. The interval between sheet flips will keep growing in
3268 * time, so that it helps the user to reach a time which is distant
3271 * The time display is, by default, in military mode (24h), but an
3272 * am/pm indicator may be optionally shown, too, when it will
3275 * Smart callbacks one can register to:
3276 * - "changed" - the clock's user changed the time
3278 * Here is an example on its usage:
3279 * @li @ref clock_example
3288 * Identifiers for which clock digits should be editable, when a
3289 * clock widget is in edition mode. Values may be ORed together to
3290 * make a mask, naturally.
3292 * @see elm_clock_edit_set()
3293 * @see elm_clock_digit_edit_set()
3295 typedef enum _Elm_Clock_Digedit
3297 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
3298 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
3299 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
3300 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
3301 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
3302 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
3303 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
3304 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
3305 } Elm_Clock_Digedit;
3308 * Add a new clock widget to the given parent Elementary
3309 * (container) object
3311 * @param parent The parent object
3312 * @return a new clock widget handle or @c NULL, on errors
3314 * This function inserts a new clock widget on the canvas.
3318 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3321 * Set a clock widget's time, programmatically
3323 * @param obj The clock widget object
3324 * @param hrs The hours to set
3325 * @param min The minutes to set
3326 * @param sec The secondes to set
3328 * This function updates the time that is showed by the clock
3331 * Values @b must be set within the following ranges:
3332 * - 0 - 23, for hours
3333 * - 0 - 59, for minutes
3334 * - 0 - 59, for seconds,
3336 * even if the clock is not in "military" mode.
3338 * @warning The behavior for values set out of those ranges is @b
3343 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
3346 * Get a clock widget's time values
3348 * @param obj The clock object
3349 * @param[out] hrs Pointer to the variable to get the hours value
3350 * @param[out] min Pointer to the variable to get the minutes value
3351 * @param[out] sec Pointer to the variable to get the seconds value
3353 * This function gets the time set for @p obj, returning
3354 * it on the variables passed as the arguments to function
3356 * @note Use @c NULL pointers on the time values you're not
3357 * interested in: they'll be ignored by the function.
3361 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
3364 * Set whether a given clock widget is under <b>edition mode</b> or
3365 * under (default) displaying-only mode.
3367 * @param obj The clock object
3368 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
3369 * put it back to "displaying only" mode
3371 * This function makes a clock's time to be editable or not <b>by
3372 * user interaction</b>. When in edition mode, clocks @b stop
3373 * ticking, until one brings them back to canonical mode. The
3374 * elm_clock_digit_edit_set() function will influence which digits
3375 * of the clock will be editable. By default, all of them will be
3376 * (#ELM_CLOCK_NONE).
3378 * @note am/pm sheets, if being shown, will @b always be editable
3379 * under edition mode.
3381 * @see elm_clock_edit_get()
3385 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
3388 * Retrieve whether a given clock widget is under <b>edition
3389 * mode</b> or under (default) displaying-only mode.
3391 * @param obj The clock object
3392 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
3395 * This function retrieves whether the clock's time can be edited
3396 * or not by user interaction.
3398 * @see elm_clock_edit_set() for more details
3402 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3405 * Set what digits of the given clock widget should be editable
3406 * when in edition mode.
3408 * @param obj The clock object
3409 * @param digedit Bit mask indicating the digits to be editable
3410 * (values in #Elm_Clock_Digedit).
3412 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
3413 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
3416 * @see elm_clock_digit_edit_get()
3420 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
3423 * Retrieve what digits of the given clock widget should be
3424 * editable when in edition mode.
3426 * @param obj The clock object
3427 * @return Bit mask indicating the digits to be editable
3428 * (values in #Elm_Clock_Digedit).
3430 * @see elm_clock_digit_edit_set() for more details
3434 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3437 * Set if the given clock widget must show hours in military or
3440 * @param obj The clock object
3441 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
3444 * This function sets if the clock must show hours in military or
3445 * am/pm mode. In some countries like Brazil the military mode
3446 * (00-24h-format) is used, in opposition to the USA, where the
3447 * am/pm mode is more commonly used.
3449 * @see elm_clock_show_am_pm_get()
3453 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
3456 * Get if the given clock widget shows hours in military or am/pm
3459 * @param obj The clock object
3460 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
3463 * This function gets if the clock shows hours in military or am/pm
3466 * @see elm_clock_show_am_pm_set() for more details
3470 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3473 * Set if the given clock widget must show time with seconds or not
3475 * @param obj The clock object
3476 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
3478 * This function sets if the given clock must show or not elapsed
3479 * seconds. By default, they are @b not shown.
3481 * @see elm_clock_show_seconds_get()
3485 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
3488 * Get whether the given clock widget is showing time with seconds
3491 * @param obj The clock object
3492 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
3494 * This function gets whether @p obj is showing or not the elapsed
3497 * @see elm_clock_show_seconds_set()
3501 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3504 * Set the interval on time updates for an user mouse button hold
3505 * on clock widgets' time edition.
3507 * @param obj The clock object
3508 * @param interval The (first) interval value in seconds
3510 * This interval value is @b decreased while the user holds the
3511 * mouse pointer either incrementing or decrementing a given the
3512 * clock digit's value.
3514 * This helps the user to get to a given time distant from the
3515 * current one easier/faster, as it will start to flip quicker and
3516 * quicker on mouse button holds.
3518 * The calculation for the next flip interval value, starting from
3519 * the one set with this call, is the previous interval divided by
3520 * 1.05, so it decreases a little bit.
3522 * The default starting interval value for automatic flips is
3525 * @see elm_clock_interval_get()
3529 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
3532 * Get the interval on time updates for an user mouse button hold
3533 * on clock widgets' time edition.
3535 * @param obj The clock object
3536 * @return The (first) interval value, in seconds, set on it
3538 * @see elm_clock_interval_set() for more details
3542 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3549 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3550 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
3551 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
3552 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3553 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3554 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3555 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
3556 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
3557 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3558 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3559 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
3560 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
3561 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
3562 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3563 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);
3564 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
3565 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3566 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3567 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
3568 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
3569 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
3570 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3571 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3572 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
3573 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3574 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);
3575 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3577 * @def elm_layout_icon_set
3578 * Convienience macro to set the icon object in a layout that follows the
3579 * Elementary naming convention for its parts.
3583 #define elm_layout_icon_set(_ly, _obj) \
3586 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
3587 if ((_obj)) sig = "elm,state,icon,visible"; \
3588 else sig = "elm,state,icon,hidden"; \
3589 elm_object_signal_emit((_ly), sig, "elm"); \
3593 * @def elm_layout_icon_get
3594 * Convienience macro to get the icon object from a layout that follows the
3595 * Elementary naming convention for its parts.
3599 #define elm_layout_icon_get(_ly) \
3600 elm_layout_content_get((_ly), "elm.swallow.icon")
3603 * @def elm_layout_end_set
3604 * Convienience macro to set the end object in a layout that follows the
3605 * Elementary naming convention for its parts.
3609 #define elm_layout_end_set(_ly, _obj) \
3612 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
3613 if ((_obj)) sig = "elm,state,end,visible"; \
3614 else sig = "elm,state,end,hidden"; \
3615 elm_object_signal_emit((_ly), sig, "elm"); \
3619 * @def elm_layout_end_get
3620 * Convienience macro to get the end object in a layout that follows the
3621 * Elementary naming convention for its parts.
3625 #define elm_layout_end_get(_ly) \
3626 elm_layout_content_get((_ly), "elm.swallow.end")
3629 * @def elm_layout_label_set
3630 * Convienience macro to set the label in a layout that follows the
3631 * Elementary naming convention for its parts.
3634 * @deprecate use elm_object_text_* instead.
3636 #define elm_layout_label_set(_ly, _txt) \
3637 elm_layout_text_set((_ly), "elm.text", (_txt))
3640 * @def elm_layout_label_get
3641 * Convienience macro to get the label in a layout that follows the
3642 * Elementary naming convention for its parts.
3645 * @deprecate use elm_object_text_* instead.
3647 #define elm_layout_label_get(_ly) \
3648 elm_layout_text_get((_ly), "elm.text")
3650 /* smart callbacks called:
3654 typedef enum _Elm_Notify_Orient
3656 ELM_NOTIFY_ORIENT_TOP,
3657 ELM_NOTIFY_ORIENT_CENTER,
3658 ELM_NOTIFY_ORIENT_BOTTOM,
3659 ELM_NOTIFY_ORIENT_LEFT,
3660 ELM_NOTIFY_ORIENT_RIGHT,
3661 ELM_NOTIFY_ORIENT_TOP_LEFT,
3662 ELM_NOTIFY_ORIENT_TOP_RIGHT,
3663 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
3664 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
3665 ELM_NOTIFY_ORIENT_LAST
3666 } Elm_Notify_Orient;
3667 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3668 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3669 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3670 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3671 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3672 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3673 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
3674 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3675 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
3676 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3677 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
3678 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3679 /* smart callbacks called:
3680 * "timeout" - when timeout happens on notify and it's hidden
3681 * "block,clicked" - when it's hidden by a click outside of the notify's view
3685 typedef enum _Elm_Hover_Axis
3687 ELM_HOVER_AXIS_NONE,
3688 ELM_HOVER_AXIS_HORIZONTAL,
3689 ELM_HOVER_AXIS_VERTICAL,
3692 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3693 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
3694 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3695 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3696 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3697 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3698 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3699 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3700 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
3701 /* available styles:
3707 /* smart callbacks called:
3708 * "clicked" - the user clicked the empty space in the hover to dismiss
3709 * "smart,changed" - a content object placed under the "smart"
3710 * policy was replaced to a new slot direction.
3714 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
3715 struct _Elm_Entry_Anchor_Info
3719 Evas_Coord x, y, w, h;
3721 typedef enum _Elm_Icon_Type
3728 typedef enum _Elm_Input_Panel_Layout
3730 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default 4x4 layout */
3731 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
3732 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
3733 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
3734 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
3735 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
3736 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
3737 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
3738 ELM_INPUT_PANEL_LAYOUT_CUSTOM_1 = 100, /* Reserved for future use */
3739 ELM_INPUT_PANEL_LAYOUT_CUSTOM_2,
3740 ELM_INPUT_PANEL_LAYOUT_CUSTOM_3,
3741 ELM_INPUT_PANEL_LAYOUT_CUSTOM_4,
3742 ELM_INPUT_PANEL_LAYOUT_CUSTOM_5,
3743 ELM_INPUT_PANEL_LAYOUT_CUSTOM_6,
3744 ELM_INPUT_PANEL_LAYOUT_CUSTOM_7,
3745 ELM_INPUT_PANEL_LAYOUT_CUSTOM_8,
3746 ELM_INPUT_PANEL_LAYOUT_CUSTOM_9,
3747 ELM_INPUT_PANEL_LAYOUT_CUSTOM_10
3748 } Elm_Input_Panel_Layout;
3750 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
3752 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3753 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
3754 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3755 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
3756 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3757 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3758 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3759 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3760 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3761 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3762 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3763 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3764 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
3765 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3766 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
3767 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3768 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
3769 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3770 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
3771 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
3772 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
3773 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
3774 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3775 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3776 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3777 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3778 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
3779 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3780 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3781 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3782 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3783 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);
3784 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
3785 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3786 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
3787 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
3788 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
3789 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3790 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);
3791 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3792 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3793 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);
3794 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);
3795 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);
3796 EAPI void elm_entry_text_filter_append(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
3797 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
3798 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
3799 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3800 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3801 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
3802 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
3803 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
3804 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
3805 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3806 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
3807 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3808 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
3809 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
3810 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
3811 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
3812 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
3813 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
3814 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
3815 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
3816 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
3817 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
3818 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
3819 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
3820 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
3822 /* pre-made filters for entries */
3823 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
3824 struct _Elm_Entry_Filter_Limit_Size
3829 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
3830 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
3831 struct _Elm_Entry_Filter_Accept_Set
3833 const char *accepted;
3834 const char *rejected;
3836 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
3837 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3838 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
3839 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
3840 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
3841 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
3842 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
3843 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
3844 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
3845 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
3847 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
3848 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
3849 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
3850 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3851 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
3853 /* smart callbacks called:
3854 * "changed" - the text content changed
3855 * "selection,start" - the user started selecting text
3856 * "selection,changed" - the user modified the selection size/location
3857 * "selection,cleared" - the user cleared the selection
3858 * "selection,paste" - the user requested a paste of text
3859 * "selection,copy" - the user copied the text
3860 * "selection,cut" - the user cut the text
3861 * "cursor,changed" - the cursor changed position
3862 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
3863 * "activated" - when the enter key is pressed (useful for single line)
3864 * "press" - when finger/mouse is pressed down
3865 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
3866 * "clicked,double" - when finger/mouse is double-pressed
3867 * "longpressed" - the entry has been longpressed
3868 * "focused" - the entry has received keyboard focus
3869 * "unfocused" - keyboard focus is gone
3872 /* composite widgets - these basically put together basic widgets above
3873 * in convenient packages that do more than basic stuff */
3877 * @defgroup Anchorview Anchorview
3879 * Anchorview is for displaying text that contains markup with anchors
3880 * like <c>\<a href=1234\>something\</\></c> in it.
3882 * Besides being styled differently, the anchorview widget provides the
3883 * necessary functionality so that clicking on these anchors brings up a
3884 * popup with user defined content such as "call", "add to contacts" or
3885 * "open web page". This popup is provided using the @ref Hover widget.
3887 * This widget is very similar to @ref Anchorblock, so refer to that
3888 * widget for an example. The only difference Anchorview has is that the
3889 * widget is already provided with scrolling functionality, so if the
3890 * text set to it is too large to fit in the given space, it will scroll,
3891 * whereas the @ref Anchorblock widget will keep growing to ensure all the
3892 * text can be displayed.
3894 * This widget emits the following signals:
3895 * @li "anchor,clicked": will be called when an anchor is clicked. The
3896 * @p event_info parameter on the callback will be a pointer of type
3897 * ::Elm_Entry_Anchorview_Info.
3899 * See @ref Anchorblock for an example on how to use both of them.
3908 * @typedef Elm_Entry_Anchorview_Info
3910 * The info sent in the callback for "anchor,clicked" signals emitted by
3911 * the Anchorview widget.
3913 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
3915 * @struct _Elm_Entry_Anchorview_Info
3917 * The info sent in the callback for "anchor,clicked" signals emitted by
3918 * the Anchorview widget.
3920 struct _Elm_Entry_Anchorview_Info
3922 const char *name; /**< Name of the anchor, as indicated in its href
3924 int button; /**< The mouse button used to click on it */
3925 Evas_Object *hover; /**< The hover object to use for the popup */
3927 Evas_Coord x, y, w, h;
3928 } anchor, /**< Geometry selection of text used as anchor */
3929 hover_parent; /**< Geometry of the object used as parent by the
3931 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
3932 for content on the left side of
3933 the hover. Before calling the
3934 callback, the widget will make the
3935 necessary calculations to check
3936 which sides are fit to be set with
3937 content, based on the position the
3938 hover is activated and its distance
3939 to the edges of its parent object
3941 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
3942 the right side of the hover.
3943 See @ref hover_left */
3944 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
3945 of the hover. See @ref hover_left */
3946 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
3947 below the hover. See @ref
3951 * Add a new Anchorview object
3953 * @param parent The parent object
3954 * @return The new object or NULL if it cannot be created
3956 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3958 * Set the text to show in the anchorview
3960 * Sets the text of the anchorview to @p text. This text can include markup
3961 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
3962 * text that will be specially styled and react to click events, ended with
3963 * either of \</a\> or \</\>. When clicked, the anchor will emit an
3964 * "anchor,clicked" signal that you can attach a callback to with
3965 * evas_object_smart_callback_add(). The name of the anchor given in the
3966 * event info struct will be the one set in the href attribute, in this
3969 * Other markup can be used to style the text in different ways, but it's
3970 * up to the style defined in the theme which tags do what.
3971 * @deprecated use elm_object_text_set() instead.
3973 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
3975 * Get the markup text set for the anchorview
3977 * Retrieves the text set on the anchorview, with markup tags included.
3979 * @param obj The anchorview object
3980 * @return The markup text set or @c NULL if nothing was set or an error
3982 * @deprecated use elm_object_text_set() instead.
3984 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3986 * Set the parent of the hover popup
3988 * Sets the parent object to use by the hover created by the anchorview
3989 * when an anchor is clicked. See @ref Hover for more details on this.
3990 * If no parent is set, the same anchorview object will be used.
3992 * @param obj The anchorview object
3993 * @param parent The object to use as parent for the hover
3995 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3997 * Get the parent of the hover popup
3999 * Get the object used as parent for the hover created by the anchorview
4000 * widget. See @ref Hover for more details on this.
4002 * @param obj The anchorview object
4003 * @return The object used as parent for the hover, NULL if none is set.
4005 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4007 * Set the style that the hover should use
4009 * When creating the popup hover, anchorview will request that it's
4010 * themed according to @p style.
4012 * @param obj The anchorview object
4013 * @param style The style to use for the underlying hover
4015 * @see elm_object_style_set()
4017 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4019 * Get the style that the hover should use
4021 * Get the style the hover created by anchorview will use.
4023 * @param obj The anchorview object
4024 * @return The style to use by the hover. NULL means the default is used.
4026 * @see elm_object_style_set()
4028 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4030 * Ends the hover popup in the anchorview
4032 * When an anchor is clicked, the anchorview widget will create a hover
4033 * object to use as a popup with user provided content. This function
4034 * terminates this popup, returning the anchorview to its normal state.
4036 * @param obj The anchorview object
4038 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4040 * Set bouncing behaviour when the scrolled content reaches an edge
4042 * Tell the internal scroller object whether it should bounce or not
4043 * when it reaches the respective edges for each axis.
4045 * @param obj The anchorview object
4046 * @param h_bounce Whether to bounce or not in the horizontal axis
4047 * @param v_bounce Whether to bounce or not in the vertical axis
4049 * @see elm_scroller_bounce_set()
4051 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4053 * Get the set bouncing behaviour of the internal scroller
4055 * Get whether the internal scroller should bounce when the edge of each
4056 * axis is reached scrolling.
4058 * @param obj The anchorview object
4059 * @param h_bounce Pointer where to store the bounce state of the horizontal
4061 * @param v_bounce Pointer where to store the bounce state of the vertical
4064 * @see elm_scroller_bounce_get()
4066 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4068 * Appends a custom item provider to the given anchorview
4070 * Appends the given function to the list of items providers. This list is
4071 * called, one function at a time, with the given @p data pointer, the
4072 * anchorview object and, in the @p item parameter, the item name as
4073 * referenced in its href string. Following functions in the list will be
4074 * called in order until one of them returns something different to NULL,
4075 * which should be an Evas_Object which will be used in place of the item
4078 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4079 * href=item/name\>\</item\>
4081 * @param obj The anchorview object
4082 * @param func The function to add to the list of providers
4083 * @param data User data that will be passed to the callback function
4085 * @see elm_entry_item_provider_append()
4087 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);
4089 * Prepend a custom item provider to the given anchorview
4091 * Like elm_anchorview_item_provider_append(), but it adds the function
4092 * @p func to the beginning of the list, instead of the end.
4094 * @param obj The anchorview object
4095 * @param func The function to add to the list of providers
4096 * @param data User data that will be passed to the callback function
4098 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);
4100 * Remove a custom item provider from the list of the given anchorview
4102 * Removes the function and data pairing that matches @p func and @p data.
4103 * That is, unless the same function and same user data are given, the
4104 * function will not be removed from the list. This allows us to add the
4105 * same callback several times, with different @p data pointers and be
4106 * able to remove them later without conflicts.
4108 * @param obj The anchorview object
4109 * @param func The function to remove from the list
4110 * @param data The data matching the function to remove from the list
4112 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);
4119 * @defgroup Anchorblock Anchorblock
4121 * Anchorblock is for displaying text that contains markup with anchors
4122 * like <c>\<a href=1234\>something\</\></c> in it.
4124 * Besides being styled differently, the anchorblock widget provides the
4125 * necessary functionality so that clicking on these anchors brings up a
4126 * popup with user defined content such as "call", "add to contacts" or
4127 * "open web page". This popup is provided using the @ref Hover widget.
4129 * This widget emits the following signals:
4130 * @li "anchor,clicked": will be called when an anchor is clicked. The
4131 * @p event_info parameter on the callback will be a pointer of type
4132 * ::Elm_Entry_Anchorblock_Info.
4138 * Since examples are usually better than plain words, we might as well
4139 * try @ref tutorial_anchorblock_example "one".
4142 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
4143 * This exampel will show both Anchorblock and @ref Anchorview,
4144 * since both are very similar and it's easier to show them once and side
4145 * by side, so the difference is more clear.
4147 * We'll show the relevant snippets of the code here, but the full example
4148 * can be found here... sorry, @ref anchorblock_example_01.c "here".
4150 * As for the actual example, it's just a simple window with an anchorblock
4151 * and an anchorview, both containing the same text. After including
4152 * Elementary.h and declaring some functions we'll need, we jump to our
4153 * elm_main (see ELM_MAIN) and create our window.
4154 * @dontinclude anchorblock_example_01.c
4159 * With the needed variables declared, we'll create the window and a box to
4160 * hold our widgets, but we don't need to go through that here.
4162 * In order to make clear where the anchorblock ends and the anchorview
4163 * begins, they'll be each inside a @ref Frame. After creating the frame,
4164 * the anchorblock follows.
4165 * @skip elm_frame_add
4166 * @until elm_frame_content_set
4168 * Nothing out of the ordinary there. What's worth mentioning is the call
4169 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
4170 * when an anchor is clicked, the hover for the popup will cover the entire
4171 * window. This affects the area that will be obscured by the hover and
4172 * where clicking will dismiss it, as well as the calculations it does to
4173 * inform the best locations where to insert the popups content.
4174 * Other than that, the code is pretty standard. We also need to set our
4175 * callback for when an anchor is clicked, since it's our task to populate
4176 * the popup. There's no default for it.
4178 * The anchorview is no different, we only change a few things so it looks
4180 * @until elm_frame_content_set
4182 * Then we run, so stuff works and close our main function in the usual way.
4185 * Now, a little note. Normally you would use either one of anchorblock or
4186 * anchorview, set your one callback to clicks and do your stuff in there.
4187 * In this example, however, there are a few tricks to make it easier to
4188 * show both widgets in one go (and to save me some typing). So we have
4189 * two callbacks, one per widget, that will call a common function to do
4190 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
4191 * anchorview too, since both are equal, and passing a callback to use
4192 * for our buttons to end the hover, because each widget has a different
4194 * @until _anchorview_clicked_cb
4197 * The meat of our popup is in the following function. We check what kind
4198 * of menu we need to show, based on the name set to the anchor in the
4199 * markup text. If there's no type (something went wrong, no valid contact
4200 * in the address list) we are just putting a button that does nothing, but
4201 * it's perfectly reasonable to just end the hover and call it quits.
4203 * Our popup will consist of one main button in the middle of our hover,
4204 * and possibly a secondary button and a list of other options. We'll create
4205 * first our main button and check what kind of popup we need afterwards.
4208 * @until eina_stringshare_add
4211 * Each button has two callbacks, one is our hack to close the hover
4212 * properly based on which widget it belongs to, the other a simple
4213 * printf that will show the action with the anchors own data. This is
4214 * not how you would usually do it. Instead, the common case is to have
4215 * one callback for the button that will know which function to call to end
4216 * things, but since we are doing it this way it's worth noting that
4217 * smart callbacks will be called in reverse in respect to the order they
4218 * were added, and since our @c btn_end_cb will close the hover, and thus
4219 * delete our buttons, the other callback wouldn't be called if we had
4222 * After our telephone popup, there are a few others that are practically
4223 * the same, so they won't be shown here.
4225 * Once we are done with that, it's time to place our actions into our
4226 * hover. Main button goes in the middle without much questioning, and then
4227 * we see if we have a secondary button and a box of extra options.
4228 * Because I said so, secondary button goes on either side and box of
4229 * options either on top or below the main one, but to choose which
4230 * exactly, we use the hints our callback info has, which saves us from
4231 * having to do the math and see which side has more space available, with
4232 * a little special case where we delete our extra stuff if there's nowhere
4236 * @skip evas_object_smart
4237 * @until evas_object_del(box)
4241 * The example will look like this:
4242 * @image html screenshots/anchorblock_01.png
4243 * @image latex screenshots/anchorblock_01.eps
4245 * @example anchorblock_example_01.c
4248 * @addtogroup Anchorblock
4252 * @typedef Elm_Entry_Anchorblock_Info
4254 * The info sent in the callback for "anchor,clicked" signals emitted by
4255 * the Anchorblock widget.
4257 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
4259 * @struct _Elm_Entry_Anchorblock_Info
4261 * The info sent in the callback for "anchor,clicked" signals emitted by
4262 * the Anchorblock widget.
4264 struct _Elm_Entry_Anchorblock_Info
4266 const char *name; /**< Name of the anchor, as indicated in its href
4268 int button; /**< The mouse button used to click on it */
4269 Evas_Object *hover; /**< The hover object to use for the popup */
4271 Evas_Coord x, y, w, h;
4272 } anchor, /**< Geometry selection of text used as anchor */
4273 hover_parent; /**< Geometry of the object used as parent by the
4275 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4276 for content on the left side of
4277 the hover. Before calling the
4278 callback, the widget will make the
4279 necessary calculations to check
4280 which sides are fit to be set with
4281 content, based on the position the
4282 hover is activated and its distance
4283 to the edges of its parent object
4285 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4286 the right side of the hover.
4287 See @ref hover_left */
4288 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4289 of the hover. See @ref hover_left */
4290 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4291 below the hover. See @ref
4295 * Add a new Anchorblock object
4297 * @param parent The parent object
4298 * @return The new object or NULL if it cannot be created
4300 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4302 * Set the text to show in the anchorblock
4304 * Sets the text of the anchorblock to @p text. This text can include markup
4305 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
4306 * of text that will be specially styled and react to click events, ended
4307 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
4308 * "anchor,clicked" signal that you can attach a callback to with
4309 * evas_object_smart_callback_add(). The name of the anchor given in the
4310 * event info struct will be the one set in the href attribute, in this
4313 * Other markup can be used to style the text in different ways, but it's
4314 * up to the style defined in the theme which tags do what.
4315 * @deprecated use elm_object_text_set() instead.
4317 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4319 * Get the markup text set for the anchorblock
4321 * Retrieves the text set on the anchorblock, with markup tags included.
4323 * @param obj The anchorblock object
4324 * @return The markup text set or @c NULL if nothing was set or an error
4326 * @deprecated use elm_object_text_set() instead.
4328 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4330 * Set the parent of the hover popup
4332 * Sets the parent object to use by the hover created by the anchorblock
4333 * when an anchor is clicked. See @ref Hover for more details on this.
4335 * @param obj The anchorblock object
4336 * @param parent The object to use as parent for the hover
4338 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4340 * Get the parent of the hover popup
4342 * Get the object used as parent for the hover created by the anchorblock
4343 * widget. See @ref Hover for more details on this.
4344 * If no parent is set, the same anchorblock object will be used.
4346 * @param obj The anchorblock object
4347 * @return The object used as parent for the hover, NULL if none is set.
4349 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4351 * Set the style that the hover should use
4353 * When creating the popup hover, anchorblock will request that it's
4354 * themed according to @p style.
4356 * @param obj The anchorblock object
4357 * @param style The style to use for the underlying hover
4359 * @see elm_object_style_set()
4361 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4363 * Get the style that the hover should use
4365 * Get the style the hover created by anchorblock will use.
4367 * @param obj The anchorblock object
4368 * @return The style to use by the hover. NULL means the default is used.
4370 * @see elm_object_style_set()
4372 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4374 * Ends the hover popup in the anchorblock
4376 * When an anchor is clicked, the anchorblock widget will create a hover
4377 * object to use as a popup with user provided content. This function
4378 * terminates this popup, returning the anchorblock to its normal state.
4380 * @param obj The anchorblock object
4382 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4384 * Appends a custom item provider to the given anchorblock
4386 * Appends the given function to the list of items providers. This list is
4387 * called, one function at a time, with the given @p data pointer, the
4388 * anchorblock object and, in the @p item parameter, the item name as
4389 * referenced in its href string. Following functions in the list will be
4390 * called in order until one of them returns something different to NULL,
4391 * which should be an Evas_Object which will be used in place of the item
4394 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4395 * href=item/name\>\</item\>
4397 * @param obj The anchorblock object
4398 * @param func The function to add to the list of providers
4399 * @param data User data that will be passed to the callback function
4401 * @see elm_entry_item_provider_append()
4403 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);
4405 * Prepend a custom item provider to the given anchorblock
4407 * Like elm_anchorblock_item_provider_append(), but it adds the function
4408 * @p func to the beginning of the list, instead of the end.
4410 * @param obj The anchorblock object
4411 * @param func The function to add to the list of providers
4412 * @param data User data that will be passed to the callback function
4414 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);
4416 * Remove a custom item provider from the list of the given anchorblock
4418 * Removes the function and data pairing that matches @p func and @p data.
4419 * That is, unless the same function and same user data are given, the
4420 * function will not be removed from the list. This allows us to add the
4421 * same callback several times, with different @p data pointers and be
4422 * able to remove them later without conflicts.
4424 * @param obj The anchorblock object
4425 * @param func The function to remove from the list
4426 * @param data The data matching the function to remove from the list
4428 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);
4434 * @defgroup Bubble Bubble
4436 * @brief The Bubble is a widget to show text similarly to how speech is
4437 * represented in comics.
4439 * The bubble widget contains 5 important visual elements:
4440 * @li The frame is a rectangle with rounded rectangles and an "arrow".
4441 * @li The @p icon is an image to which the frame's arrow points to.
4442 * @li The @p label is a text which appears to the right of the icon if the
4443 * corner is "top_left" or "bottom_left" and is right aligned to the frame
4445 * @li The @p info is a text which appears to the right of the label. Info's
4446 * font is of a ligther color than label.
4447 * @li The @p content is an evas object that is shown inside the frame.
4449 * The position of the arrow, icon, label and info depends on which corner is
4450 * selected. The four available corners are:
4451 * @li "top_left" - Default
4454 * @li "bottom_right"
4456 * Signals that you can add callbacks for are:
4457 * @li "clicked" - This is called when a user has clicked the bubble.
4459 * For an example of using a buble see @ref bubble_01_example_page "this".
4464 * Add a new bubble to the parent
4466 * @param parent The parent object
4467 * @return The new object or NULL if it cannot be created
4469 * This function adds a text bubble to the given parent evas object.
4471 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4473 * Set the label of the bubble
4475 * @param obj The bubble object
4476 * @param label The string to set in the label
4478 * This function sets the title of the bubble. Where this appears depends on
4479 * the selected corner.
4480 * @deprecated use elm_object_text_set() instead.
4482 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4484 * Get the label of the bubble
4486 * @param obj The bubble object
4487 * @return The string of set in the label
4489 * This function gets the title of the bubble.
4490 * @deprecated use elm_object_text_set() instead.
4492 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4494 * Set the info of the bubble
4496 * @param obj The bubble object
4497 * @param info The given info about the bubble
4499 * This function sets the info of the bubble. Where this appears depends on
4500 * the selected corner.
4501 * @deprecated use elm_object_text_set() instead.
4503 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
4505 * Get the info of the bubble
4507 * @param obj The bubble object
4509 * @return The "info" string of the bubble
4511 * This function gets the info text.
4512 * @deprecated use elm_object_text_set() instead.
4514 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4516 * Set the content to be shown in the bubble
4518 * Once the content object is set, a previously set one will be deleted.
4519 * If you want to keep the old content object, use the
4520 * elm_bubble_content_unset() function.
4522 * @param obj The bubble object
4523 * @param content The given content of the bubble
4525 * This function sets the content shown on the middle of the bubble.
4527 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4529 * Get the content shown in the bubble
4531 * Return the content object which is set for this widget.
4533 * @param obj The bubble object
4534 * @return The content that is being used
4536 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4538 * Unset the content shown in the bubble
4540 * Unparent and return the content object which was set for this widget.
4542 * @param obj The bubble object
4543 * @return The content that was being used
4545 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4547 * Set the icon of the bubble
4549 * Once the icon object is set, a previously set one will be deleted.
4550 * If you want to keep the old content object, use the
4551 * elm_icon_content_unset() function.
4553 * @param obj The bubble object
4554 * @param icon The given icon for the bubble
4556 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4558 * Get the icon of the bubble
4560 * @param obj The bubble object
4561 * @return The icon for the bubble
4563 * This function gets the icon shown on the top left of bubble.
4565 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4567 * Unset the icon of the bubble
4569 * Unparent and return the icon object which was set for this widget.
4571 * @param obj The bubble object
4572 * @return The icon that was being used
4574 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4576 * Set the corner of the bubble
4578 * @param obj The bubble object.
4579 * @param corner The given corner for the bubble.
4581 * This function sets the corner of the bubble. The corner will be used to
4582 * determine where the arrow in the frame points to and where label, icon and
4585 * Possible values for corner are:
4586 * @li "top_left" - Default
4589 * @li "bottom_right"
4591 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
4593 * Get the corner of the bubble
4595 * @param obj The bubble object.
4596 * @return The given corner for the bubble.
4598 * This function gets the selected corner of the bubble.
4600 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4602 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
4603 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4610 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4611 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
4612 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4613 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
4614 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
4615 /* smart callbacks called:
4616 * "clicked" - the user clicked the icon
4617 * "drag,start" - Someone started dragging the image out of the object
4618 * "drag,end" - Dragged item was dropped (somewhere)
4622 /** @defgroup Elm_Gesture_Layer Gesture Layer */
4624 * @enum _Elm_Gesture_Types
4625 * Emum of supported gesture types.
4626 * @ingroup Elm_Gesture_Layer
4628 enum _Elm_Gesture_Types
4630 ELM_GESTURE_FIRST = 0,
4632 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
4633 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
4634 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
4636 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
4638 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
4639 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
4641 ELM_GESTURE_ZOOM, /**< Zoom */
4642 ELM_GESTURE_ROTATE, /**< Rotate */
4648 * @typedef Elm_Gesture_Types
4649 * Type for Emum of supported gesture types.
4650 * @ingroup Elm_Gesture_Layer
4652 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
4655 * @enum _Elm_Gesture_State
4656 * Emum of gesture states.
4657 * @ingroup Elm_Gesture_Layer
4659 enum _Elm_Gesture_State
4661 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
4662 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
4663 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
4664 ELM_GESTURE_STATE_END, /**< Gesture completed */
4665 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
4668 * @typedef Elm_Gesture_State
4670 * @ingroup Elm_Gesture_Layer
4672 typedef enum _Elm_Gesture_State Elm_Gesture_State;
4675 * @struct _Elm_Gesture_Taps_Info
4676 * Struct holds taps info for user
4677 * @ingroup Elm_Gesture_Layer
4679 struct _Elm_Gesture_Taps_Info
4681 Evas_Coord x, y; /**< Holds center point between fingers */
4682 unsigned int n; /**< Number of fingers tapped */
4683 unsigned int timestamp; /**< event timestamp */
4687 * @typedef Elm_Gesture_Taps_Info
4688 * holds taps info for user
4689 * @ingroup Elm_Gesture_Layer
4691 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
4694 * @struct _Elm_Gesture_Momentum_Info
4695 * Struct holds momentum info for user
4696 * x1 and y1 are not necessarily in sync
4697 * x1 holds x value of x direction starting point
4698 * and same holds for y1.
4699 * This is noticeable when doing V-shape movement
4700 * @ingroup Elm_Gesture_Layer
4702 struct _Elm_Gesture_Momentum_Info
4703 { /* Report line ends, timestamps, and momentum computed */
4704 Evas_Coord x1; /**< Final-swipe direction starting point on X */
4705 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
4706 Evas_Coord x2; /**< Final-swipe direction ending point on X */
4707 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
4709 unsigned int tx; /**< Timestamp of start of final x-swipe */
4710 unsigned int ty; /**< Timestamp of start of final y-swipe */
4712 Evas_Coord mx; /**< Momentum on X */
4713 Evas_Coord my; /**< Momentum on Y */
4717 * @typedef Elm_Gesture_Momentum_Info
4718 * holds momentum info for user
4719 * @ingroup Elm_Gesture_Layer
4721 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
4724 * @struct _Elm_Gesture_Line_Info
4725 * Struct holds line info for user
4726 * @ingroup Elm_Gesture_Layer
4728 struct _Elm_Gesture_Line_Info
4729 { /* Report line ends, timestamps, and momentum computed */
4730 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
4731 unsigned int n; /**< Number of fingers (lines) */
4732 /* FIXME should be radians, bot degrees */
4733 double angle; /**< Angle (direction) of lines */
4737 * @typedef _Elm_Gesture_Line_Info
4738 * Holds line info for user
4739 * @ingroup Elm_Gesture_Layer
4741 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
4744 * @struct _Elm_Gesture_Zoom_Info
4745 * Struct holds zoom info for user
4746 * @ingroup Elm_Gesture_Layer
4748 struct _Elm_Gesture_Zoom_Info
4750 Evas_Coord x, y; /**< Holds zoom center point reported to user */
4751 Evas_Coord radius; /**< Holds radius between fingers reported to user */
4752 float zoom; /**< Zoom value: 1.0 means no zoom */
4753 float momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
4757 * @typedef Elm_Gesture_Zoom_Info
4758 * Holds zoom info for user
4759 * @ingroup Elm_Gesture_Layer
4761 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
4764 * @struct _Elm_Gesture_Rotate_Info
4765 * Struct holds rotation info for user
4766 * @ingroup Elm_Gesture_Layer
4768 struct _Elm_Gesture_Rotate_Info
4770 Evas_Coord x, y; /**< Holds zoom center point reported to user */
4771 Evas_Coord radius; /**< Holds radius between fingers reported to user */
4772 double base_angle; /**< Holds start-angle */
4773 double angle; /**< Rotation value: 0.0 means no rotation */
4774 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
4778 * @typedef Elm_Gesture_Rotate_Info
4779 * Holds rotation info for user
4780 * @ingroup Elm_Gesture_Layer
4782 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
4785 * @typedef Elm_Gesture_Event_Cb
4786 * User callback used to stream gesture info from gesture layer
4787 * @param data user data
4788 * @param event_info gesture report info
4789 * Returns a flag field to be applied on the causing event.
4790 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
4791 * upon the event, in an irreversible way.
4793 * @ingroup Elm_Gesture_Layer
4795 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
4798 * Use function to set callbacks to be notified about
4799 * change of state of gesture.
4800 * When a user registers a callback with this function
4801 * this means this gesture has to be tested.
4803 * When ALL callbacks for a gesture are set to NULL
4804 * it means user isn't interested in gesture-state
4805 * and it will not be tested.
4807 * @param obj Pointer to gesture-layer.
4808 * @param idx The gesture you would like to track its state.
4809 * @param cb callback function pointer.
4810 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
4811 * @param data user info to be sent to callback (usually, Smart Data)
4813 * @ingroup Elm_Gesture_Layer
4815 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);
4818 * Call this function to get repeat-events settings.
4820 * @param obj Pointer to gesture-layer.
4822 * @return repeat events settings.
4823 * @see elm_gesture_layer_hold_events_set()
4824 * @ingroup Elm_Gesture_Layer
4826 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4829 * This function called in order to make gesture-layer repeat events.
4830 * Set this of you like to get the raw events only if gestures were not detected.
4831 * Clear this if you like gesture layer to fwd events as testing gestures.
4833 * @param obj Pointer to gesture-layer.
4834 * @param r Repeat: TRUE/FALSE
4836 * @ingroup Elm_Gesture_Layer
4838 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
4841 * This function sets step-value for zoom action.
4842 * Set step to any positive value.
4843 * Cancel step setting by setting to 0.0
4845 * @param obj Pointer to gesture-layer.
4846 * @param s new zoom step value.
4848 * @ingroup Elm_Gesture_Layer
4850 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4853 * This function sets step-value for rotate action.
4854 * Set step to any positive value.
4855 * Cancel step setting by setting to 0.0
4857 * @param obj Pointer to gesture-layer.
4858 * @param s new roatate step value.
4860 * @ingroup Elm_Gesture_Layer
4862 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4865 * This function called to attach gesture-layer to an Evas_Object.
4866 * @param obj Pointer to gesture-layer.
4867 * @param t Pointer to underlying object (AKA Target)
4869 * @return TRUE, FALSE on success, failure.
4871 * @ingroup Elm_Gesture_Layer
4873 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
4876 * Call this function to construct a new gesture-layer object.
4877 * This does not activate the gesture layer. You have to
4878 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
4880 * @param parent the parent object.
4882 * @return Pointer to new gesture-layer object.
4884 * @ingroup Elm_Gesture_Layer
4886 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4889 typedef enum _Elm_Thumb_Animation_Setting
4891 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
4892 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
4893 ELM_THUMB_ANIMATION_STOP,
4894 ELM_THUMB_ANIMATION_LAST
4895 } Elm_Thumb_Animation_Setting;
4897 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4898 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
4899 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
4900 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4901 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4902 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
4903 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4904 EAPI void *elm_thumb_ethumb_client_get(void);
4905 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
4906 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
4907 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4908 /* available styles:
4912 /* smart callbacks called:
4913 * "clicked" - This is called when a user has clicked the thumb without dragging around.
4914 * "clicked,double" - This is called when a user has double-clicked the thumb.
4915 * "press" - This is called when a user has pressed down the thumb.
4916 * "generate,start" - The thumbnail generation started.
4917 * "generate,stop" - The generation process stopped.
4918 * "generate,error" - The generation failed.
4919 * "load,error" - The thumbnail image loading failed.
4923 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4924 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4925 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4926 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4927 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4928 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4929 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4930 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4931 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4932 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4933 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
4934 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4935 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4936 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4937 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4938 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);
4939 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
4940 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4941 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
4942 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
4943 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);
4944 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);
4945 /* smart callbacks called:
4946 * "clicked" - the user clicked the hoversel button and popped up the sel
4947 * "selected" - an item in the hoversel list is selected
4948 * "dismissed" - the hover is dismissed
4952 typedef enum _Elm_Toolbar_Shrink_Mode
4954 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
4955 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
4956 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
4957 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
4958 } Elm_Toolbar_Shrink_Mode;
4960 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
4961 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
4963 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4964 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
4965 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4966 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4967 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4968 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
4969 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4970 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);
4971 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);
4972 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);
4973 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);
4974 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4975 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4976 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4977 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4978 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4979 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
4980 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4981 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4982 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4983 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
4984 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4985 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
4986 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4987 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4988 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4989 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4990 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
4991 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4992 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4993 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4994 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4995 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
4996 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4997 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
4998 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4999 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5000 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5001 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5002 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5003 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5004 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5005 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
5006 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5007 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
5008 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5009 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);
5010 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5011 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5012 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5013 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5014 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5015 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5016 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
5017 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);
5018 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5019 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5020 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5021 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5022 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5023 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5024 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5025 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5026 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5027 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5028 /* smart callbacks called:
5029 * "clicked" - when the user clicks on a toolbar item and becomes selected
5031 /* available styles:
5033 * transparent (no background or shadow, just show the provided content)
5037 EAPI double elm_tooltip_delay_get(void);
5038 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
5039 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
5040 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
5041 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
5042 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);
5043 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5044 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5045 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5046 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
5047 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5048 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5049 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5050 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5051 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5052 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5055 EAPI int elm_cursor_engine_only_get(void);
5056 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
5059 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
5060 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5061 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5062 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5063 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
5064 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
5065 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5066 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5067 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);
5068 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
5069 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5070 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
5071 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5072 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5073 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5074 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5075 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5076 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5077 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
5078 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5079 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5080 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5081 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5082 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
5083 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5084 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5085 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5086 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5087 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5088 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5090 /* smart callbacks called:
5091 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
5095 typedef enum _Elm_List_Mode
5097 ELM_LIST_COMPRESS = 0,
5103 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
5104 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5105 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);
5106 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);
5107 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);
5108 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);
5109 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);
5110 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5111 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
5112 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5113 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5114 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5115 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5116 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5117 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5118 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5119 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5120 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5121 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5122 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5123 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
5124 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5125 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5126 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5127 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5128 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5129 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5130 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5131 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5132 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5133 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
5134 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5135 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
5136 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5137 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5138 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5139 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5140 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5141 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5142 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);
5143 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5144 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5145 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5146 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5147 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5148 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5149 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5150 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5151 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5152 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5153 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5154 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5155 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5156 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5157 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5158 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);
5159 /* smart callbacks called:
5160 * "clicked,double" - when the user double-clicked an item
5161 * "selected" - when the user selected an item
5162 * "unselected" - when the user selected an item
5163 * "longpressed" - an item in the hoversel list is long-pressed
5164 * "scroll,edge,top" - the list is scrolled until the top edge
5165 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
5166 * "scroll,edge,left" - the list is scrolled until the left edge
5167 * "scroll,edge,right" - the list is scrolled until the right edge
5171 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5172 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5173 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5174 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5175 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5176 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5177 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
5178 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5179 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5180 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5181 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5182 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5183 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5184 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
5185 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5186 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);
5187 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);
5188 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5189 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5190 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5191 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5192 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5193 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5194 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5195 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5196 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
5197 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5198 /* smart callbacks called:
5199 * "changed" - Whenever the slider value is changed by the user.
5200 * "slider,drag,start" - dragging the slider indicator around has started
5201 * "slider,drag,stop" - dragging the slider indicator around has stopped
5202 * "delay,changed" - A short time after the value is changed by the user.
5203 * This will be called only when the user stops dragging for a very short
5204 * period or when they release their finger/mouse, so it avoids possibly
5205 * expensive reactions to the value change.
5212 * @addtogroup Actionslider Actionslider
5214 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
5215 * properties. The indicator is the element the user drags to choose a label.
5216 * When the position is set with magnet, when released the indicator will be
5217 * moved to it if it's nearest the magnetized position.
5219 * @note By default all positions are set as enabled.
5221 * Signals that you can add callbacks for are:
5223 * "selected" - when user selects an enabled position (the label is passed
5226 * "pos_changed" - when the indicator reaches any of the positions("left",
5227 * "right" or "center").
5229 * See an example of actionslider usage @ref actionslider_example_page "here"
5233 typedef enum _Elm_Actionslider_Indicator_Pos
5235 ELM_ACTIONSLIDER_INDICATOR_NONE,
5236 ELM_ACTIONSLIDER_INDICATOR_LEFT,
5237 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
5238 ELM_ACTIONSLIDER_INDICATOR_CENTER
5239 } Elm_Actionslider_Indicator_Pos;
5241 typedef enum _Elm_Actionslider_Magnet_Pos
5243 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
5244 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
5245 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
5246 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
5247 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
5248 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
5249 } Elm_Actionslider_Magnet_Pos;
5251 typedef enum _Elm_Actionslider_Label_Pos
5253 ELM_ACTIONSLIDER_LABEL_LEFT,
5254 ELM_ACTIONSLIDER_LABEL_RIGHT,
5255 ELM_ACTIONSLIDER_LABEL_CENTER,
5256 ELM_ACTIONSLIDER_LABEL_BUTTON
5257 } Elm_Actionslider_Label_Pos;
5259 /* smart callbacks called:
5260 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
5264 * Add a new actionslider to the parent.
5266 * @param parent The parent object
5267 * @return The new actionslider object or NULL if it cannot be created
5269 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5272 * Set actionslider label.
5274 * @param[in] obj The actionslider object
5275 * @param[in] pos The position of the label.
5276 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
5277 * @param label The label which is going to be set.
5279 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
5281 * Get actionslider labels.
5283 * @param obj The actionslider object
5284 * @param left_label A char** to place the left_label of @p obj into.
5285 * @param center_label A char** to place the center_label of @p obj into.
5286 * @param right_label A char** to place the right_label of @p obj into.
5288 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);
5290 * Get actionslider selected label.
5292 * @param obj The actionslider object
5293 * @return The selected label
5295 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5297 * Set actionslider indicator position.
5299 * @param obj The actionslider object.
5300 * @param pos The position of the indicator.
5302 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
5304 * Get actionslider indicator position.
5306 * @param obj The actionslider object.
5307 * @return The position of the indicator.
5309 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5311 * Set actionslider magnet position. To make multiple positions magnets @c or
5312 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
5314 * @param obj The actionslider object.
5315 * @param pos Bit mask indicating the magnet positions.
5317 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5319 * Get actionslider magnet position.
5321 * @param obj The actionslider object.
5322 * @return The positions with magnet property.
5324 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5326 * Set actionslider enabled position. To set multiple positions as enabled @c or
5327 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
5329 * @note All the positions are enabled by default.
5331 * @param obj The actionslider object.
5332 * @param pos Bit mask indicating the enabled positions.
5334 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5336 * Get actionslider enabled position.
5338 * @param obj The actionslider object.
5339 * @return The enabled positions.
5341 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5343 * Set the label used on the indicator.
5345 * @param obj The actionslider object
5346 * @param label The label to be set on the indicator.
5347 * @deprecated use elm_object_text_set() instead.
5349 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5351 * Get the label used on the indicator object.
5353 * @param obj The actionslider object
5354 * @return The indicator label
5355 * @deprecated use elm_object_text_get() instead.
5357 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5360 * Hold actionslider object movement.
5362 * @param[in] obj The actionslider object
5363 * @param[in] flag Actionslider hold/release
5364 * (EINA_TURE = hold/EIN_FALSE = release)
5366 * @ingroup Actionslider
5368 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
5376 typedef enum _Elm_Genlist_Item_Flags
5378 ELM_GENLIST_ITEM_NONE = 0,
5379 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
5380 ELM_GENLIST_ITEM_GROUP = (1 << 1)
5381 } Elm_Genlist_Item_Flags;
5382 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
5383 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
5384 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
5385 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
5386 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
5387 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
5388 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
5389 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
5391 struct _Elm_Genlist_Item_Class
5393 const char *item_style;
5395 GenlistItemLabelGetFunc label_get;
5396 GenlistItemIconGetFunc icon_get;
5397 GenlistItemStateGetFunc state_get;
5398 GenlistItemDelFunc del;
5399 GenlistItemMovedFunc moved;
5401 const char *edit_item_style;
5402 const char *mode_item_style;
5404 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5405 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5406 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5407 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5408 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5409 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5410 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5411 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5412 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5413 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5414 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
5415 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5416 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
5417 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5418 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5419 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5420 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5421 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5422 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
5423 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5424 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5425 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5426 /* operations to add items */
5427 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);
5428 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);
5429 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);
5430 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);
5431 /* operations to retrieve existing items */
5432 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5433 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5434 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5435 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);
5436 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5437 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5438 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5439 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);
5440 /* available item styles:
5442 * default_style - The text part is a textblock
5444 * icon_top_text_bottom
5446 /* Genlist Item operation */
5447 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5448 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5449 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5450 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5451 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5452 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5453 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5454 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
5455 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5456 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5457 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5458 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5459 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
5460 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5461 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5462 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5463 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5464 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5465 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5466 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5467 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5468 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5469 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
5470 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5471 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5472 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5473 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
5474 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
5475 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);
5476 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5477 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5478 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5479 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5480 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5481 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5482 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5483 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5484 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5485 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5486 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
5487 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
5488 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5489 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5490 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5491 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5492 /* Signals that you can add callbacks for are:
5493 * "clicked,double" - This is called when a user has double-clicked an item.
5494 * The event_info parameter is the genlist item that was
5496 * "selected" - This is called when a user has made an item selected. The
5497 * event_info parameter is the genlist item that was selected.
5498 * "unselected" - This is called when a user has made an item unselected. The
5499 * event_info parameter is the genlist item that was unselected.
5500 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
5501 * and the item is now meant to be expanded. The event_info parameter is the
5502 * genlist item that was indicated to expand. It is the job of this callback
5503 * to then fill in the child items.
5504 * "contracted" - This is called when elm_genlist_item_expanded_set() is called
5505 * and the item is now meant to be contracted. The event_info parameter is
5506 * the genlist item that was indicated to contract. It is the job of this
5507 * callback to then delete the child items.
5508 * "expand,request" - This is called when a user has indicated they want to
5509 * expand a tree branch item. The callback should decide if the item can
5510 * expand (has any children) and then call elm_genlist_item_expanded_set()
5511 * appropriately to set the state. The event_info parameter is the genlist
5512 * item that was indicated to expand.
5513 * "contract,request" - This is called when a user has indicated they want to
5514 * contract a tree branch item. The callback should decide if the item can
5515 * contract (has any children) and then call elm_genlist_item_expanded_set()
5516 * appropriately to set the state. The event_info parameter is the genlist
5517 * item that was indicated to contract.
5518 * "realized" - This is called when the item in the list is created as a real
5519 * evas object. event_info parameter is the genlist item that was created.
5520 * The object may be deleted at any time, so it is up to the caller to
5521 * not use the object pointer from elm_genlist_item_object_get() in a way
5522 * where it may point to freed objects.
5523 * "unrealized" - This is called just before an item is unrealized. After
5524 * this call icon objects provided will be deleted and the item object
5525 * itself delete or be put into a floating cache.
5526 * "drag,start,up" - This is called when the item in the list has been dragged
5527 * (not scrolled) up.
5528 * "drag,start,down" - This is called when the item in the list has been dragged
5529 * (not scrolled) down.
5530 * "drag,start,left" - This is called when the item in the list has been dragged i
5531 * (not scrolled) left.
5532 * "drag,start,right" - This is called when the item in the list has been dragged
5533 * (not scrolled) right.
5534 * "drag,stop" - This is called when the item in the list has stopped being
5536 * "drag" - This is called when the item in the list is being dragged.
5537 * "longpressed" - This is called when the item is pressed for a certain amount
5538 * of time. By default it's 1 second.
5539 * "scroll,edge,top" - This is called when the genlist is scrolled until the
5541 * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
5543 * "scroll,edge,left" - This is called when the genlist is scrolled until the
5545 * "scroll,edge,right" - This is called when the genlist is scrolled until the
5547 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
5549 * "multi,swipe,right" - This is called when the genlist is multi-touch swiped
5551 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
5552 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
5554 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
5556 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
5559 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
5560 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5561 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
5562 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5563 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
5564 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
5565 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5566 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5567 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5568 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5571 * @page tutorial_check Check example
5572 * @dontinclude check_example_01.c
5574 * This example will show 2 checkboxes, one with just a label and the second
5575 * one with both a label and an icon. This example also ilustrates how to
5576 * have the checkbox change the value of a variable and how to react to those
5579 * We will start with the usual setup code:
5582 * And now we create our first checkbox, set its label, tell it to change
5583 * the value of @p value when the checkbox stats is changed and ask to be
5584 * notified of state changes:
5587 * For our second checkbox we are going to set an icon so we need to create
5590 * @note For simplicity we are using a rectangle as icon, but any evas object
5593 * And for our second checkbox we set the label, icon and state to true:
5596 * We now do some more setup:
5599 * And finally implement the callback that will be called when the first
5600 * checkbox's state changes. This callback will use @p data to print a
5603 * @note This work because @p data is @p value(from the main function) and @p
5604 * value is changed when the checkbox is changed.
5606 * Our example will look like this:
5607 * @image html screenshots/check_example_01.png
5608 * @image latex screenshots/check_example_01.eps
5610 * @example check_example_01.c
5613 * @defgroup Check Check
5615 * @brief The check widget allows for toggling a value between true and
5618 * Check objects are a lot like radio objects in layout and functionality
5619 * except they do not work as a group, but independently and only toggle the
5620 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
5621 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
5622 * returns the current state. For convenience, like the radio objects, you
5623 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
5626 * Signals that you can add callbacks for are:
5627 * "changed" - This is called whenever the user changes the state of one of
5628 * the check object(event_info is NULL).
5630 * @ref tutorial_check should give you a firm grasp of how to use this widget.
5634 * @brief Add a new Check object
5636 * @param parent The parent object
5637 * @return The new object or NULL if it cannot be created
5639 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5641 * @brief Set the text label of the check object
5643 * @param obj The check object
5644 * @param label The text label string in UTF-8
5646 * @deprecated use elm_object_text_set() instead.
5648 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5650 * @brief Get the text label of the check object
5652 * @param obj The check object
5653 * @return The text label string in UTF-8
5655 * @deprecated use elm_object_text_get() instead.
5657 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5659 * @brief Set the icon object of the check object
5661 * @param obj The check object
5662 * @param icon The icon object
5664 * Once the icon object is set, a previously set one will be deleted.
5665 * If you want to keep that old content object, use the
5666 * elm_check_icon_unset() function.
5668 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5670 * @brief Get the icon object of the check object
5672 * @param obj The check object
5673 * @return The icon object
5675 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5677 * @brief Unset the icon used for the check object
5679 * @param obj The check object
5680 * @return The icon object that was being used
5682 * Unparent and return the icon object which was set for this widget.
5684 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5686 * @brief Set the on/off state of the check object
5688 * @param obj The check object
5689 * @param state The state to use (1 == on, 0 == off)
5691 * This sets the state of the check. If set
5692 * with elm_check_state_pointer_set() the state of that variable is also
5693 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
5695 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5697 * @brief Get the state of the check object
5699 * @param obj The check object
5700 * @return The boolean state
5702 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5704 * @brief Set a convenience pointer to a boolean to change
5706 * @param obj The check object
5707 * @param statep Pointer to the boolean to modify
5709 * This sets a pointer to a boolean, that, in addition to the check objects
5710 * state will also be modified directly. To stop setting the object pointed
5711 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
5712 * then when this is called, the check objects state will also be modified to
5713 * reflect the value of the boolean @p statep points to, just like calling
5714 * elm_check_state_set().
5716 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5722 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5723 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5724 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5725 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5726 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5727 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5728 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
5729 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5730 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5731 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5732 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5733 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
5734 /* smart callbacks called:
5735 * "changed" - when the radio status is changed
5739 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5740 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5741 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
5742 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5743 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5744 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5745 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
5746 EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
5748 /* available item styles:
5754 /* smart callbacks called:
5755 * "hide,finished" - when the previous page is hided
5758 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
5759 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
5760 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
5761 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
5762 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
5764 struct _Elm_Slideshow_Item_Class
5766 struct _Elm_Slideshow_Item_Class_Func
5768 SlideshowItemGetFunc get;
5769 SlideshowItemDelFunc del;
5773 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5774 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
5775 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);
5776 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5777 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
5778 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
5779 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5780 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
5781 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5782 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5783 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5784 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
5785 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5786 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5787 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5788 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5789 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5790 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5791 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
5792 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
5793 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5794 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
5795 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5796 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5797 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5798 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5799 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5800 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5801 /* smart callbacks called:
5802 * "changed" - when the slideshow switch to another item
5806 typedef enum _Elm_Fileselector_Mode
5808 ELM_FILESELECTOR_LIST = 0,
5809 ELM_FILESELECTOR_GRID,
5810 ELM_FILESELECTOR_LAST
5811 } Elm_Fileselector_Mode;
5813 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5814 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
5815 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5816 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
5817 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5818 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
5819 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5820 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5821 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
5822 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5823 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5824 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5825 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5826 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
5827 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5828 /* smart callbacks called:
5829 * "selected" - the user click on a file
5830 * "directory,open" - the list is populate with a new content. event_info is a directory.
5831 * "done" - the user click on the ok or cancel buttons
5835 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5836 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
5837 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5838 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5839 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5840 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5841 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5842 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5843 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5844 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5845 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5846 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5847 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5848 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5849 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5850 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5851 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5852 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5853 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5854 /* smart callbacks called:
5856 /* available item styles:
5858 * wheel (simple style, no text, no progression, only pulse is available)
5862 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5863 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5864 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5865 /* smart callbacks called:
5869 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5870 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
5871 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5872 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5873 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5874 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
5875 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5876 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5877 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5878 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
5879 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5880 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
5881 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5882 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
5883 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
5884 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5885 /* smart callbacks called:
5886 * "changed" - when the spinner value changes
5887 * "delay,changed" - when the spinner value changed, but a small time after a change (use this if you only want to respond to a change once the spinner is held still for a short while).
5889 /* available item styles:
5891 * vertical (two up/down buttons at the right side and text left aligned)
5895 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
5897 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5898 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
5899 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5900 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5901 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5902 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5903 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
5904 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
5905 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
5906 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
5907 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);
5908 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
5909 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
5910 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5911 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5912 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
5913 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
5914 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5915 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
5916 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
5917 /* smart callbacks called:
5918 * "changed" - when the selected index item changes
5919 * "delay,changed" - when the selected index item changes, but after some small idle period
5920 * "selected" - when the user releases a finger and selects an item
5921 * "level,up" - when the user moves a finger from the first level to the second level
5922 * "level,down" - when the user moves a finger from the second level to the first level
5926 typedef enum _Elm_Photocam_Zoom_Mode
5928 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
5929 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
5930 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
5931 ELM_PHOTOCAM_ZOOM_MODE_LAST
5932 } Elm_Photocam_Zoom_Mode;
5934 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5935 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
5936 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5937 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
5938 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5939 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
5940 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5941 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5942 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5943 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5944 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5945 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
5946 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5947 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5948 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5949 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5950 /* smart callbacks called:
5951 * "clicked" - when image clicked
5952 * "press" - when mouse/finger held down initially on image
5953 * "longpressed" - when mouse/finger held for long time on image
5954 * "clicked,double" - when mouse/finger double-clicked
5955 * "load" - when photo load begins
5956 * "loaded" - when photo load done
5957 * "load,detail" - when detailed image load begins
5958 * "loaded,detail" - when detailed image load done
5959 * "zoom,start" - when zooming started
5960 * "zoom,stop" - when zooming stopped
5961 * "zoom,change" - when auto zoom mode changed zoom level
5962 * "scroll - the content has been scrolled (moved)
5963 * "scroll,anim,start" - scrolling animation has started
5964 * "scroll,anim,stop" - scrolling animation has stopped
5965 * "scroll,drag,start" - dragging the contents around has started
5966 * "scroll,drag,stop" - dragging the contents around has stopped
5970 typedef enum _Elm_Map_Zoom_Mode
5972 ELM_MAP_ZOOM_MODE_MANUAL,
5973 ELM_MAP_ZOOM_MODE_AUTO_FIT,
5974 ELM_MAP_ZOOM_MODE_AUTO_FILL,
5975 ELM_MAP_ZOOM_MODE_LAST
5976 } Elm_Map_Zoom_Mode;
5978 typedef enum _Elm_Map_Route_Sources
5980 ELM_MAP_ROUTE_SOURCE_YOURS,
5981 ELM_MAP_ROUTE_SOURCE_MONAV,
5982 ELM_MAP_ROUTE_SOURCE_ORS,
5983 ELM_MAP_ROUTE_SOURCE_LAST
5984 } Elm_Map_Route_Sources;
5986 typedef enum _Elm_Map_Name_Sources
5988 ELM_MAP_NAME_SOURCE_NOMINATIM,
5989 ELM_MAP_NAME_SOURCE_LAST
5990 } Elm_Map_Name_Sources;
5992 typedef enum _Elm_Map_Route_Type
5994 ELM_MAP_ROUTE_TYPE_MOTOCAR,
5995 ELM_MAP_ROUTE_TYPE_BICYCLE,
5996 ELM_MAP_ROUTE_TYPE_FOOT,
5997 ELM_MAP_ROUTE_TYPE_LAST
5998 } Elm_Map_Route_Type;
6000 typedef enum _Elm_Map_Route_Method
6002 ELM_MAP_ROUTE_METHOD_FASTEST,
6003 ELM_MAP_ROUTE_METHOD_SHORTEST,
6004 ELM_MAP_ROUTE_METHOD_LAST
6005 } Elm_Map_Route_Method;
6007 typedef enum _Elm_Map_Name_Method
6009 ELM_MAP_NAME_METHOD_SEARCH,
6010 ELM_MAP_NAME_METHOD_REVERSE,
6011 ELM_MAP_NAME_METHOD_LAST
6012 } Elm_Map_Name_Method;
6014 typedef struct _Elm_Map_Marker Elm_Map_Marker;
6015 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
6016 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
6017 typedef struct _Elm_Map_Route Elm_Map_Route;
6018 typedef struct _Elm_Map_Name Elm_Map_Name;
6019 typedef struct _Elm_Map_Track Elm_Map_Track;
6021 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6022 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
6023 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6024 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
6026 typedef char *(*ElmMapModuleSourceFunc) (void);
6027 typedef int (*ElmMapModuleZoomMinFunc) (void);
6028 typedef int (*ElmMapModuleZoomMaxFunc) (void);
6029 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
6030 typedef int (*ElmMapModuleRouteSourceFunc) (void);
6031 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
6032 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
6033 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
6034 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
6036 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6037 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6038 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6039 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
6040 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6041 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
6042 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6043 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6044 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6045 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6046 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6047 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6048 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
6049 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);
6050 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);
6051 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6052 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
6053 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);
6054 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);
6055 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
6056 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6057 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
6058 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6059 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6060 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
6061 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6062 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6063 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
6064 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6065 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6066 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6067 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
6068 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6069 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6070 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
6071 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6072 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6073 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6074 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
6075 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
6076 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6077 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
6078 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6079 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
6080 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6081 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6082 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6083 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6084 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6085 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
6086 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6087 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);
6088 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6089 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
6090 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
6091 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6092 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6093 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6094 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6095 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
6096 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6097 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
6098 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);
6099 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6100 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6102 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
6104 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
6106 /* smart callbacks called:
6107 * "clicked" - when image clicked
6108 * "press" - when mouse/finger held down initially on image
6109 * "longpressed" - when mouse/finger held for long time on image
6110 * "clicked,double" - when mouse/finger double-clicked
6111 * "load,details" - when detailed image load begins
6112 * "loaded,details" - when detailed image load done
6113 * "zoom,start" - when zooming started
6114 * "zoom,stop" - when zooming stopped
6115 * "zoom,change" - when auto zoom mode changed zoom level
6116 * "scroll - the content has been scrolled (moved)
6117 * "scroll,anim,start" - scrolling animation has started
6118 * "scroll,anim,stop" - scrolling animation has stopped
6119 * "scroll,drag,start" - dragging the contents around has started
6120 * "scroll,drag,stop" - dragging the contents around has stopped
6124 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
6126 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
6128 EAPI double elm_route_lon_min_get(Evas_Object *obj);
6129 EAPI double elm_route_lat_min_get(Evas_Object *obj);
6130 EAPI double elm_route_lon_max_get(Evas_Object *obj);
6131 EAPI double elm_route_lat_max_get(Evas_Object *obj);
6135 typedef enum _Elm_Panel_Orient
6137 ELM_PANEL_ORIENT_TOP,
6138 ELM_PANEL_ORIENT_BOTTOM,
6139 ELM_PANEL_ORIENT_LEFT,
6140 ELM_PANEL_ORIENT_RIGHT,
6143 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6144 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
6145 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6146 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6147 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6148 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6149 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
6150 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6151 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
6157 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
6158 * Add events (move, start ...)
6160 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6161 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6162 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6163 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6164 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6165 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6166 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6167 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6168 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
6169 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6170 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6171 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
6172 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6175 typedef enum _Elm_Flip_Mode
6177 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
6178 ELM_FLIP_ROTATE_X_CENTER_AXIS,
6179 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
6180 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
6182 ELM_FLIP_CUBE_RIGHT,
6186 ELM_FLIP_PAGE_RIGHT,
6190 typedef enum _Elm_Flip_Interaction
6192 ELM_FLIP_INTERACTION_NONE,
6193 ELM_FLIP_INTERACTION_ROTATE,
6194 ELM_FLIP_INTERACTION_CUBE,
6195 ELM_FLIP_INTERACTION_PAGE
6196 } Elm_Flip_Interaction;
6197 typedef enum _Elm_Flip_Direction
6199 ELM_FLIP_DIRECTION_UP,
6200 ELM_FLIP_DIRECTION_DOWN,
6201 ELM_FLIP_DIRECTION_LEFT,
6202 ELM_FLIP_DIRECTION_RIGHT
6203 } Elm_Flip_Direction;
6205 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6206 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6207 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6208 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6209 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6210 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6211 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6212 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6213 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
6214 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
6215 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
6216 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
6217 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
6218 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
6219 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
6220 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
6221 /* smart callbacks called:
6222 * "animate,begin" - when a flip animation was started
6223 * "animate,done" - when a flip animation is finished
6227 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6228 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
6229 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6230 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
6231 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6232 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6233 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6234 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6235 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6236 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6237 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6238 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
6239 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
6240 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6241 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
6242 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6243 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6244 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6245 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
6246 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
6247 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6248 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6249 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6250 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6251 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
6252 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6253 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6254 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6255 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6256 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6257 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6258 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
6259 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
6260 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
6261 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6262 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);
6263 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6264 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6265 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);
6266 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6267 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);
6268 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
6269 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6270 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6271 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6272 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
6273 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6274 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6275 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6276 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);
6277 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);
6278 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);
6279 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);
6280 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);
6281 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);
6282 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
6283 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
6284 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
6285 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
6286 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6287 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
6288 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6289 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6290 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
6291 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
6292 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
6293 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
6294 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
6297 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6298 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6299 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6300 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6301 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6304 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6305 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6306 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6307 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6308 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6309 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6310 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
6311 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6312 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
6313 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6316 * @defgroup Flipselector Flip Selector
6318 * A flip selector is a widget to show a set of @b text items, one
6319 * at a time, with the same sheet switching style as the @ref Clock
6320 * "clock" widget, when one changes the current displaying sheet
6321 * (thus, the "flip" in the name).
6323 * User clicks to flip sheets which are @b held for some time will
6324 * make the flip selector to flip continuosly and automatically for
6325 * the user. The interval between flips will keep growing in time,
6326 * so that it helps the user to reach an item which is distant from
6327 * the current selection.
6329 * Smart callbacks one can register to:
6330 * - @c "selected" - when the widget's selected text item is changed
6331 * - @c "overflowed" - when the widget's current selection is changed
6332 * from the first item in its list to the last
6333 * - @c "underflowed" - when the widget's current selection is changed
6334 * from the last item in its list to the first
6336 * Available styles for it:
6339 * Here is an example on its usage:
6340 * @li @ref flipselector_example
6344 * @addtogroup Flipselector
6348 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
6351 * Add a new flip selector widget to the given parent Elementary
6352 * (container) widget
6354 * @param parent The parent object
6355 * @return a new flip selector widget handle or @c NULL, on errors
6357 * This function inserts a new flip selector widget on the canvas.
6359 * @ingroup Flipselector
6361 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6364 * Programmatically select the next item of a flip selector widget
6366 * @param obj The flipselector object
6368 * @note The selection will be animated. Also, if it reaches the
6369 * end of its list of member items, it will continue with the first
6372 * @ingroup Flipselector
6374 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6377 * Programmatically select the previous item of a flip selector
6380 * @param obj The flipselector object
6382 * @note The selection will be animated. Also, if it reaches the
6383 * beginning of its list of member items, it will continue with the
6384 * last one backwards.
6386 * @ingroup Flipselector
6388 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6391 * Append a (text) item to a flip selector widget
6393 * @param obj The flipselector object
6394 * @param label The (text) label of the new item
6395 * @param func Convenience callback function to take place when
6397 * @param data Data passed to @p func, above
6398 * @return A handle to the item added or @c NULL, on errors
6400 * The widget's list of labels to show will be appended with the
6401 * given value. If the user wishes so, a callback function pointer
6402 * can be passed, which will get called when this same item is
6405 * @note The current selection @b won't be modified by appending an
6406 * element to the list.
6408 * @note The maximum length of the text label is going to be
6409 * determined <b>by the widget's theme</b>. Strings larger than
6410 * that value are going to be @b truncated.
6412 * @ingroup Flipselector
6414 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6417 * Prepend a (text) item to a flip selector widget
6419 * @param obj The flipselector object
6420 * @param label The (text) label of the new item
6421 * @param func Convenience callback function to take place when
6423 * @param data Data passed to @p func, above
6424 * @return A handle to the item added or @c NULL, on errors
6426 * The widget's list of labels to show will be prepended with the
6427 * given value. If the user wishes so, a callback function pointer
6428 * can be passed, which will get called when this same item is
6431 * @note The current selection @b won't be modified by prepending
6432 * an element to the list.
6434 * @note The maximum length of the text label is going to be
6435 * determined <b>by the widget's theme</b>. Strings larger than
6436 * that value are going to be @b truncated.
6438 * @ingroup Flipselector
6440 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6443 * Get the internal list of items in a given flip selector widget.
6445 * @param obj The flipselector object
6446 * @return The list of items (#Elm_Flipselector_Item as data) or @c
6449 * This list is @b not to be modified in any way and must not be
6450 * freed. Use the list members with functions like
6451 * elm_flipselector_item_label_set(),
6452 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
6453 * elm_flipselector_item_del(),
6454 * elm_flipselector_item_selected_get(),
6455 * elm_flipselector_item_selected_set().
6457 * @warning This list is only valid until @p obj object's internal
6458 * items list is changed. It should be fetched again with another
6459 * call to this function when changes happen.
6461 * @ingroup Flipselector
6463 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6466 * Get the first item in the given flip selector widget's list of
6469 * @param obj The flipselector object
6470 * @return The first item or @c NULL, if it has no items (and on
6473 * @see elm_flipselector_item_append()
6474 * @see elm_flipselector_last_item_get()
6476 * @ingroup Flipselector
6478 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6481 * Get the last item in the given flip selector widget's list of
6484 * @param obj The flipselector object
6485 * @return The last item or @c NULL, if it has no items (and on
6488 * @see elm_flipselector_item_prepend()
6489 * @see elm_flipselector_first_item_get()
6491 * @ingroup Flipselector
6493 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6496 * Get the currently selected item in a flip selector widget.
6498 * @param obj The flipselector object
6499 * @return The selected item or @c NULL, if the widget has no items
6502 * @ingroup Flipselector
6504 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6507 * Set whether a given flip selector widget's item should be the
6508 * currently selected one.
6510 * @param item The flip selector item
6511 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
6513 * This sets whether @p item is or not the selected (thus, under
6514 * display) one. If @p item is different than one under display,
6515 * the latter will be unselected. If the @p item is set to be
6516 * unselected, on the other hand, the @b first item in the widget's
6517 * internal members list will be the new selected one.
6519 * @see elm_flipselector_item_selected_get()
6521 * @ingroup Flipselector
6523 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6526 * Get whether a given flip selector widget's item is the currently
6529 * @param item The flip selector item
6530 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6533 * @see elm_flipselector_item_selected_set()
6535 * @ingroup Flipselector
6537 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6540 * Delete a given item from a flip selector widget.
6542 * @param item The item to delete
6544 * @ingroup Flipselector
6546 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6549 * Get the label of a given flip selector widget's item.
6551 * @param item The item to get label from
6552 * @return The text label of @p item or @c NULL, on errors
6554 * @see elm_flipselector_item_label_set()
6556 * @ingroup Flipselector
6558 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6561 * Set the label of a given flip selector widget's item.
6563 * @param item The item to set label on
6564 * @param label The text label string, in UTF-8 encoding
6566 * @see elm_flipselector_item_label_get()
6568 * @ingroup Flipselector
6570 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6573 * Gets the item before @p item in a flip selector widget's
6574 * internal list of items.
6576 * @param item The item to fetch previous from
6577 * @return The item before the @p item, in its parent's list. If
6578 * there is no previous item for @p item or there's an
6579 * error, @c NULL is returned.
6581 * @see elm_flipselector_item_next_get()
6583 * @ingroup Flipselector
6585 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6588 * Gets the item after @p item in a flip selector widget's
6589 * internal list of items.
6591 * @param item The item to fetch next from
6592 * @return The item after the @p item, in its parent's list. If
6593 * there is no next item for @p item or there's an
6594 * error, @c NULL is returned.
6596 * @see elm_flipselector_item_next_get()
6598 * @ingroup Flipselector
6600 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6603 * Set the interval on time updates for an user mouse button hold
6604 * on a flip selector widget.
6606 * @param obj The flip selector object
6607 * @param interval The (first) interval value in seconds
6609 * This interval value is @b decreased while the user holds the
6610 * mouse pointer either flipping up or flipping doww a given flip
6613 * This helps the user to get to a given item distant from the
6614 * current one easier/faster, as it will start to flip quicker and
6615 * quicker on mouse button holds.
6617 * The calculation for the next flip interval value, starting from
6618 * the one set with this call, is the previous interval divided by
6619 * 1.05, so it decreases a little bit.
6621 * The default starting interval value for automatic flips is
6624 * @see elm_flipselector_interval_get()
6626 * @ingroup Flipselector
6628 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6631 * Get the interval on time updates for an user mouse button hold
6632 * on a flip selector widget.
6634 * @param obj The flip selector object
6635 * @return The (first) interval value, in seconds, set on it
6637 * @see elm_flipselector_interval_set() for more details
6639 * @ingroup Flipselector
6641 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6648 * @addtogroup Animator Animator
6649 * @ingroup Elementary
6651 * @brief Functions to ease creation of animations.
6653 * elm_animator is designed to provide an easy way to create animations.
6654 * Creating an animation with elm_animator is as simple as setting a
6655 * duration, an operating callback and telling it to run the animation.
6656 * However that is not the full extent of elm_animator's ability, animations
6657 * can be paused and resumed, reversed and the animation need not be linear.
6659 * To run an animation you must specify at least a duration and operation
6660 * callback, not setting any other properties will create a linear animation
6661 * that runs once and is not reversed.
6663 * @ref elm_animator_example_page_01 "This" example should make all of that
6666 * @warning elm_animator is @b not a widget.
6670 * @brief Type of curve desired for animation.
6672 * The speed in which an animation happens doesn't have to be linear, some
6673 * animations will look better if they're accelerating or decelerating, so
6674 * elm_animator provides four options in this regard:
6675 * @image html elm_animator_curve_style.png
6676 * @image latex elm_animator_curve_style.eps width=\textwidth
6677 * As can be seen in the image the speed of the animation will be:
6678 * @li ELM_ANIMATOR_CURVE_LINEAR constant
6679 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
6680 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
6681 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
6685 ELM_ANIMATOR_CURVE_LINEAR,
6686 ELM_ANIMATOR_CURVE_IN_OUT,
6687 ELM_ANIMATOR_CURVE_IN,
6688 ELM_ANIMATOR_CURVE_OUT
6689 } Elm_Animator_Curve_Style;
6690 typedef struct _Elm_Animator Elm_Animator;
6692 * Called back per loop of an elementary animators cycle
6693 * @param data user-data given to elm_animator_operation_callback_set()
6694 * @param animator the animator being run
6695 * @param double the position in the animation
6697 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
6699 * Called back when an elementary animator finishes
6700 * @param data user-data given to elm_animator_completion_callback_set()
6702 typedef void (*Elm_Animator_Completion_Cb) (void *data);
6705 * @brief Create a new animator.
6707 * @param[in] parent Parent object
6709 * The @a parent argument can be set to NULL for no parent. If a parent is set
6710 * there is no need to call elm_animator_del(), when the parent is deleted it
6711 * will delete the animator.
6712 * @deprecated Use @ref Transit instead.
6715 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
6717 * Deletes the animator freeing any resources it used. If the animator was
6718 * created with a NULL parent this must be called, otherwise it will be
6719 * automatically called when the parent is deleted.
6721 * @param[in] animator Animator object
6722 * @deprecated Use @ref Transit instead.
6724 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6726 * Set the duration of the animation.
6728 * @param[in] animator Animator object
6729 * @param[in] duration Duration in second
6730 * @deprecated Use @ref Transit instead.
6732 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
6734 * @brief Set the callback function for animator operation.
6736 * @param[in] animator Animator object
6737 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
6738 * @param[in] data Callback function user argument
6740 * The @p func callback will be called with a frame value in range [0, 1] which
6741 * indicates how far along the animation should be. It is the job of @p func to
6742 * actually change the state of any object(or objects) that are being animated.
6743 * @deprecated Use @ref Transit instead.
6745 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
6747 * Set the callback function for the when the animation ends.
6749 * @param[in] animator Animator object
6750 * @param[in] func Callback function pointe
6751 * @param[in] data Callback function user argument
6753 * @warning @a func will not be executed if elm_animator_stop() is called.
6754 * @deprecated Use @ref Transit instead.
6756 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
6758 * @brief Stop animator.
6760 * @param[in] animator Animator object
6762 * If called before elm_animator_animate() it does nothing. If there is an
6763 * animation in progress the animation will be stopped(the operation callback
6764 * will not be executed again) and it can't be restarted using
6765 * elm_animator_resume().
6766 * @deprecated Use @ref Transit instead.
6768 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6770 * Set the animator repeat count.
6772 * @param[in] animator Animator object
6773 * @param[in] repeat_cnt Repeat count
6774 * @deprecated Use @ref Transit instead.
6776 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
6778 * @brief Start animation.
6780 * @param[in] animator Animator object
6782 * This function starts the animation if the nescessary properties(duration
6783 * and operation callback) have been set. Once started the animation will
6784 * run until complete or elm_animator_stop() is called.
6785 * @deprecated Use @ref Transit instead.
6787 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6789 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6791 * @param[in] animator Animator object
6792 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6793 * @deprecated Use @ref Transit instead.
6795 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
6797 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6799 * @param[in] animator Animator object
6800 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6801 * @deprecated Use @ref Transit instead.
6803 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6805 * @brief Sets wether the animation should be automatically reversed.
6807 * @param[in] animator Animator object
6808 * @param[in] reverse Reverse or not
6810 * This controls wether the animation will be run on reverse imediately after
6811 * running forward. When this is set together with repetition the animation
6812 * will run in reverse once for each time it ran forward.@n
6813 * Runnin an animation in reverse is accomplished by calling the operation
6814 * callback with a frame value starting at 1 and diminshing until 0.
6815 * @deprecated Use @ref Transit instead.
6817 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
6819 * Gets wether the animation will automatically reversed
6821 * @param[in] animator Animator object
6822 * @deprecated Use @ref Transit instead.
6824 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6826 * Gets the status for the animator operation. The status of the animator @b
6827 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
6828 * only informs if the animation was started and has not ended(either normally
6829 * or through elm_animator_stop()).
6831 * @param[in] animator Animator object
6832 * @deprecated Use @ref Transit instead.
6834 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6836 * Gets how many times the animation will be repeated
6838 * @param[in] animator Animator object
6839 * @deprecated Use @ref Transit instead.
6841 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6843 * Pause the animator.
6845 * @param[in] animator Animator object
6847 * This causes the animation to be temporarily stopped(the operation callback
6848 * will not be called). If the animation is not yet running this is a no-op.
6849 * Once an animation has been paused with this function it can be resumed
6850 * using elm_animator_resume().
6851 * @deprecated Use @ref Transit instead.
6853 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6855 * @brief Resumes the animator.
6857 * @param[in] animator Animator object
6859 * Resumes an animation that was paused using elm_animator_pause(), after
6860 * calling this function calls to the operation callback will happen
6861 * normally. If an animation is stopped by means of elm_animator_stop it
6862 * @b can't be restarted with this function.@n
6864 * @warning When an animation is resumed it doesn't start from where it was paused, it
6865 * will go to where it would have been if it had not been paused. If an
6866 * animation with a duration of 3 seconds is paused after 1 second for 1 second
6867 * it will resume as if it had ben animating for 2 seconds, the operating
6868 * callback will be called with a frame value of aproximately 2/3.
6869 * @deprecated Use @ref Transit instead.
6871 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6879 ELM_CALENDAR_UNIQUE,
6881 ELM_CALENDAR_WEEKLY,
6882 ELM_CALENDAR_MONTHLY,
6883 ELM_CALENDAR_ANNUALLY
6884 } Elm_Calendar_Mark_Repeat;
6885 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
6887 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6888 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6889 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
6890 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6891 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6892 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
6893 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
6894 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6895 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6896 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
6897 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
6898 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
6899 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);
6900 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
6901 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6902 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6903 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
6904 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6905 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6906 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6907 /* smart callbacks called:
6908 * changed - emitted when the user select a day or change the displayed
6913 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
6915 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6916 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6917 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
6918 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6919 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
6920 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6921 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
6922 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6923 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6924 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);
6925 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6926 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6927 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6928 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);
6929 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6930 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6931 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6932 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6933 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
6934 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6935 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6936 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6937 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6938 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6939 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6940 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6941 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6942 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6943 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
6944 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);
6945 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6946 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
6947 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6948 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6949 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6950 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6951 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
6952 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6953 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6954 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6955 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
6956 /* smart callbacks called:
6957 * "selected" - when item is selected (scroller stops)
6961 * @page tutorial_colorselector Color selector example
6962 * @dontinclude colorselector_example_01.c
6964 * This example shows how to change the color of a rectangle using a color
6965 * selector. We aren't going to explain a lot of the code since it's the
6969 * Now that we have a window with background and a rectangle we can create
6970 * our color_selector and set it's initial color to fully opaque blue:
6973 * Next we tell ask to be notified whenever the color changes:
6976 * We follow that we some more run of the mill setup code:
6979 * And now get to the callback that sets the color of the rectangle:
6982 * This example will look like this:
6983 * @image html screenshots/colorselector_example_01.png
6984 * @image latex screenshots/colorselector_example_01.eps
6986 * @example colorselector_example_01.c
6989 * @defgroup Colorselector Colorselector
6993 * @brief Widget for user to select a color.
6995 * Signals that you can add callbacks for are:
6996 * "changed" - When the color value changes(event_info is NULL).
6998 * See @ref tutorial_colorselector.
7001 * @brief Add a new colorselector to the parent
7003 * @param parent The parent object
7004 * @return The new object or NULL if it cannot be created
7006 * @ingroup Colorselector
7008 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7010 * Set a color for the colorselector
7012 * @param obj Colorselector object
7013 * @param r r-value of color
7014 * @param g g-value of color
7015 * @param b b-value of color
7016 * @param a a-value of color
7018 * @ingroup Colorselector
7020 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
7022 * Get a color from the colorselector
7024 * @param obj Colorselector object
7025 * @param r integer pointer for r-value of color
7026 * @param g integer pointer for g-value of color
7027 * @param b integer pointer for b-value of color
7028 * @param a integer pointer for a-value of color
7030 * @ingroup Colorselector
7032 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
7037 /* Contextual Popup */
7038 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
7040 typedef enum _Elm_Ctxpopup_Direction
7042 ELM_CTXPOPUP_DIRECTION_DOWN,
7043 ELM_CTXPOPUP_DIRECTION_RIGHT,
7044 ELM_CTXPOPUP_DIRECTION_LEFT,
7045 ELM_CTXPOPUP_DIRECTION_UP,
7046 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
7047 } Elm_Ctxpopup_Direction;
7049 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7050 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7051 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7052 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7053 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
7054 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
7055 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7056 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7057 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7058 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7059 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);
7060 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7061 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7062 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7063 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
7064 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7065 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);
7066 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);
7067 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7068 /* smart callbacks called:
7069 * "dismissed" - the ctxpopup was dismissed
7075 * @defgroup Transit Transit
7076 * @ingroup Elementary
7078 * Transit is designed to apply various animated transition effects to @c
7079 * Evas_Object, such like translation, rotation, etc. For using these
7080 * effects, create an @ref Elm_Transit and add the desired transition effects.
7082 * Once the effects are added into transit, they will be automatically
7083 * managed (their callback will be called until the duration is ended, and
7084 * they will be deleted on completion).
7088 * Elm_Transit *trans = elm_transit_add();
7089 * elm_transit_object_add(trans, obj);
7090 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
7091 * elm_transit_duration_set(transit, 1);
7092 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
7093 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
7094 * elm_transit_repeat_times_set(transit, 3);
7097 * Some transition effects are used to change the properties of objects. They
7099 * @li @ref elm_transit_effect_translation_add
7100 * @li @ref elm_transit_effect_color_add
7101 * @li @ref elm_transit_effect_rotation_add
7102 * @li @ref elm_transit_effect_wipe_add
7103 * @li @ref elm_transit_effect_zoom_add
7104 * @li @ref elm_transit_effect_resizing_add
7106 * Other transition effects are used to make one object disappear and another
7107 * object appear on its old place. These effects are:
7109 * @li @ref elm_transit_effect_flip_add
7110 * @li @ref elm_transit_effect_resizable_flip_add
7111 * @li @ref elm_transit_effect_fade_add
7112 * @li @ref elm_transit_effect_blend_add
7114 * It's also possible to make a transition chain with @ref
7115 * elm_transit_chain_transit_add.
7117 * @warning We strongly recommend to use elm_transit just when edje can not do
7118 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
7119 * animations can be manipulated inside the theme.
7122 * @li @ref transit_example_01_explained
7123 * @li @ref transit_example_02_explained
7124 * @li @ref transit_example_03_c
7125 * @li @ref transit_example_04_c
7131 * @enum Elm_Transit_Tween_Mode
7133 * The type of acceleration used in the transition.
7137 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
7138 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
7139 over time, then decrease again
7141 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
7143 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
7145 } Elm_Transit_Tween_Mode;
7148 * @enum Elm_Transit_Effect_Flip_Axis
7150 * The axis where flip effect should be applied.
7154 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
7155 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
7156 } Elm_Transit_Effect_Flip_Axis;
7158 * @enum Elm_Transit_Effect_Wipe_Dir
7160 * The direction where the wipe effect should occur.
7164 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
7165 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
7166 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
7167 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
7168 } Elm_Transit_Effect_Wipe_Dir;
7169 /** @enum Elm_Transit_Effect_Wipe_Type
7171 * Whether the wipe effect should show or hide the object.
7175 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
7177 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
7179 } Elm_Transit_Effect_Wipe_Type;
7182 * @typedef Elm_Transit
7184 * The Transit created with elm_transit_add(). This type has the information
7185 * about the objects which the transition will be applied, and the
7186 * transition effects that will be used. It also contains info about
7187 * duration, number of repetitions, auto-reverse, etc.
7189 typedef struct _Elm_Transit Elm_Transit;
7190 typedef void Elm_Transit_Effect;
7192 * @typedef Elm_Transit_Effect_Transition_Cb
7194 * Transition callback called for this effect on each transition iteration.
7196 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
7198 * Elm_Transit_Effect_End_Cb
7200 * Transition callback called for this effect when the transition is over.
7202 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
7205 * Elm_Transit_Del_Cb
7207 * A callback called when the transit is deleted.
7209 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
7214 * @note Is not necessary to delete the transit object, it will be deleted at
7215 * the end of its operation.
7216 * @note The transit will start playing when the program enter in the main loop, is not
7217 * necessary to give a start to the transit.
7219 * @return The transit object.
7223 EAPI Elm_Transit *elm_transit_add(void);
7226 * Stops the animation and delete the @p transit object.
7228 * Call this function if you wants to stop the animation before the duration
7229 * time. Make sure the @p transit object is still alive with
7230 * elm_transit_del_cb_set() function.
7231 * All added effects will be deleted, calling its repective data_free_cb
7232 * functions. The function setted by elm_transit_del_cb_set() will be called.
7234 * @see elm_transit_del_cb_set()
7236 * @param transit The transit object to be deleted.
7239 * @warning Just call this function if you are sure the transit is alive.
7241 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7244 * Add a new effect to the transit.
7246 * @note The cb function and the data are the key to the effect. If you try to
7247 * add an already added effect, nothing is done.
7248 * @note After the first addition of an effect in @p transit, if its
7249 * effect list become empty again, the @p transit will be killed by
7250 * elm_transit_del(transit) function.
7254 * Elm_Transit *transit = elm_transit_add();
7255 * elm_transit_effect_add(transit,
7256 * elm_transit_effect_blend_op,
7257 * elm_transit_effect_blend_context_new(),
7258 * elm_transit_effect_blend_context_free);
7261 * @param transit The transit object.
7262 * @param transition_cb The operation function. It is called when the
7263 * animation begins, it is the function that actually performs the animation.
7264 * It is called with the @p data, @p transit and the time progression of the
7265 * animation (a double value between 0.0 and 1.0).
7266 * @param effect The context data of the effect.
7267 * @param end_cb The function to free the context data, it will be called
7268 * at the end of the effect, it must finalize the animation and free the
7272 * @warning The transit free the context data at the and of the transition with
7273 * the data_free_cb function, do not use the context data in another transit.
7275 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);
7278 * Delete an added effect.
7280 * This function will remove the effect from the @p transit, calling the
7281 * data_free_cb to free the @p data.
7283 * @see elm_transit_effect_add()
7285 * @note If the effect is not found, nothing is done.
7286 * @note If the effect list become empty, this function will call
7287 * elm_transit_del(transit), that is, it will kill the @p transit.
7289 * @param transit The transit object.
7290 * @param transition_cb The operation function.
7291 * @param effect The context data of the effect.
7295 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);
7298 * Add new object to apply the effects.
7300 * @note After the first addition of an object in @p transit, if its
7301 * object list become empty again, the @p transit will be killed by
7302 * elm_transit_del(transit) function.
7303 * @note If the @p obj belongs to another transit, the @p obj will be
7304 * removed from it and it will only belong to the @p transit. If the old
7305 * transit stays without objects, it will die.
7306 * @note When you add an object into the @p transit, its state from
7307 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7308 * transit ends, if you change this state whith evas_object_pass_events_set()
7309 * after add the object, this state will change again when @p transit stops to
7312 * @param transit The transit object.
7313 * @param obj Object to be animated.
7316 * @warning It is not allowed to add a new object after transit begins to go.
7318 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7321 * Removes an added object from the transit.
7323 * @note If the @p obj is not in the @p transit, nothing is done.
7324 * @note If the list become empty, this function will call
7325 * elm_transit_del(transit), that is, it will kill the @p transit.
7327 * @param transit The transit object.
7328 * @param obj Object to be removed from @p transit.
7331 * @warning It is not allowed to remove objects after transit begins to go.
7333 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7336 * Get the objects of the transit.
7338 * @param transit The transit object.
7339 * @return a Eina_List with the objects from the transit.
7343 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7346 * Enable/disable keeping up the objects states.
7347 * If it is not kept, the objects states will be reset when transition ends.
7349 * @note @p transit can not be NULL.
7350 * @note One state includes geometry, color, map data.
7352 * @param transit The transit object.
7353 * @param state_keep Keeping or Non Keeping.
7357 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
7360 * Get a value whether the objects states will be reset or not.
7362 * @note @p transit can not be NULL
7364 * @see elm_transit_objects_final_state_keep_set()
7366 * @param transit The transit object.
7367 * @return EINA_TRUE means the states of the objects will be reset.
7368 * If @p transit is NULL, EINA_FALSE is returned
7372 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7375 * Set the event enabled when transit is operating.
7377 * If @p enabled is EINA_TRUE, the objects of the transit will receives
7378 * events from mouse and keyboard during the animation.
7379 * @note When you add an object with elm_transit_object_add(), its state from
7380 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7381 * transit ends, if you change this state with evas_object_pass_events_set()
7382 * after adding the object, this state will change again when @p transit stops
7385 * @param transit The transit object.
7386 * @param enabled Events are received when enabled is @c EINA_TRUE, and
7387 * ignored otherwise.
7391 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7394 * Get the value of event enabled status.
7396 * @see elm_transit_event_enabled_set()
7398 * @param transit The Transit object
7399 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
7400 * EINA_FALSE is returned
7404 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7407 * Set the user-callback function when the transit is deleted.
7409 * @note Using this function twice will overwrite the first function setted.
7410 * @note the @p transit object will be deleted after call @p cb function.
7412 * @param transit The transit object.
7413 * @param cb Callback function pointer. This function will be called before
7414 * the deletion of the transit.
7415 * @param data Callback funtion user data. It is the @p op parameter.
7419 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
7422 * Set reverse effect automatically.
7424 * If auto reverse is setted, after running the effects with the progress
7425 * parameter from 0 to 1, it will call the effecs again with the progress
7426 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
7427 * where the duration was setted with the function elm_transit_add and
7428 * the repeat with the function elm_transit_repeat_times_set().
7430 * @param transit The transit object.
7431 * @param reverse EINA_TRUE means the auto_reverse is on.
7435 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
7438 * Get if the auto reverse is on.
7440 * @see elm_transit_auto_reverse_set()
7442 * @param transit The transit object.
7443 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
7444 * EINA_FALSE is returned
7448 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7451 * Set the transit repeat count. Effect will be repeated by repeat count.
7453 * This function sets the number of repetition the transit will run after
7454 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
7455 * If the @p repeat is a negative number, it will repeat infinite times.
7457 * @note If this function is called during the transit execution, the transit
7458 * will run @p repeat times, ignoring the times it already performed.
7460 * @param transit The transit object
7461 * @param repeat Repeat count
7465 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
7468 * Get the transit repeat count.
7470 * @see elm_transit_repeat_times_set()
7472 * @param transit The Transit object.
7473 * @return The repeat count. If @p transit is NULL
7478 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7481 * Set the transit animation acceleration type.
7483 * This function sets the tween mode of the transit that can be:
7484 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
7485 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
7486 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
7487 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
7489 * @param transit The transit object.
7490 * @param tween_mode The tween type.
7494 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
7497 * Get the transit animation acceleration type.
7499 * @note @p transit can not be NULL
7501 * @param transit The transit object.
7502 * @return The tween type. If @p transit is NULL
7503 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
7507 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7510 * Set the transit animation time
7512 * @note @p transit can not be NULL
7514 * @param transit The transit object.
7515 * @param duration The animation time.
7519 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
7522 * Get the transit animation time
7524 * @note @p transit can not be NULL
7526 * @param transit The transit object.
7528 * @return The transit animation time.
7532 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7535 * Starts the transition.
7536 * Once this API is called, the transit begins to measure the time.
7538 * @note @p transit can not be NULL
7540 * @param transit The transit object.
7544 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7547 * Pause/Resume the transition.
7549 * If you call elm_transit_go again, the transit will be started from the
7550 * beginning, and will be unpaused.
7552 * @note @p transit can not be NULL
7554 * @param transit The transit object.
7555 * @param paused Whether the transition should be paused or not.
7559 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
7562 * Get the value of paused status.
7564 * @see elm_transit_paused_set()
7566 * @note @p transit can not be NULL
7568 * @param transit The transit object.
7569 * @return EINA_TRUE means transition is paused. If @p transit is NULL
7570 * EINA_FALSE is returned
7574 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7577 * Get the time progression of the animation (a double value between 0.0 and 1.0).
7579 * The value returned is a fraction (current time / total time). It
7580 * represents the progression position relative to the total.
7582 * @note @p transit can not be NULL
7584 * @param transit The transit object.
7586 * @return The time progression value. If @p transit is NULL
7591 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7594 * Makes the chain relationship between two transits.
7596 * @note @p transit can not be NULL. Transit would have multiple chain transits.
7597 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
7599 * @param transit The transit object.
7600 * @param chain_transit The chain transit object. This transit will be operated
7601 * after transit is done.
7603 * This function adds @p chain_transit transition to a chain after the @p
7604 * transit, and will be started as soon as @p transit ends. See @ref
7605 * transit_example_02_explained for a full example.
7609 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
7612 * Cut off the chain relationship between two transits.
7614 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
7615 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
7617 * @param transit The transit object.
7618 * @param chain_transit The chain transit object.
7620 * This function remove the @p chain_transit transition from the @p transit.
7624 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
7627 * Get the current chain transit list.
7629 * @note @p transit can not be NULL.
7631 * @param transit The transit object.
7632 * @return chain transit list.
7636 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
7639 * Add the Resizing Effect to Elm_Transit.
7641 * @note This API is one of the facades. It creates resizing effect context
7642 * and add it's required APIs to elm_transit_effect_add.
7644 * @see elm_transit_effect_add()
7646 * @param transit Transit object.
7647 * @param from_w Object width size when effect begins.
7648 * @param from_h Object height size when effect begins.
7649 * @param to_w Object width size when effect ends.
7650 * @param to_h Object height size when effect ends.
7651 * @return Resizing effect context data.
7655 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);
7658 * Add the Translation Effect to Elm_Transit.
7660 * @note This API is one of the facades. It creates translation effect context
7661 * and add it's required APIs to elm_transit_effect_add.
7663 * @see elm_transit_effect_add()
7665 * @param transit Transit object.
7666 * @param from_dx X Position variation when effect begins.
7667 * @param from_dy Y Position variation when effect begins.
7668 * @param to_dx X Position variation when effect ends.
7669 * @param to_dy Y Position variation when effect ends.
7670 * @return Translation effect context data.
7673 * @warning It is highly recommended just create a transit with this effect when
7674 * the window that the objects of the transit belongs has already been created.
7675 * This is because this effect needs the geometry information about the objects,
7676 * and if the window was not created yet, it can get a wrong information.
7678 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);
7681 * Add the Zoom Effect to Elm_Transit.
7683 * @note This API is one of the facades. It creates zoom effect context
7684 * and add it's required APIs to elm_transit_effect_add.
7686 * @see elm_transit_effect_add()
7688 * @param transit Transit object.
7689 * @param from_rate Scale rate when effect begins (1 is current rate).
7690 * @param to_rate Scale rate when effect ends.
7691 * @return Zoom effect context data.
7694 * @warning It is highly recommended just create a transit with this effect when
7695 * the window that the objects of the transit belongs has already been created.
7696 * This is because this effect needs the geometry information about the objects,
7697 * and if the window was not created yet, it can get a wrong information.
7699 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
7702 * Add the Flip Effect to Elm_Transit.
7704 * @note This API is one of the facades. It creates flip effect context
7705 * and add it's required APIs to elm_transit_effect_add.
7706 * @note This effect is applied to each pair of objects in the order they are listed
7707 * in the transit list of objects. The first object in the pair will be the
7708 * "front" object and the second will be the "back" object.
7710 * @see elm_transit_effect_add()
7712 * @param transit Transit object.
7713 * @param axis Flipping Axis(X or Y).
7714 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7715 * @return Flip effect context data.
7718 * @warning It is highly recommended just create a transit with this effect when
7719 * the window that the objects of the transit belongs has already been created.
7720 * This is because this effect needs the geometry information about the objects,
7721 * and if the window was not created yet, it can get a wrong information.
7723 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7726 * Add the Resizable Flip Effect to Elm_Transit.
7728 * @note This API is one of the facades. It creates resizable flip effect context
7729 * and add it's required APIs to elm_transit_effect_add.
7730 * @note This effect is applied to each pair of objects in the order they are listed
7731 * in the transit list of objects. The first object in the pair will be the
7732 * "front" object and the second will be the "back" object.
7734 * @see elm_transit_effect_add()
7736 * @param transit Transit object.
7737 * @param axis Flipping Axis(X or Y).
7738 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7739 * @return Resizable flip effect context data.
7742 * @warning It is highly recommended just create a transit with this effect when
7743 * the window that the objects of the transit belongs has already been created.
7744 * This is because this effect needs the geometry information about the objects,
7745 * and if the window was not created yet, it can get a wrong information.
7747 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7750 * Add the Wipe Effect to Elm_Transit.
7752 * @note This API is one of the facades. It creates wipe effect context
7753 * and add it's required APIs to elm_transit_effect_add.
7755 * @see elm_transit_effect_add()
7757 * @param transit Transit object.
7758 * @param type Wipe type. Hide or show.
7759 * @param dir Wipe Direction.
7760 * @return Wipe effect context data.
7763 * @warning It is highly recommended just create a transit with this effect when
7764 * the window that the objects of the transit belongs has already been created.
7765 * This is because this effect needs the geometry information about the objects,
7766 * and if the window was not created yet, it can get a wrong information.
7768 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
7771 * Add the Color Effect to Elm_Transit.
7773 * @note This API is one of the facades. It creates color effect context
7774 * and add it's required APIs to elm_transit_effect_add.
7776 * @see elm_transit_effect_add()
7778 * @param transit Transit object.
7779 * @param from_r RGB R when effect begins.
7780 * @param from_g RGB G when effect begins.
7781 * @param from_b RGB B when effect begins.
7782 * @param from_a RGB A when effect begins.
7783 * @param to_r RGB R when effect ends.
7784 * @param to_g RGB G when effect ends.
7785 * @param to_b RGB B when effect ends.
7786 * @param to_a RGB A when effect ends.
7787 * @return Color effect context data.
7791 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);
7794 * Add the Fade Effect to Elm_Transit.
7796 * @note This API is one of the facades. It creates fade effect context
7797 * and add it's required APIs to elm_transit_effect_add.
7798 * @note This effect is applied to each pair of objects in the order they are listed
7799 * in the transit list of objects. The first object in the pair will be the
7800 * "before" object and the second will be the "after" object.
7802 * @see elm_transit_effect_add()
7804 * @param transit Transit object.
7805 * @return Fade effect context data.
7808 * @warning It is highly recommended just create a transit with this effect when
7809 * the window that the objects of the transit belongs has already been created.
7810 * This is because this effect needs the color information about the objects,
7811 * and if the window was not created yet, it can get a wrong information.
7813 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
7816 * Add the Blend Effect to Elm_Transit.
7818 * @note This API is one of the facades. It creates blend effect context
7819 * and add it's required APIs to elm_transit_effect_add.
7820 * @note This effect is applied to each pair of objects in the order they are listed
7821 * in the transit list of objects. The first object in the pair will be the
7822 * "before" object and the second will be the "after" object.
7824 * @see elm_transit_effect_add()
7826 * @param transit Transit object.
7827 * @return Blend effect context data.
7830 * @warning It is highly recommended just create a transit with this effect when
7831 * the window that the objects of the transit belongs has already been created.
7832 * This is because this effect needs the color information about the objects,
7833 * and if the window was not created yet, it can get a wrong information.
7835 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
7838 * Add the Rotation Effect to Elm_Transit.
7840 * @note This API is one of the facades. It creates rotation effect context
7841 * and add it's required APIs to elm_transit_effect_add.
7843 * @see elm_transit_effect_add()
7845 * @param transit Transit object.
7846 * @param from_degree Degree when effect begins.
7847 * @param to_degree Degree when effect is ends.
7848 * @return Rotation effect context data.
7851 * @warning It is highly recommended just create a transit with this effect when
7852 * the window that the objects of the transit belongs has already been created.
7853 * This is because this effect needs the geometry information about the objects,
7854 * and if the window was not created yet, it can get a wrong information.
7856 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
7859 * Add the ImageAnimation Effect to Elm_Transit.
7861 * @note This API is one of the facades. It creates image animation effect context
7862 * and add it's required APIs to elm_transit_effect_add.
7863 * The @p images parameter is a list images paths. This list and
7864 * its contents will be deleted at the end of the effect by
7865 * elm_transit_effect_image_animation_context_free() function.
7869 * char buf[PATH_MAX];
7870 * Eina_List *images = NULL;
7871 * Elm_Transit *transi = elm_transit_add();
7873 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
7874 * images = eina_list_append(images, eina_stringshare_add(buf));
7876 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
7877 * images = eina_list_append(images, eina_stringshare_add(buf));
7878 * elm_transit_effect_image_animation_add(transi, images);
7882 * @see elm_transit_effect_add()
7884 * @param transit Transit object.
7885 * @param images Eina_List of images file paths. This list and
7886 * its contents will be deleted at the end of the effect by
7887 * elm_transit_effect_image_animation_context_free() function.
7888 * @return Image Animation effect context data.
7892 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
7898 typedef struct _Elm_Store Elm_Store;
7899 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
7900 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
7901 typedef struct _Elm_Store_Item Elm_Store_Item;
7902 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
7903 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
7904 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
7905 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
7906 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
7907 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
7908 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
7909 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
7910 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
7912 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
7913 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
7914 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
7915 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
7916 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
7917 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
7918 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
7922 ELM_STORE_ITEM_MAPPING_NONE = 0,
7923 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
7924 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
7925 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
7926 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
7927 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
7928 // can add more here as needed by common apps
7929 ELM_STORE_ITEM_MAPPING_LAST
7930 } Elm_Store_Item_Mapping_Type;
7932 struct _Elm_Store_Item_Mapping_Icon
7934 // FIXME: allow edje file icons
7936 Elm_Icon_Lookup_Order lookup_order;
7937 Eina_Bool standard_name : 1;
7938 Eina_Bool no_scale : 1;
7939 Eina_Bool smooth : 1;
7940 Eina_Bool scale_up : 1;
7941 Eina_Bool scale_down : 1;
7944 struct _Elm_Store_Item_Mapping_Empty
7949 struct _Elm_Store_Item_Mapping_Photo
7954 struct _Elm_Store_Item_Mapping_Custom
7956 Elm_Store_Item_Mapping_Cb func;
7959 struct _Elm_Store_Item_Mapping
7961 Elm_Store_Item_Mapping_Type type;
7965 Elm_Store_Item_Mapping_Empty empty;
7966 Elm_Store_Item_Mapping_Icon icon;
7967 Elm_Store_Item_Mapping_Photo photo;
7968 Elm_Store_Item_Mapping_Custom custom;
7969 // add more types here
7973 struct _Elm_Store_Item_Info
7979 int pre_group_index;
7981 Elm_Genlist_Item_Class *item_class;
7982 const Elm_Store_Item_Mapping *mapping;
7987 struct _Elm_Store_Item_Info_Filesystem
7989 Elm_Store_Item_Info base;
7993 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
7994 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
7996 EAPI Elm_Store *elm_store_dbsystem_new(void);
7997 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
7998 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
7999 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
8000 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
8001 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8002 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8003 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
8004 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8005 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
8006 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8007 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
8008 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8009 EAPI void elm_store_free(Elm_Store *st);
8010 EAPI Elm_Store *elm_store_filesystem_new(void);
8011 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
8012 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8013 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8014 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
8015 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
8016 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8017 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8018 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8019 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
8020 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8021 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8022 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
8023 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8024 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
8025 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8026 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8027 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8029 /* SegmentControl */
8030 typedef struct _Elm_Segment_Item Elm_Segment_Item;
8031 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8032 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
8033 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);
8034 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8035 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8036 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8037 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8038 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8039 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
8040 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8041 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
8042 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8043 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8044 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8045 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
8046 /* smart callbacks called:
8047 * "changed" -when the user clicks on a segment item which is not previously
8048 * selected and get selected. The event_info parameter is the
8049 * segment item index.
8052 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
8053 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
8054 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
8055 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
8056 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
8057 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
8058 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
8059 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
8061 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
8062 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
8064 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
8065 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
8066 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
8067 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
8068 EAPI void elm_video_play(Evas_Object *video);
8069 EAPI void elm_video_pause(Evas_Object *video);
8070 EAPI void elm_video_stop(Evas_Object *video);
8071 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
8072 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
8073 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
8074 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
8075 EAPI double elm_video_audio_level_get(Evas_Object *video);
8076 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
8077 EAPI double elm_video_play_position_get(Evas_Object *video);
8078 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
8079 EAPI double elm_video_play_length_get(Evas_Object *video);
8080 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
8081 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
8082 EAPI const char *elm_video_title_get(Evas_Object *video);
8084 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
8085 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
8087 // FIXME: incomplete - carousel. don't use this until this comment is removed
8088 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
8089 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
8090 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
8091 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
8092 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
8093 /* smart callbacks called:
8094 * "clicked" - when the user clicks on a carousel item and becomes selected
8099 typedef enum _Elm_Datefield_ItemType
8101 ELM_DATEFIELD_YEAR = 0,
8102 ELM_DATEFIELD_MONTH,
8105 ELM_DATEFIELD_MINUTE,
8107 } Elm_Datefield_ItemType;
8109 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
8110 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
8111 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
8112 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
8113 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8114 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
8115 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8116 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
8117 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8118 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8119 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
8120 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8121 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8123 /* smart callbacks called:
8124 * "changed" - when datefield value is changed, this signal is sent.
8127 ////////////////////// DEPRECATED ///////////////////////////////////
8129 typedef enum _Elm_Datefield_Layout
8131 ELM_DATEFIELD_LAYOUT_TIME,
8132 ELM_DATEFIELD_LAYOUT_DATE,
8133 ELM_DATEFIELD_LAYOUT_DATEANDTIME
8134 } Elm_Datefield_Layout;
8136 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
8137 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
8138 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
8139 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
8140 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
8141 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
8142 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
8143 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
8144 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
8145 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
8146 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
8147 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
8148 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
8149 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
8150 /////////////////////////////////////////////////////////////////////
8153 typedef enum _Elm_Popup_Response
8155 ELM_POPUP_RESPONSE_NONE = -1,
8156 ELM_POPUP_RESPONSE_TIMEOUT = -2,
8157 ELM_POPUP_RESPONSE_OK = -3,
8158 ELM_POPUP_RESPONSE_CANCEL = -4,
8159 ELM_POPUP_RESPONSE_CLOSE = -5
8160 } Elm_Popup_Response;
8162 typedef enum _Elm_Popup_Mode
8164 ELM_POPUP_TYPE_NONE = 0,
8165 ELM_POPUP_TYPE_ALERT = (1 << 0)
8168 typedef enum _Elm_Popup_Orient
8170 ELM_POPUP_ORIENT_TOP,
8171 ELM_POPUP_ORIENT_CENTER,
8172 ELM_POPUP_ORIENT_BOTTOM,
8173 ELM_POPUP_ORIENT_LEFT,
8174 ELM_POPUP_ORIENT_RIGHT,
8175 ELM_POPUP_ORIENT_TOP_LEFT,
8176 ELM_POPUP_ORIENT_TOP_RIGHT,
8177 ELM_POPUP_ORIENT_BOTTOM_LEFT,
8178 ELM_POPUP_ORIENT_BOTTOM_RIGHT
8181 /* smart callbacks called:
8182 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
8185 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
8186 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
8187 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
8188 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
8189 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
8190 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
8191 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
8192 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
8193 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
8194 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
8195 EAPI Evas_Object *elm_popup_with_buttons_add(Evas_Object *parent, const char *title, const char *desc_text,int no_of_buttons, const char *first_button_text, ... );
8196 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
8197 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
8198 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
8199 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
8200 EAPI int elm_popup_run(Evas_Object *obj);
8203 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8204 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8208 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
8209 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
8210 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
8211 ELM_NAVIGATIONBAR_BACK_BUTTON
8212 } Elm_Navi_Button_Type;
8214 EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
8215 EAPI void elm_navigationbar_push(Evas_Object *obj, const char *title, Evas_Object *fn_btn1, Evas_Object *fn_btn2, Evas_Object *fn_btn3, Evas_Object *content);
8216 EAPI void elm_navigationbar_pop(Evas_Object *obj);
8217 EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
8218 EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
8219 EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
8220 EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
8221 EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
8222 EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
8223 EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
8224 EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
8225 EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
8226 EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
8227 EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
8228 EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
8229 EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
8230 EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
8231 EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
8232 EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
8233 Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
8234 EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
8235 EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
8238 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8239 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8243 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
8244 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
8245 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
8246 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
8247 ELM_NAVIGATIONBAR_EX_MAX
8248 } Elm_Navi_ex_Button_Type;
8249 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
8251 EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
8252 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
8253 EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
8254 EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
8255 EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
8256 EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
8257 EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
8258 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
8259 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
8260 EAPI void elm_navigationbar_ex_item_title_button_set(Elm_Navigationbar_ex_Item* item, char *btn_label, Evas_Object *icon, int button_type, Evas_Smart_Cb func, const void *data);
8261 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
8262 EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
8263 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
8264 EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
8265 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
8266 EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
8267 EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
8268 EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
8269 EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
8270 EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
8271 EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
8272 EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
8273 EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
8274 EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
8275 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
8276 EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
8277 EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
8278 Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
8281 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
8282 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
8283 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
8284 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
8285 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
8286 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
8287 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
8288 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
8289 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
8290 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
8293 * @defgroup Naviframe Naviframe
8295 * @brief Naviframe is a kind of view manager for the applications.
8297 * Naviframe provides functions to switch different pages with stack
8298 * mechanism. It means if one page(item) needs to be changed to the new one,
8299 * then naviframe would push the new page to it's internal stack. Of course,
8300 * it can be back to the previous page by popping the top page. Naviframe
8301 * provides some transition effect while the pages are switching (same as
8304 * Since each item could keep the different styles, users could keep the
8305 * same look & feel for the pages or different styles for the items in it's
8308 * Signals that you can add callback for are:
8310 * @li "transition,finished" - When the transition is finished in changing
8312 * @li "title,clicked" - User clicked title area
8314 * Default contents parts for the naviframe items that you can use for are:
8316 * @li "elm.swallow.content" - The main content of the page
8317 * @li "elm.swallow.prev_btn" - The button to go to the previous page
8318 * @li "elm.swallow.next_btn" - The button to go to the next page
8320 * Default text parts of naviframe items that you can be used are:
8322 * @li "elm.text.title" - The title label in the title area
8324 * @ref tutorial_naviframe gives a good overview of the usage of the API.
8328 * @brief Add a new Naviframe object to the parent.
8330 * @param parent Parent object
8331 * @return New object or @c NULL, if it cannot be created
8333 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8335 * @brief Push a new item to the top of the naviframe stack (and show it).
8337 * @param obj The naviframe object
8338 * @param title_label The label in the title area. The name of the title
8339 * label part is "elm.text.title"
8340 * @param prev_btn The button to go to the previous item. If it is NULL,
8341 * then naviframe will create a back button automatically. The name of
8342 * the prev_btn part is "elm.swallow.prev_btn"
8343 * @param next_btn The button to go to the next item. Or It could be just an
8344 * extra function button. The name of the next_btn part is
8345 * "elm.swallow.next_btn"
8346 * @param content The main content object. The name of content part is
8347 * "elm.swallow.content"
8348 * @param item_style The current item style name. @c NULL would be default.
8349 * @return The created item or @c NULL upon failure.
8351 * The item pushed becomes one page of the naviframe, this item will be
8352 * deleted when it is popped.
8354 * @see also elm_naviframe_item_style_set()
8356 * The following styles are available for this item:
8359 EAPI Elm_Object_Item *elm_naviframe_item_push(Evas_Object *obj, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
8361 * @brief Pop an item that is on top of the stack
8363 * @param obj The naviframe object
8364 * @return @c NULL or the content object(if the
8365 * elm_naviframe_content_preserve_on_pop_get is true).
8367 * This pops an item that is on the top(visible) of the naviframe, makes it
8368 * disappear, then deletes the item. The item that was underneath it on the
8369 * stack will become visible.
8371 * @see also elm_naviframe_content_preserve_on_pop_get()
8373 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
8375 * @brief Pop the items between the top and the above one on the given item.
8377 * @param it The naviframe item
8379 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8381 * @brief Delete's the given item.
8383 * @param it The naviframe item
8385 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8387 * @brief preserve the content objects when items are popped.
8389 * @param obj The naviframe object
8390 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
8392 * @see also elm_naviframe_content_preserve_on_pop_get()
8394 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
8396 * @brief Get a value whether preserve mode is enabled or not.
8398 * @param obj The naviframe object
8399 * @return If @c EINA_TRUE, preserve mode is enabled
8401 * @see also elm_naviframe_content_preserve_on_pop_set()
8403 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8405 * @brief Get a top item on the naviframe stack
8407 * @param obj The naviframe object
8408 * @return The top item on the naviframe stack or @c NULL, if the stack is
8411 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8413 * @brief Get a bottom item on the naviframe stack
8415 * @param obj The naviframe object
8416 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
8419 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8421 * @brief Set an item style
8423 * @param obj The naviframe item
8424 * @param item_style The current item style name. @c NULL would be default
8426 * The following styles are available for this item:
8429 * @see also elm_naviframe_item_style_get()
8431 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
8433 * @brief Get an item style
8435 * @param obj The naviframe item
8436 * @return The current item style name
8438 * @see also elm_naviframe_item_style_set()
8440 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8442 * @brief Show/Hide the title area
8444 * @param it The naviframe item
8445 * @param visible If @c EINA_TRUE, title area will be visible, hidden
8448 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
8450 * @see also elm_naviframe_item_title_visible_get()
8452 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
8454 * @brief Get a value whether title area is visible or not.
8456 * @param it The naviframe item
8457 * @return If @c EINA_TRUE, title area is visible
8459 * @see also elm_naviframe_item_title_visible_set()
8461 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8464 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
8465 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
8466 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
8467 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
8468 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
8469 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
8470 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
8471 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
8472 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
8474 typedef enum _Elm_Controlbar_Mode_Type
8476 ELM_CONTROLBAR_MODE_DEFAULT = 0,
8477 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
8478 ELM_CONTROLBAR_MODE_TRANSPARENCY,
8479 ELM_CONTROLBAR_MODE_LARGE,
8480 ELM_CONTROLBAR_MODE_SMALL,
8481 ELM_CONTROLBAR_MODE_LEFT,
8482 ELM_CONTROLBAR_MODE_RIGHT
8483 } Elm_Controlbar_Mode_Type;
8485 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
8486 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
8487 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8488 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8489 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, Evas_Object *view);
8490 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, Evas_Object *view);
8491 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_append(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
8492 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
8493 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
8494 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
8495 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8496 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8497 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
8498 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
8499 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
8500 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
8501 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
8502 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
8503 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
8504 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
8505 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
8506 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
8507 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
8508 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
8509 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
8510 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
8511 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
8512 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
8513 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
8514 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
8515 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
8516 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
8517 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
8518 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
8519 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
8520 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
8521 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
8522 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
8523 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
8526 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
8527 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
8528 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
8529 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
8530 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
8531 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
8532 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
8533 EAPI void elm_searchbar_clear(Evas_Object *obj);
8534 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
8536 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
8537 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
8538 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
8539 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
8542 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
8543 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
8544 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
8545 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
8546 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
8551 ELM_TICKERNOTI_ORIENT_TOP = 0,
8552 ELM_TICKERNOTI_ORIENT_BOTTOM,
8553 ELM_TICKERNOTI_ORIENT_LAST
8554 } Elm_Tickernoti_Orient;
8556 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
8557 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
8558 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8559 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8560 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
8561 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8562 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
8565 ELM_TICKERNOTI_DEFAULT,
8566 ELM_TICKERNOTI_DETAILVIEW
8567 } Elm_Tickernoti_Mode;
8568 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8569 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
8570 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
8571 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8572 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8573 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8574 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8575 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
8576 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8577 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
8578 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8579 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8580 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8581 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8582 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8583 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
8584 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8585 /* ############################################################################### */
8587 * Parts which can be used with elm_object_text_part_set() and
8588 * elm_object_text_part_get():
8590 * @li NULL/"default" - Operates on tickernoti content-text
8592 * Parts which can be used with elm_object_content_part_set() and
8593 * elm_object_content_part_get():
8595 * @li "icon" - Operates on tickernoti's icon
8596 * @li "button" - Operates on tickernoti's button
8598 * smart callbacks called:
8599 * @li "clicked" - emitted when tickernoti is clicked, except at the
8600 * swallow/button region, if any.
8601 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
8602 * any hide animation, this signal is emitted after the animation.
8606 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
8608 struct _Colorpalette_Color
8610 unsigned int r, g, b;
8613 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
8614 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
8615 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
8616 /* smart callbacks called:
8617 * "clicked" - when image clicked
8621 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
8622 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
8623 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
8624 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
8625 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
8626 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
8627 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
8628 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
8629 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
8630 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
8631 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
8632 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
8633 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
8634 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
8635 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
8636 /* smart callbacks called:
8637 * "clicked" - when an editfield is clicked
8638 * "unfocused" - when an editfield is unfocused
8642 /* Sliding Drawer */
8643 typedef enum _Elm_SlidingDrawer_Pos
8645 ELM_SLIDINGDRAWER_BOTTOM,
8646 ELM_SLIDINGDRAWER_LEFT,
8647 ELM_SLIDINGDRAWER_RIGHT,
8648 ELM_SLIDINGDRAWER_TOP
8649 } Elm_SlidingDrawer_Pos;
8651 typedef struct _Elm_SlidingDrawer_Drag_Value
8654 } Elm_SlidingDrawer_Drag_Value;
8656 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
8657 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
8658 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
8659 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
8660 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
8661 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
8663 /* multibuttonentry */
8664 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
8665 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
8666 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
8667 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
8668 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
8669 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
8670 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
8671 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
8672 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
8673 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
8674 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
8675 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
8676 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
8677 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
8678 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
8679 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
8680 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
8681 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
8682 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
8683 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
8684 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
8685 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
8686 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
8687 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
8688 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
8689 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
8690 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
8691 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
8692 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
8693 /* smart callback called:
8694 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
8695 * "added" - This signal is emitted when a new multibuttonentry item is added.
8696 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
8697 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
8698 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
8699 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
8700 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
8701 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
8702 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
8703 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
8704 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
8705 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
8707 /* available styles:
8712 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
8713 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
8714 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
8715 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
8716 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
8717 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
8718 /* smart callback called:
8719 * "expanded" - This signal is emitted when a stackedicon is expanded.
8720 * "clicked" - This signal is emitted when a stackedicon is clicked.
8722 /* available styles:
8727 typedef struct _Dialogue_Item Dialogue_Item;
8729 typedef enum _Elm_Dialoguegourp_Item_Style
8731 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
8732 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
8733 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
8734 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
8735 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
8736 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
8737 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
8738 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
8739 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
8740 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
8741 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
8742 } Elm_Dialoguegroup_Item_Style;
8744 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
8745 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
8746 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
8747 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
8748 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
8749 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
8750 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
8751 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
8752 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
8753 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
8754 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
8755 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
8756 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
8757 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
8758 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
8759 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
8764 ELM_DAYSELECTOR_SUN,
8765 ELM_DAYSELECTOR_MON,
8766 ELM_DAYSELECTOR_TUE,
8767 ELM_DAYSELECTOR_WED,
8768 ELM_DAYSELECTOR_THU,
8769 ELM_DAYSELECTOR_FRI,
8771 } Elm_DaySelector_Day;
8773 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
8774 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
8775 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
8778 typedef struct _Imageslider_Item Elm_Imageslider_Item;
8779 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
8780 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8781 EAPI Elm_Imageslider_Item *elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
8782 EAPI Elm_Imageslider_Item *elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data) EINA_ARG_NONNULL(1);
8783 EAPI Elm_Imageslider_Item *elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
8784 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8785 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8786 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8787 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8788 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8789 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8790 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8791 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8792 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8793 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
8794 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);