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);
1397 * Get the sensitivity amount which is be multiplied by the length of
1400 * @return the thumb scroll sensitivity friction
1402 * @ingroup Scrolling
1404 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
1407 * Set the sensitivity amount which is be multiplied by the length of
1410 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
1411 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
1414 * @see elm_thumbscroll_sensitivity_friction_get()
1415 * @note parameter value will get bound to 0.1 - 1.0 interval, always
1417 * @ingroup Scrolling
1419 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
1422 * Set the sensitivity amount which is be multiplied by the length of
1423 * mouse dragging, for all Elementary application windows.
1425 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
1426 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
1429 * @see elm_thumbscroll_sensitivity_friction_get()
1430 * @note parameter value will get bound to 0.1 - 1.0 interval, always
1432 * @ingroup Scrolling
1434 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
1440 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1441 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1442 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1443 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1444 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1445 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1446 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1447 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1449 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1450 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);
1451 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);
1453 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1454 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1457 * Adjust size of an element for finger usage.
1459 * @param times_w How many fingers should fit horizontally
1460 * @param w Pointer to the width size to adjust
1461 * @param times_h How many fingers should fit vertically
1462 * @param h Pointer to the height size to adjust
1464 * This takes width and height sizes (in pixels) as input and a
1465 * size multiple (which is how many fingers you want to place
1466 * within the area, being "finger" the size set by
1467 * elm_finger_size_set()), and adjusts the size to be large enough
1468 * to accommodate the resulting size -- if it doesn't already
1469 * accommodate it. On return the @p w and @p h sizes pointed to by
1470 * these parameters will be modified, on those conditions.
1472 * @note This is kind of a low level Elementary call, most useful
1473 * on size evaluation times for widgets. An external user wouldn't
1474 * be calling, most of the time.
1478 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1480 EAPI double elm_longpress_timeout_get(void);
1481 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1484 * don't use it unless you are sure
1486 EAPI void elm_object_tree_dump(const Evas_Object *top);
1487 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1489 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
1490 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
1495 * @defgroup Theme Theme
1497 * Elementary uses Edje to theme its widgets, naturally. But for the most
1498 * part this is hidden behind a simpler interface that lets the user set
1499 * extensions and choose the style of widgets in a much easier way.
1501 * Instead of thinking in terms of paths to Edje files and their groups
1502 * each time you want to change the appearance of a widget, Elementary
1503 * works so you can add any theme file with extensions or replace the
1504 * main theme at one point in the application, and then just set the style
1505 * of widgets with elm_object_style_set() and related functions. Elementary
1506 * will then look in its list of themes for a matching group and apply it,
1507 * and when the theme changes midway through the application, all widgets
1508 * will be updated accordingly.
1510 * There are three concepts you need to know to understand how Elementary
1511 * theming works: default theme, extensions and overlays.
1513 * Default theme, obviously enough, is the one that provides the default
1514 * look of all widgets. End users can change the theme used by Elementary
1515 * by setting the @c ELM_THEME environment variable before running an
1516 * application, or globally for all programs using the @c elementary_config
1517 * utility. Applications can change the default theme using elm_theme_set(),
1518 * but this can go against the user wishes, so it's not an adviced practice.
1520 * Ideally, applications should find everything they need in the already
1521 * provided theme, but there may be occasions when that's not enough and
1522 * custom styles are required to correctly express the idea. For this
1523 * cases, Elementary has extensions.
1525 * Extensions allow the application developer to write styles of its own
1526 * to apply to some widgets. This requires knowledge of how each widget
1527 * is themed, as extensions will always replace the entire group used by
1528 * the widget, so important signals and parts need to be there for the
1529 * object to behave properly (see documentation of Edje for details).
1530 * Once the theme for the extension is done, the application needs to add
1531 * it to the list of themes Elementary will look into, using
1532 * elm_theme_extension_add(), and set the style of the desired widgets as
1533 * he would normally with elm_object_style_set().
1535 * Overlays, on the other hand, can replace the look of all widgets by
1536 * overriding the default style. Like extensions, it's up to the application
1537 * developer to write the theme for the widgets it wants, the difference
1538 * being that when looking for the theme, Elementary will check first the
1539 * list of overlays, then the set theme and lastly the list of extensions,
1540 * so with overlays it's possible to replace the default view and every
1541 * widget will be affected. This is very much alike to setting the whole
1542 * theme for the application and will probably clash with the end user
1543 * options, not to mention the risk of ending up with not matching styles
1544 * across the program. Unless there's a very special reason to use them,
1545 * overlays should be avoided for the resons exposed before.
1547 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1548 * keeps one default internally and every function that receives one of
1549 * these can be called with NULL to refer to this default (except for
1550 * elm_theme_free()). It's possible to create a new instance of a
1551 * ::Elm_Theme to set other theme for a specific widget (and all of its
1552 * children), but this is as discouraged, if not even more so, than using
1553 * overlays. Don't use this unless you really know what you are doing.
1555 * But to be less negative about things, you can look at the following
1557 * @li @ref theme_example_01 "Using extensions"
1558 * @li @ref theme_example_02 "Using overlays"
1563 * @typedef Elm_Theme
1565 * Opaque handler for the list of themes Elementary looks for when
1566 * rendering widgets.
1568 * Stay out of this unless you really know what you are doing. For most
1569 * cases, sticking to the default is all a developer needs.
1571 typedef struct _Elm_Theme Elm_Theme;
1574 * Create a new specific theme
1576 * This creates an empty specific theme that only uses the default theme. A
1577 * specific theme has its own private set of extensions and overlays too
1578 * (which are empty by default). Specific themes do not fall back to themes
1579 * of parent objects. They are not intended for this use. Use styles, overlays
1580 * and extensions when needed, but avoid specific themes unless there is no
1581 * other way (example: you want to have a preview of a new theme you are
1582 * selecting in a "theme selector" window. The preview is inside a scroller
1583 * and should display what the theme you selected will look like, but not
1584 * actually apply it yet. The child of the scroller will have a specific
1585 * theme set to show this preview before the user decides to apply it to all
1588 EAPI Elm_Theme *elm_theme_new(void);
1590 * Free a specific theme
1592 * @param th The theme to free
1594 * This frees a theme created with elm_theme_new().
1596 EAPI void elm_theme_free(Elm_Theme *th);
1598 * Copy the theme fom the source to the destination theme
1600 * @param th The source theme to copy from
1601 * @param thdst The destination theme to copy data to
1603 * This makes a one-time static copy of all the theme config, extensions
1604 * and overlays from @p th to @p thdst. If @p th references a theme, then
1605 * @p thdst is also set to reference it, with all the theme settings,
1606 * overlays and extensions that @p th had.
1608 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1610 * Tell the source theme to reference the ref theme
1612 * @param th The theme that will do the referencing
1613 * @param thref The theme that is the reference source
1615 * This clears @p th to be empty and then sets it to refer to @p thref
1616 * so @p th acts as an override to @p thref, but where its overrides
1617 * don't apply, it will fall through to @pthref for configuration.
1619 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1621 * Return the theme referred to
1623 * @param th The theme to get the reference from
1624 * @return The referenced theme handle
1626 * This gets the theme set as the reference theme by elm_theme_ref_set().
1627 * If no theme is set as a reference, NULL is returned.
1629 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1631 * Return the default theme
1633 * @return The default theme handle
1635 * This returns the internal default theme setup handle that all widgets
1636 * use implicitly unless a specific theme is set. This is also often use
1637 * as a shorthand of NULL.
1639 EAPI Elm_Theme *elm_theme_default_get(void);
1641 * Prepends a theme overlay to the list of overlays
1643 * @param th The theme to add to, or if NULL, the default theme
1644 * @param item The Edje file path to be used
1646 * Use this if your application needs to provide some custom overlay theme
1647 * (An Edje file that replaces some default styles of widgets) where adding
1648 * new styles, or changing system theme configuration is not possible. Do
1649 * NOT use this instead of a proper system theme configuration. Use proper
1650 * configuration files, profiles, environment variables etc. to set a theme
1651 * so that the theme can be altered by simple confiugration by a user. Using
1652 * this call to achieve that effect is abusing the API and will create lots
1655 * @see elm_theme_extension_add()
1657 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1659 * Delete a theme overlay from the list of overlays
1661 * @param th The theme to delete from, or if NULL, the default theme
1662 * @param item The name of the theme overlay
1664 * @see elm_theme_overlay_add()
1666 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1668 * Appends a theme extension to the list of extensions.
1670 * @param th The theme to add to, or if NULL, the default theme
1671 * @param item The Edje file path to be used
1673 * This is intended when an application needs more styles of widgets or new
1674 * widget themes that the default does not provide (or may not provide). The
1675 * application has "extended" usage by coming up with new custom style names
1676 * for widgets for specific uses, but as these are not "standard", they are
1677 * not guaranteed to be provided by a default theme. This means the
1678 * application is required to provide these extra elements itself in specific
1679 * Edje files. This call adds one of those Edje files to the theme search
1680 * path to be search after the default theme. The use of this call is
1681 * encouraged when default styles do not meet the needs of the application.
1682 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1684 * @see elm_object_style_set()
1686 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1688 * Deletes a theme extension from the list of extensions.
1690 * @param th The theme to delete from, or if NULL, the default theme
1691 * @param item The name of the theme extension
1693 * @see elm_theme_extension_add()
1695 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1697 * Set the theme search order for the given theme
1699 * @param th The theme to set the search order, or if NULL, the default theme
1700 * @param theme Theme search string
1702 * This sets the search string for the theme in path-notation from first
1703 * theme to search, to last, delimited by the : character. Example:
1705 * "shiny:/path/to/file.edj:default"
1707 * See the ELM_THEME environment variable for more information.
1709 * @see elm_theme_get()
1710 * @see elm_theme_list_get()
1712 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1714 * Return the theme search order
1716 * @param th The theme to get the search order, or if NULL, the default theme
1717 * @return The internal search order path
1719 * This function returns a colon separated string of theme elements as
1720 * returned by elm_theme_list_get().
1722 * @see elm_theme_set()
1723 * @see elm_theme_list_get()
1725 EAPI const char *elm_theme_get(Elm_Theme *th);
1727 * Return a list of theme elements to be used in a theme.
1729 * @param th Theme to get the list of theme elements from.
1730 * @return The internal list of theme elements
1732 * This returns the internal list of theme elements (will only be valid as
1733 * long as the theme is not modified by elm_theme_set() or theme is not
1734 * freed by elm_theme_free(). This is a list of strings which must not be
1735 * altered as they are also internal. If @p th is NULL, then the default
1736 * theme element list is returned.
1738 * A theme element can consist of a full or relative path to a .edj file,
1739 * or a name, without extension, for a theme to be searched in the known
1740 * theme paths for Elemementary.
1742 * @see elm_theme_set()
1743 * @see elm_theme_get()
1745 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1747 * Return the full patrh for a theme element
1749 * @param f The theme element name
1750 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1751 * @return The full path to the file found.
1753 * This returns a string you should free with free() on success, NULL on
1754 * failure. This will search for the given theme element, and if it is a
1755 * full or relative path element or a simple searchable name. The returned
1756 * path is the full path to the file, if searched, and the file exists, or it
1757 * is simply the full path given in the element or a resolved path if
1758 * relative to home. The @p in_search_path boolean pointed to is set to
1759 * EINA_TRUE if the file was a searchable file andis in the search path,
1760 * and EINA_FALSE otherwise.
1762 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1764 * Flush the current theme.
1766 * @param th Theme to flush
1768 * This flushes caches that let elementary know where to find theme elements
1769 * in the given theme. If @p th is NULL, then the default theme is flushed.
1770 * Call this function if source theme data has changed in such a way as to
1771 * make any caches Elementary kept invalid.
1773 EAPI void elm_theme_flush(Elm_Theme *th);
1775 * This flushes all themes (default and specific ones).
1777 * This will flush all themes in the current application context, by calling
1778 * elm_theme_flush() on each of them.
1780 EAPI void elm_theme_full_flush(void);
1782 * Set the theme for all elementary using applications on the current display
1784 * @param theme The name of the theme to use. Format same as the ELM_THEME
1785 * environment variable.
1787 EAPI void elm_theme_all_set(const char *theme);
1789 * Return a list of theme elements in the theme search path
1791 * @return A list of strings that are the theme element names.
1793 * This lists all available theme files in the standard Elementary search path
1794 * for theme elements, and returns them in alphabetical order as theme
1795 * element names in a list of strings. Free this with
1796 * elm_theme_name_available_list_free() when you are done with the list.
1798 EAPI Eina_List *elm_theme_name_available_list_new(void);
1800 * Free the list returned by elm_theme_name_available_list_new()
1802 * This frees the list of themes returned by
1803 * elm_theme_name_available_list_new(). Once freed the list should no longer
1804 * be used. a new list mys be created.
1806 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1808 * Set a specific theme to be used for this object and its children
1810 * @param obj The object to set the theme on
1811 * @param th The theme to set
1813 * This sets a specific theme that will be used for the given object and any
1814 * child objects it has. If @p th is NULL then the theme to be used is
1815 * cleared and the object will inherit its theme from its parent (which
1816 * ultimately will use the default theme if no specific themes are set).
1818 * Use special themes with great care as this will annoy users and make
1819 * configuration difficult. Avoid any custom themes at all if it can be
1822 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1824 * Get the specific theme to be used
1826 * @param obj The object to get the specific theme from
1827 * @return The specifc theme set.
1829 * This will return a specific theme set, or NULL if no specific theme is
1830 * set on that object. It will not return inherited themes from parents, only
1831 * the specific theme set for that specific object. See elm_object_theme_set()
1832 * for more information.
1834 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1840 typedef enum _Elm_Win_Type
1843 ELM_WIN_DIALOG_BASIC,
1850 ELM_WIN_DROPDOWN_MENU,
1853 ELM_WIN_NOTIFICATION,
1856 ELM_WIN_INLINED_IMAGE,
1859 typedef enum _Elm_Win_Keyboard_Mode
1861 ELM_WIN_KEYBOARD_UNKNOWN,
1862 ELM_WIN_KEYBOARD_OFF,
1863 ELM_WIN_KEYBOARD_ON,
1864 ELM_WIN_KEYBOARD_ALPHA,
1865 ELM_WIN_KEYBOARD_NUMERIC,
1866 ELM_WIN_KEYBOARD_PIN,
1867 ELM_WIN_KEYBOARD_PHONE_NUMBER,
1868 ELM_WIN_KEYBOARD_HEX,
1869 ELM_WIN_KEYBOARD_TERMINAL,
1870 ELM_WIN_KEYBOARD_PASSWORD,
1871 ELM_WIN_KEYBOARD_IP,
1872 ELM_WIN_KEYBOARD_HOST,
1873 ELM_WIN_KEYBOARD_FILE,
1874 ELM_WIN_KEYBOARD_URL,
1875 ELM_WIN_KEYBOARD_KEYPAD,
1876 ELM_WIN_KEYBOARD_J2ME
1877 } Elm_Win_Keyboard_Mode;
1879 typedef enum _Elm_Illume_Command
1881 ELM_ILLUME_COMMAND_FOCUS_BACK,
1882 ELM_ILLUME_COMMAND_FOCUS_FORWARD,
1883 ELM_ILLUME_COMMAND_FOCUS_HOME,
1884 ELM_ILLUME_COMMAND_CLOSE
1885 } Elm_Illume_Command;
1887 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1888 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1889 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1890 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1891 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1892 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1893 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1894 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1895 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1896 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
1897 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
1898 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1899 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
1900 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1901 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
1902 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1903 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
1904 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1905 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
1906 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1907 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
1908 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1909 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
1910 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1911 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
1912 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1913 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
1914 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1915 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1916 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1917 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1918 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
1919 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1920 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
1921 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1922 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
1923 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1924 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1925 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1926 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1927 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1928 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
1929 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1930 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
1931 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
1932 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1933 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1934 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1935 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1936 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1937 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
1938 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
1940 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1941 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1942 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1943 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1944 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1945 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1946 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1948 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1949 * (blank mouse, private mouse obj, defaultmouse)
1952 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
1953 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1954 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
1955 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1957 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
1959 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
1960 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1961 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1962 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1963 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1964 /* available styles:
1969 /* X specific calls - won't work on non-x engines (return 0) */
1970 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1971 /* smart callbacks called:
1972 * "delete,request" - the user requested to delete the window
1973 * "focus,in" - window got focus
1974 * "focus,out" - window lost focus
1975 * "moved" - window that holds the canvas was moved
1981 * @brief Background object, used for setting a solid color, image or Edje
1982 * group as background to a window or any container object.
1984 * The bg object is used for setting a solid background to a window or
1985 * packing into any container object. It works just like an image, but has
1986 * some properties useful to a background, like setting it to tiled,
1987 * centered, scaled or stretched.
1989 * Here is some sample code using it:
1990 * @li @ref bg_01_example_page
1991 * @li @ref bg_02_example_page
1992 * @li @ref bg_03_example_page
1996 typedef enum _Elm_Bg_Option
1998 ELM_BG_OPTION_CENTER, /**< center the background */
1999 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2000 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2001 ELM_BG_OPTION_TILE /**< tile background at its original size */
2005 * Add a new background to the parent
2007 * @param parent The parent object
2008 * @return The new object or NULL if it cannot be created
2012 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2015 * Set the file (image or edje) used for the background
2017 * @param obj The bg object
2018 * @param file The file path
2019 * @param group Optional key (group in Edje) within the file
2021 * This sets the image file used in the background object. The image (or edje)
2022 * will be stretched (retaining aspect if its an image file) to completely fill
2023 * the bg object. This may mean some parts are not visible.
2025 * @note Once the image of @p obj is set, a previously set one will be deleted,
2026 * even if @p file is NULL.
2030 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2033 * Get the file (image or edje) used for the background
2035 * @param obj The bg object
2036 * @param file The file path
2037 * @param group Optional key (group in Edje) within the file
2041 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2044 * Set the option used for the background image
2046 * @param obj The bg object
2047 * @param option The desired background option (TILE, SCALE)
2049 * This sets the option used for manipulating the display of the background
2050 * image. The image can be tiled or scaled.
2054 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2057 * Get the option used for the background image
2059 * @param obj The bg object
2060 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2064 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2066 * Set the option used for the background color
2068 * @param obj The bg object
2073 * This sets the color used for the background rectangle. Its range goes
2078 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2080 * Get the option used for the background color
2082 * @param obj The bg object
2089 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2092 * Set the overlay object used for the background object.
2094 * @param obj The bg object
2095 * @param overlay The overlay object
2097 * This provides a way for elm_bg to have an 'overlay' that will be on top
2098 * of the bg. Once the over object is set, a previously set one will be
2099 * deleted, even if you set the new one to NULL. If you want to keep that
2100 * old content object, use the elm_bg_overlay_unset() function.
2105 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2108 * Get the overlay object used for the background object.
2110 * @param obj The bg object
2111 * @return The content that is being used
2113 * Return the content object which is set for this widget
2117 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2120 * Get the overlay object used for the background object.
2122 * @param obj The bg object
2123 * @return The content that was being used
2125 * Unparent and return the overlay object which was set for this widget
2129 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2132 * Set the size of the pixmap representation of the image.
2134 * This option just makes sense if an image is going to be set in the bg.
2136 * @param obj The bg object
2137 * @param w The new width of the image pixmap representation.
2138 * @param h The new height of the image pixmap representation.
2140 * This function sets a new size for pixmap representation of the given bg
2141 * image. It allows the image to be loaded already in the specified size,
2142 * reducing the memory usage and load time when loading a big image with load
2143 * size set to a smaller size.
2145 * NOTE: this is just a hint, the real size of the pixmap may differ
2146 * depending on the type of image being loaded, being bigger than requested.
2150 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2151 /* smart callbacks called:
2155 typedef enum _Elm_Icon_Lookup_Order
2157 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2158 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2159 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
2160 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
2161 } Elm_Icon_Lookup_Order;
2163 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2164 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2165 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2166 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2167 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2168 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2169 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2170 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2171 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2172 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2173 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2174 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2175 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2176 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2177 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2178 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2179 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
2180 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2181 EAPI Eina_Bool elm_icon_anim_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2182 EAPI void elm_icon_anim_set(Evas_Object *obj, Eina_Bool anim) EINA_ARG_NONNULL(1);
2183 EAPI Eina_Bool elm_icon_anim_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2184 EAPI void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
2185 EAPI Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2187 /* smart callbacks called:
2188 * "clicked" - the user clicked the icon
2192 typedef enum _Elm_Image_Orient
2194 ELM_IMAGE_ORIENT_NONE,
2195 ELM_IMAGE_ROTATE_90_CW,
2196 ELM_IMAGE_ROTATE_180_CW,
2197 ELM_IMAGE_ROTATE_90_CCW,
2198 ELM_IMAGE_FLIP_HORIZONTAL,
2199 ELM_IMAGE_FLIP_VERTICAL,
2200 ELM_IMAGE_FLIP_TRANSPOSE,
2201 ELM_IMAGE_FLIP_TRANSVERSE
2203 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2204 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2205 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2206 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2207 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2208 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
2209 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2210 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2211 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2212 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2213 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2214 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2215 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2216 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2217 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
2218 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2219 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2220 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2221 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2222 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
2223 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2225 /* smart callbacks called:
2226 * "clicked" - the user clicked the image
2230 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
2232 typedef enum _Elm_GLView_Mode
2234 ELM_GLVIEW_ALPHA = 1,
2235 ELM_GLVIEW_DEPTH = 2,
2236 ELM_GLVIEW_STENCIL = 4
2240 * Defines a policy for the glview resizing.
2242 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
2244 typedef enum _Elm_GLView_Resize_Policy
2246 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
2247 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
2248 } Elm_GLView_Resize_Policy;
2250 typedef enum _Elm_GLView_Render_Policy
2252 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
2253 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
2254 } Elm_GLView_Render_Policy;
2257 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2258 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2259 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2260 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2261 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
2262 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
2263 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
2264 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2265 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2266 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2267 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2268 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2274 * A box arranges objects in a linear fashion, governed by a layout function
2275 * that defines the details of this arrangement.
2277 * By default, the box will use an internal function to set the layout to
2278 * a single row, either vertical or horizontal. This layout is affected
2279 * by a number of parameters, such as the homogeneous flag set by
2280 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
2281 * elm_box_align_set() and the hints set to each object in the box.
2283 * For this default layout, it's possible to change the orientation with
2284 * elm_box_horizontal_set(). The box will start in the vertical orientation,
2285 * placing its elements ordered from top to bottom. When horizontal is set,
2286 * the order will go from left to right. If the box is set to be
2287 * homogeneous, every object in it will be assigned the same space, that
2288 * of the largest object. Padding can be used to set some spacing between
2289 * the cell given to each object. The alignment of the box, set with
2290 * elm_box_align_set(), determines how the bounding box of all the elements
2291 * will be placed within the space given to the box widget itself.
2293 * The size hints of each object also affect how they are placed and sized
2294 * within the box. evas_object_size_hint_min_set() will give the minimum
2295 * size the object can have, and the box will use it as the basis for all
2296 * latter calculations. Elementary widgets set their own minimum size as
2297 * needed, so there's rarely any need to use it manually.
2299 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2300 * used to tell whether the object will be allocated the minimum size it
2301 * needs or if the space given to it should be expanded. It's important
2302 * to realize that expanding the size given to the object is not the same
2303 * thing as resizing the object. It could very well end being a small
2304 * widget floating in a much larger empty space. If not set, the weight
2305 * for objects will normally be 0.0 for both axis, meaning the widget will
2306 * not be expanded. To take as much space possible, set the weight to
2307 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2309 * Besides how much space each object is allocated, it's possible to control
2310 * how the widget will be placed within that space using
2311 * evas_object_size_hint_align_set(). By default, this value will be 0.5
2312 * for both axis, meaning the object will be centered, but any value from
2313 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2314 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2315 * is -1.0, means the object will be resized to fill the entire space it
2318 * In addition, customized functions to define the layout can be set, which
2319 * allow the application developer to organize the objects within the box
2320 * in any number of ways.
2322 * The special elm_box_layout_transition() function can be used
2323 * to switch from one layout to another, animating the motion of the
2324 * children of the box.
2326 * @note Objects should not be added to box objects using _add() calls.
2328 * Some examples on how to use boxes follow:
2329 * @li @ref box_example_01
2330 * @li @ref box_example_02
2335 * @typedef Elm_Box_Transition
2337 * Opaque handler containing the parameters to perform an animated
2338 * transition of the layout the box uses.
2340 * @see elm_box_transition_new()
2341 * @see elm_box_layout_set()
2342 * @see elm_box_layout_transition()
2344 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2347 * Add a new box to the parent
2349 * By default, the box will be in vertical mode and non-homogeneous.
2351 * @param parent The parent object
2352 * @return The new object or NULL if it cannot be created
2354 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2356 * Set the horizontal orientation
2358 * By default, box object arranges their contents vertically from top to
2360 * By calling this function with @p horizontal as EINA_TRUE, the box will
2361 * become horizontal, arranging contents from left to right.
2363 * @note This flag is ignored if a custom layout function is set.
2365 * @param obj The box object
2366 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2367 * EINA_FALSE = vertical)
2369 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2371 * Get the horizontal orientation
2373 * @param obj The box object
2374 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
2376 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2378 * Set the box to arrange its children homogeneously
2380 * If enabled, homogeneous layout makes all items the same size, according
2381 * to the size of the largest of its children.
2383 * @note This flag is ignored if a custom layout function is set.
2385 * @param obj The box object
2386 * @param homogeneous The homogeneous flag
2388 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2390 * Get whether the box is using homogeneous mode or not
2392 * @param obj The box object
2393 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2395 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2396 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2397 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2399 * Add an object to the beginning of the pack list
2401 * Pack @p subobj into the box @p obj, placing it first in the list of
2402 * children objects. The actual position the object will get on screen
2403 * depends on the layout used. If no custom layout is set, it will be at
2404 * the top or left, depending if the box is vertical or horizontal,
2407 * @param obj The box object
2408 * @param subobj The object to add to the box
2410 * @see elm_box_pack_end()
2411 * @see elm_box_pack_before()
2412 * @see elm_box_pack_after()
2413 * @see elm_box_unpack()
2414 * @see elm_box_unpack_all()
2415 * @see elm_box_clear()
2417 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2419 * Add an object at the end of the pack list
2421 * Pack @p subobj into the box @p obj, placing it last in the list of
2422 * children objects. The actual position the object will get on screen
2423 * depends on the layout used. If no custom layout is set, it will be at
2424 * the bottom or right, depending if the box is vertical or horizontal,
2427 * @param obj The box object
2428 * @param subobj The object to add to the box
2430 * @see elm_box_pack_start()
2431 * @see elm_box_pack_before()
2432 * @see elm_box_pack_after()
2433 * @see elm_box_unpack()
2434 * @see elm_box_unpack_all()
2435 * @see elm_box_clear()
2437 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2439 * Adds an object to the box before the indicated object
2441 * This will add the @p subobj to the box indicated before the object
2442 * indicated with @p before. If @p before is not already in the box, results
2443 * are undefined. Before means either to the left of the indicated object or
2444 * above it depending on orientation.
2446 * @param obj The box object
2447 * @param subobj The object to add to the box
2448 * @param before The object before which to add it
2450 * @see elm_box_pack_start()
2451 * @see elm_box_pack_end()
2452 * @see elm_box_pack_after()
2453 * @see elm_box_unpack()
2454 * @see elm_box_unpack_all()
2455 * @see elm_box_clear()
2457 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2459 * Adds an object to the box after the indicated object
2461 * This will add the @p subobj to the box indicated after the object
2462 * indicated with @p after. If @p after is not already in the box, results
2463 * are undefined. After means either to the right of the indicated object or
2464 * below it depending on orientation.
2466 * @param obj The box object
2467 * @param subobj The object to add to the box
2468 * @param after The object after which to add it
2470 * @see elm_box_pack_start()
2471 * @see elm_box_pack_end()
2472 * @see elm_box_pack_before()
2473 * @see elm_box_unpack()
2474 * @see elm_box_unpack_all()
2475 * @see elm_box_clear()
2477 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2479 * Clear the box of all children
2481 * Remove all the elements contained by the box, deleting the respective
2484 * @param obj The box object
2486 * @see elm_box_unpack()
2487 * @see elm_box_unpack_all()
2489 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2493 * Remove the object given by @p subobj from the box @p obj without
2496 * @param obj The box object
2498 * @see elm_box_unpack_all()
2499 * @see elm_box_clear()
2501 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2503 * Remove all items from the box, without deleting them
2505 * Clear the box from all children, but don't delete the respective objects.
2506 * If no other references of the box children exist, the objects will never
2507 * be deleted, and thus the application will leak the memory. Make sure
2508 * when using this function that you hold a reference to all the objects
2509 * in the box @p obj.
2511 * @param obj The box object
2513 * @see elm_box_clear()
2514 * @see elm_box_unpack()
2516 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2518 * Retrieve a list of the objects packed into the box
2520 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2521 * The order of the list corresponds to the packing order the box uses.
2523 * You must free this list with eina_list_free() once you are done with it.
2525 * @param obj The box object
2527 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2529 * Set the space (padding) between the box's elements.
2531 * Extra space in pixels that will be added between a box child and its
2532 * neighbors after its containing cell has been calculated. This padding
2533 * is set for all elements in the box, besides any possible padding that
2534 * individual elements may have through their size hints.
2536 * @param obj The box object
2537 * @param horizontal The horizontal space between elements
2538 * @param vertical The vertical space between elements
2540 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2542 * Get the space (padding) between the box's elements.
2544 * @param obj The box object
2545 * @param horizontal The horizontal space between elements
2546 * @param vertical The vertical space between elements
2548 * @see elm_box_padding_set()
2550 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2552 * Set the alignment of the whole bouding box of contents.
2554 * Sets how the bounding box containing all the elements of the box, after
2555 * their sizes and position has been calculated, will be aligned within
2556 * the space given for the whole box widget.
2558 * @param obj The box object
2559 * @param horizontal The horizontal alignment of elements
2560 * @param vertical The vertical alignment of elements
2562 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2564 * Get the alignment of the whole bouding box of contents.
2566 * @param obj The box object
2567 * @param horizontal The horizontal alignment of elements
2568 * @param vertical The vertical alignment of elements
2570 * @see elm_box_align_set()
2572 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2575 * Set the layout defining function to be used by the box
2577 * Whenever anything changes that requires the box in @p obj to recalculate
2578 * the size and position of its elements, the function @p cb will be called
2579 * to determine what the layout of the children will be.
2581 * Once a custom function is set, everything about the children layout
2582 * is defined by it. The flags set by elm_box_horizontal_set() and
2583 * elm_box_homogeneous_set() no longer have any meaning, and the values
2584 * given by elm_box_padding_set() and elm_box_align_set() are up to this
2585 * layout function to decide if they are used and how. These last two
2586 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2587 * passed to @p cb. The @c Evas_Object the function receives is not the
2588 * Elementary widget, but the internal Evas Box it uses, so none of the
2589 * functions described here can be used on it.
2591 * Any of the layout functions in @c Evas can be used here, as well as the
2592 * special elm_box_layout_transition().
2594 * The final @p data argument received by @p cb is the same @p data passed
2595 * here, and the @p free_data function will be called to free it
2596 * whenever the box is destroyed or another layout function is set.
2598 * Setting @p cb to NULL will revert back to the default layout function.
2600 * @param obj The box object
2601 * @param cb The callback function used for layout
2602 * @param data Data that will be passed to layout function
2603 * @param free_data Function called to free @p data
2605 * @see elm_box_layout_transition()
2607 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);
2609 * Special layout function that animates the transition from one layout to another
2611 * Normally, when switching the layout function for a box, this will be
2612 * reflected immediately on screen on the next render, but it's also
2613 * possible to do this through an animated transition.
2615 * This is done by creating an ::Elm_Box_Transition and setting the box
2616 * layout to this function.
2620 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2621 * evas_object_box_layout_vertical, // start
2622 * NULL, // data for initial layout
2623 * NULL, // free function for initial data
2624 * evas_object_box_layout_horizontal, // end
2625 * NULL, // data for final layout
2626 * NULL, // free function for final data
2627 * anim_end, // will be called when animation ends
2628 * NULL); // data for anim_end function\
2629 * elm_box_layout_set(box, elm_box_layout_transition, t,
2630 * elm_box_transition_free);
2633 * @note This function can only be used with elm_box_layout_set(). Calling
2634 * it directly will not have the expected results.
2636 * @see elm_box_transition_new
2637 * @see elm_box_transition_free
2638 * @see elm_box_layout_set
2640 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
2642 * Create a new ::Elm_Box_Transition to animate the switch of layouts
2644 * If you want to animate the change from one layout to another, you need
2645 * to set the layout function of the box to elm_box_layout_transition(),
2646 * passing as user data to it an instance of ::Elm_Box_Transition with the
2647 * necessary information to perform this animation. The free function to
2648 * set for the layout is elm_box_transition_free().
2650 * The parameters to create an ::Elm_Box_Transition sum up to how long
2651 * will it be, in seconds, a layout function to describe the initial point,
2652 * another for the final position of the children and one function to be
2653 * called when the whole animation ends. This last function is useful to
2654 * set the definitive layout for the box, usually the same as the end
2655 * layout for the animation, but could be used to start another transition.
2657 * @param start_layout The layout function that will be used to start the animation
2658 * @param start_layout_data The data to be passed the @p start_layout function
2659 * @param start_layout_free_data Function to free @p start_layout_data
2660 * @param end_layout The layout function that will be used to end the animation
2661 * @param end_layout_free_data The data to be passed the @p end_layout function
2662 * @param end_layout_free_data Function to free @p end_layout_data
2663 * @param transition_end_cb Callback function called when animation ends
2664 * @param transition_end_data Data to be passed to @p transition_end_cb
2665 * @return An instance of ::Elm_Box_Transition
2667 * @see elm_box_transition_new
2668 * @see elm_box_layout_transition
2670 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);
2672 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
2674 * This function is mostly useful as the @c free_data parameter in
2675 * elm_box_layout_set() when elm_box_layout_transition().
2677 * @param data The Elm_Box_Transition instance to be freed.
2679 * @see elm_box_transition_new
2680 * @see elm_box_layout_transition
2682 EAPI void elm_box_transition_free(void *data);
2689 * @defgroup Button Button
2691 * @image html widget/button/preview-00.png
2692 * @image html widget/button/preview-01.png
2693 * @image html widget/button/preview-02.png
2695 * This is a push-button. Press it and run some function. It can contain
2696 * a simple label and icon object and it also has an autorepeat feature.
2698 * This widgets emits the following signals:
2699 * @li "clicked": the user clicked the button (press/release).
2700 * @li "repeated": the user pressed the button without releasing it.
2701 * @li "pressed": button was pressed.
2702 * @li "unpressed": button was released after being pressed.
2703 * In all three cases, the @c event parameter of the callback will be
2706 * Also, defined in the default theme, the button has the following styles
2708 * @li default: a normal button.
2709 * @li anchor: Like default, but the button fades away when the mouse is not
2710 * over it, leaving only the text or icon.
2711 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
2712 * continuous look across its options.
2713 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
2715 * Follow through a complete example @ref button_example_01 "here".
2721 UIControlStateDefault,
2722 UIControlStateHighlighted,
2723 UIControlStateDisabled,
2724 UIControlStateFocused,
2725 UIControlStateReserved
2729 * Add a new button to the parent's canvas
2731 * @param parent The parent object
2732 * @return The new object or NULL if it cannot be created
2734 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2736 * Set the label used in the button
2738 * The passed @p label can be NULL to clean any existing text in it and
2739 * leave the button as an icon only object.
2741 * @param obj The button object
2742 * @param label The text will be written on the button
2743 * @deprecated use elm_object_text_set() instead.
2745 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2747 * Get the label set for the button
2749 * The string returned is an internal pointer and should not be freed or
2750 * altered. It will also become invalid when the button is destroyed.
2751 * The string returned, if not NULL, is a stringshare, so if you need to
2752 * keep it around even after the button is destroyed, you can use
2753 * eina_stringshare_ref().
2755 * @param obj The button object
2756 * @return The text set to the label, or NULL if nothing is set
2757 * @deprecated use elm_object_text_set() instead.
2759 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2761 * Set the label for each state of button
2763 * The passed @p label can be NULL to clean any existing text in it and
2764 * leave the button as an icon only object for the state.
2766 * @param obj The button object
2767 * @param label The text will be written on the button
2768 * @param state The state of button
2772 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
2774 * Get the label of button for each state
2776 * The string returned is an internal pointer and should not be freed or
2777 * altered. It will also become invalid when the button is destroyed.
2778 * The string returned, if not NULL, is a stringshare, so if you need to
2779 * keep it around even after the button is destroyed, you can use
2780 * eina_stringshare_ref().
2782 * @param obj The button object
2783 * @param state The state of button
2784 * @return The title of button for state
2788 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
2790 * Set the icon used for the button
2792 * Setting a new icon will delete any other that was previously set, making
2793 * any reference to them invalid. If you need to maintain the previous
2794 * object alive, unset it first with elm_button_icon_unset().
2796 * @param obj The button object
2797 * @param icon The icon object for the button
2799 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2801 * Get the icon used for the button
2803 * Return the icon object which is set for this widget. If the button is
2804 * destroyed or another icon is set, the returned object will be deleted
2805 * and any reference to it will be invalid.
2807 * @param obj The button object
2808 * @return The icon object that is being used
2810 * @see elm_button_icon_unset()
2812 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2814 * Remove the icon set without deleting it and return the object
2816 * This function drops the reference the button holds of the icon object
2817 * and returns this last object. It is used in case you want to remove any
2818 * icon, or set another one, without deleting the actual object. The button
2819 * will be left without an icon set.
2821 * @param obj The button object
2822 * @return The icon object that was being used
2824 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2826 * Turn on/off the autorepeat event generated when the button is kept pressed
2828 * When off, no autorepeat is performed and buttons emit a normal @c clicked
2829 * signal when they are clicked.
2831 * When on, keeping a button pressed will continuously emit a @c repeated
2832 * signal until the button is released. The time it takes until it starts
2833 * emitting the signal is given by
2834 * elm_button_autorepeat_initial_timeout_set(), and the time between each
2835 * new emission by elm_button_autorepeat_gap_timeout_set().
2837 * @param obj The button object
2838 * @param on A bool to turn on/off the event
2840 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
2842 * Get whether the autorepeat feature is enabled
2844 * @param obj The button object
2845 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
2847 * @see elm_button_autorepeat_set()
2849 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2851 * Set the initial timeout before the autorepeat event is generated
2853 * Sets the timeout, in seconds, since the button is pressed until the
2854 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
2855 * won't be any delay and the even will be fired the moment the button is
2858 * @param obj The button object
2859 * @param t Timeout in seconds
2861 * @see elm_button_autorepeat_set()
2862 * @see elm_button_autorepeat_gap_timeout_set()
2864 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2866 * Get the initial timeout before the autorepeat event is generated
2868 * @param obj The button object
2869 * @return Timeout in seconds
2871 * @see elm_button_autorepeat_initial_timeout_set()
2873 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2875 * Set the interval between each generated autorepeat event
2877 * After the first @c repeated event is fired, all subsequent ones will
2878 * follow after a delay of @p t seconds for each.
2880 * @param obj The button object
2881 * @param t Interval in seconds
2883 * @see elm_button_autorepeat_initial_timeout_set()
2885 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2887 * Get the interval between each generated autorepeat event
2889 * @param obj The button object
2890 * @return Interval in seconds
2892 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2898 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2899 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2900 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2901 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2902 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2903 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2904 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2905 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2906 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2907 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2908 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2909 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2910 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2911 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2912 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2913 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2914 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2915 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2916 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2917 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2918 /* available styles:
2922 * hoversel_vertical_entry
2924 /* smart callbacks called:
2925 * "file,chosen" - the user has selected a path, whose string pointer comes
2929 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2930 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2931 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2932 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2933 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2934 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2935 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2936 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2937 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2938 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2939 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2940 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2941 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2942 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2943 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2944 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2945 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2946 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2947 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2948 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2949 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2950 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2952 /* scroller policy */
2953 typedef enum _Elm_Scroller_Policy
2955 ELM_SCROLLER_POLICY_AUTO = 0,
2956 ELM_SCROLLER_POLICY_ON,
2957 ELM_SCROLLER_POLICY_OFF,
2958 ELM_SCROLLER_POLICY_LAST
2959 } Elm_Scroller_Policy;
2961 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2962 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
2963 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2964 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2965 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
2966 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
2967 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);
2968 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
2969 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
2970 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);
2971 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2972 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2973 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2974 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2975 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2976 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);
2977 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
2978 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
2979 EINA_DEPRECATED EAPI void elm_scroller_page_move_set(Evas_Object *obj, Eina_Bool set);
2980 /* smart callbacks called:
2981 * "edge,left" - the left edge of the content has been reached
2982 * "edge,right" - the right edge of the content has been reached
2983 * "edge,top" - the top edge of the content has been reached
2984 * "edge,bottom" - the bottom edge of the content has been reached
2985 * "scroll" - the content has been scrolled (moved)
2986 * "scroll,anim,start" - scrolling animation has started
2987 * "scroll,anim,stop" - scrolling animation has stopped
2988 * "scroll,drag,start" - dragging the contents around has started
2989 * "scroll,drag,stop" - dragging the contents around has stopped
2993 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2994 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 */
2995 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
2996 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
2997 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2998 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
2999 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3000 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
3001 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3002 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
3003 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);
3004 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
3005 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);
3006 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
3007 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
3008 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
3009 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3010 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
3011 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3012 /* available styles:
3016 /* smart callbacks called:
3020 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3021 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3022 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3023 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3024 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3025 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3026 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
3027 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
3028 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
3029 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3030 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
3031 /* smart callbacks called:
3032 * "changed" - Whenever the toggle value has been changed. Is not called
3033 * until the toggle is released by the cursor (assuming it has been triggered
3034 * by the cursor in the first place).
3038 * @page tutorial_frame Frame example
3039 * @dontinclude frame_example_01.c
3041 * In this example we are going to create 4 Frames with different styles and
3042 * add a rectangle of different color in each.
3044 * We start we the usual setup code:
3047 * And then create one rectangle:
3050 * To add it in our first frame, which since it doesn't have it's style
3051 * specifically set uses the default style:
3054 * And then create another rectangle:
3057 * To add it in our second frame, which uses the "pad_small" style, note that
3058 * even tough we are setting a text for this frame it won't be show, only the
3059 * default style shows the Frame's title:
3061 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
3062 * very similar, their only difference is the size of the empty area around
3063 * the content of the frame.
3065 * And then create yet another rectangle:
3068 * To add it in our third frame, which uses the "outdent_top" style, note
3069 * that even tough we are setting a text for this frame it won't be show,
3070 * only the default style shows the Frame's title:
3073 * And then create one last rectangle:
3076 * To add it in our fourth and final frame, which uses the "outdent_bottom"
3077 * style, note that even tough we are setting a text for this frame it won't
3078 * be show, only the default style shows the Frame's title:
3081 * And now we are left with just some more setup code:
3084 * Our example will look like this:
3085 * @image html screenshots/frame_example_01.png
3086 * @image latex screenshots/frame_example_01.eps
3088 * @example frame_example_01.c
3091 * @defgroup Frame Frame
3093 * @brief Frame is a widget that holds some content and has a title.
3095 * The default look is a frame with a title, but Frame supports multple
3103 * @li outdent_bottom
3105 * Of all this styles only default shows the title. Frame emits no signals.
3107 * For a detailed example see the @ref tutorial_frame.
3112 * @brief Add a new frame to the parent
3114 * @param parent The parent object
3115 * @return The new object or NULL if it cannot be created
3117 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3119 * @brief Set the frame label
3121 * @param obj The frame object
3122 * @param label The label of this frame object
3124 * @deprecated use elm_object_text_set() instead.
3126 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3128 * @brief Get the frame label
3130 * @param obj The frame object
3132 * @return The label of this frame objet or NULL if unable to get frame
3134 * @deprecated use elm_object_text_get() instead.
3136 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3138 * @brief Set the content of the frame widget
3140 * Once the content object is set, a previously set one will be deleted.
3141 * If you want to keep that old content object, use the
3142 * elm_frame_content_unset() function.
3144 * @param obj The frame object
3145 * @param content The content will be filled in this frame object
3147 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3149 * @brief Get the content of the frame widget
3151 * Return the content object which is set for this widget
3153 * @param obj The frame object
3154 * @return The content that is being used
3156 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3158 * @brief Unset the content of the frame widget
3160 * Unparent and return the content object which was set for this widget
3162 * @param obj The frame object
3163 * @return The content that was being used
3165 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3171 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3172 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3173 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3174 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3175 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3176 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3177 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3178 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3179 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3180 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
3181 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3182 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
3185 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
3186 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
3187 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
3188 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
3189 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
3190 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
3191 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
3193 struct _Elm_Gengrid_Item_Class
3195 const char *item_style;
3196 struct _Elm_Gengrid_Item_Class_Func
3198 GridItemLabelGetFunc label_get;
3199 GridItemIconGetFunc icon_get;
3200 GridItemStateGetFunc state_get;
3201 GridItemDelFunc del;
3205 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3206 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
3207 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3208 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
3209 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
3211 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
3212 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3213 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
3214 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3215 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
3216 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3217 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
3218 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3219 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3220 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3221 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3222 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
3223 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3224 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
3225 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3227 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3228 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3230 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3231 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3232 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3233 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3234 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3235 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3236 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
3237 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3238 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
3239 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
3240 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3241 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3242 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3243 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3244 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3245 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3246 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3248 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
3249 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);
3250 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3251 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3252 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3253 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3254 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3255 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3256 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3257 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3258 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3259 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3261 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3262 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3263 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3265 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);
3266 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);
3267 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);
3268 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);
3269 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);
3270 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);
3271 /* smart callbacks called:
3273 * selected - User has selected an item.
3274 * unselected - User has unselected an item.
3275 * clicked,double - User has double-clicked or pressed enter on an item.
3276 * realized - An evas object for an item was built.
3277 * unrealized - An evas object for an item was deleted.
3278 * changed - An item has been added, removed, resized or moved,
3279 * or gengrid has been resized or horizontal property has been changed.
3280 * scroll - the content has been scrolled (moved).
3281 * "scroll,drag,start" - dragging the contents around has started.
3282 * "scroll,drag,stop" - dragging the contents around has stopped.
3283 * drag - Gengrid is being dragged.
3284 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
3285 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
3286 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
3287 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
3288 * "drag,stop" - Gengrid is not being dragged.
3292 * @defgroup Clock Clock
3294 * This is a @b digital clock widget. In its default theme, it has a
3295 * vintage "flipping numbers clock" appearance, which will animate
3296 * sheets of individual algarisms individually as time goes by.
3298 * A newly created clock will fetch system's time (already
3299 * considering local time adjustments) to start with, and will tick
3300 * accondingly. It may or may not show seconds.
3302 * Clocks have an @b edition mode. When in it, the sheets will
3303 * display extra arrow indications on the top and bottom and the
3304 * user may click on them to raise or lower the time values. After
3305 * it's told to exit edition mode, it will keep ticking with that
3306 * new time set (it keeps the difference from local time).
3308 * Also, when under edition mode, user clicks on the cited arrows
3309 * which are @b held for some time will make the clock to flip the
3310 * sheet, thus editing the time, continuosly and automatically for
3311 * the user. The interval between sheet flips will keep growing in
3312 * time, so that it helps the user to reach a time which is distant
3315 * The time display is, by default, in military mode (24h), but an
3316 * am/pm indicator may be optionally shown, too, when it will
3319 * Smart callbacks one can register to:
3320 * - "changed" - the clock's user changed the time
3322 * Here is an example on its usage:
3323 * @li @ref clock_example
3332 * Identifiers for which clock digits should be editable, when a
3333 * clock widget is in edition mode. Values may be ORed together to
3334 * make a mask, naturally.
3336 * @see elm_clock_edit_set()
3337 * @see elm_clock_digit_edit_set()
3339 typedef enum _Elm_Clock_Digedit
3341 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
3342 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
3343 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
3344 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
3345 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
3346 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
3347 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
3348 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
3349 } Elm_Clock_Digedit;
3352 * Add a new clock widget to the given parent Elementary
3353 * (container) object
3355 * @param parent The parent object
3356 * @return a new clock widget handle or @c NULL, on errors
3358 * This function inserts a new clock widget on the canvas.
3362 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3365 * Set a clock widget's time, programmatically
3367 * @param obj The clock widget object
3368 * @param hrs The hours to set
3369 * @param min The minutes to set
3370 * @param sec The secondes to set
3372 * This function updates the time that is showed by the clock
3375 * Values @b must be set within the following ranges:
3376 * - 0 - 23, for hours
3377 * - 0 - 59, for minutes
3378 * - 0 - 59, for seconds,
3380 * even if the clock is not in "military" mode.
3382 * @warning The behavior for values set out of those ranges is @b
3387 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
3390 * Get a clock widget's time values
3392 * @param obj The clock object
3393 * @param[out] hrs Pointer to the variable to get the hours value
3394 * @param[out] min Pointer to the variable to get the minutes value
3395 * @param[out] sec Pointer to the variable to get the seconds value
3397 * This function gets the time set for @p obj, returning
3398 * it on the variables passed as the arguments to function
3400 * @note Use @c NULL pointers on the time values you're not
3401 * interested in: they'll be ignored by the function.
3405 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
3408 * Set whether a given clock widget is under <b>edition mode</b> or
3409 * under (default) displaying-only mode.
3411 * @param obj The clock object
3412 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
3413 * put it back to "displaying only" mode
3415 * This function makes a clock's time to be editable or not <b>by
3416 * user interaction</b>. When in edition mode, clocks @b stop
3417 * ticking, until one brings them back to canonical mode. The
3418 * elm_clock_digit_edit_set() function will influence which digits
3419 * of the clock will be editable. By default, all of them will be
3420 * (#ELM_CLOCK_NONE).
3422 * @note am/pm sheets, if being shown, will @b always be editable
3423 * under edition mode.
3425 * @see elm_clock_edit_get()
3429 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
3432 * Retrieve whether a given clock widget is under <b>edition
3433 * mode</b> or under (default) displaying-only mode.
3435 * @param obj The clock object
3436 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
3439 * This function retrieves whether the clock's time can be edited
3440 * or not by user interaction.
3442 * @see elm_clock_edit_set() for more details
3446 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3449 * Set what digits of the given clock widget should be editable
3450 * when in edition mode.
3452 * @param obj The clock object
3453 * @param digedit Bit mask indicating the digits to be editable
3454 * (values in #Elm_Clock_Digedit).
3456 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
3457 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
3460 * @see elm_clock_digit_edit_get()
3464 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
3467 * Retrieve what digits of the given clock widget should be
3468 * editable when in edition mode.
3470 * @param obj The clock object
3471 * @return Bit mask indicating the digits to be editable
3472 * (values in #Elm_Clock_Digedit).
3474 * @see elm_clock_digit_edit_set() for more details
3478 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3481 * Set if the given clock widget must show hours in military or
3484 * @param obj The clock object
3485 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
3488 * This function sets if the clock must show hours in military or
3489 * am/pm mode. In some countries like Brazil the military mode
3490 * (00-24h-format) is used, in opposition to the USA, where the
3491 * am/pm mode is more commonly used.
3493 * @see elm_clock_show_am_pm_get()
3497 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
3500 * Get if the given clock widget shows hours in military or am/pm
3503 * @param obj The clock object
3504 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
3507 * This function gets if the clock shows hours in military or am/pm
3510 * @see elm_clock_show_am_pm_set() for more details
3514 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3517 * Set if the given clock widget must show time with seconds or not
3519 * @param obj The clock object
3520 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
3522 * This function sets if the given clock must show or not elapsed
3523 * seconds. By default, they are @b not shown.
3525 * @see elm_clock_show_seconds_get()
3529 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
3532 * Get whether the given clock widget is showing time with seconds
3535 * @param obj The clock object
3536 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
3538 * This function gets whether @p obj is showing or not the elapsed
3541 * @see elm_clock_show_seconds_set()
3545 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3548 * Set the interval on time updates for an user mouse button hold
3549 * on clock widgets' time edition.
3551 * @param obj The clock object
3552 * @param interval The (first) interval value in seconds
3554 * This interval value is @b decreased while the user holds the
3555 * mouse pointer either incrementing or decrementing a given the
3556 * clock digit's value.
3558 * This helps the user to get to a given time distant from the
3559 * current one easier/faster, as it will start to flip quicker and
3560 * quicker on mouse button holds.
3562 * The calculation for the next flip interval value, starting from
3563 * the one set with this call, is the previous interval divided by
3564 * 1.05, so it decreases a little bit.
3566 * The default starting interval value for automatic flips is
3569 * @see elm_clock_interval_get()
3573 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
3576 * Get the interval on time updates for an user mouse button hold
3577 * on clock widgets' time edition.
3579 * @param obj The clock object
3580 * @return The (first) interval value, in seconds, set on it
3582 * @see elm_clock_interval_set() for more details
3586 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3593 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3594 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
3595 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
3596 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3597 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3598 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3599 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
3600 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
3601 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3602 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3603 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
3604 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
3605 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
3606 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3607 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);
3608 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
3609 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3610 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3611 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
3612 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
3613 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
3614 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3615 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3616 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
3617 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3618 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);
3619 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3621 * @def elm_layout_icon_set
3622 * Convienience macro to set the icon object in a layout that follows the
3623 * Elementary naming convention for its parts.
3627 #define elm_layout_icon_set(_ly, _obj) \
3630 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
3631 if ((_obj)) sig = "elm,state,icon,visible"; \
3632 else sig = "elm,state,icon,hidden"; \
3633 elm_object_signal_emit((_ly), sig, "elm"); \
3637 * @def elm_layout_icon_get
3638 * Convienience macro to get the icon object from a layout that follows the
3639 * Elementary naming convention for its parts.
3643 #define elm_layout_icon_get(_ly) \
3644 elm_layout_content_get((_ly), "elm.swallow.icon")
3647 * @def elm_layout_end_set
3648 * Convienience macro to set the end object in a layout that follows the
3649 * Elementary naming convention for its parts.
3653 #define elm_layout_end_set(_ly, _obj) \
3656 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
3657 if ((_obj)) sig = "elm,state,end,visible"; \
3658 else sig = "elm,state,end,hidden"; \
3659 elm_object_signal_emit((_ly), sig, "elm"); \
3663 * @def elm_layout_end_get
3664 * Convienience macro to get the end object in a layout that follows the
3665 * Elementary naming convention for its parts.
3669 #define elm_layout_end_get(_ly) \
3670 elm_layout_content_get((_ly), "elm.swallow.end")
3673 * @def elm_layout_label_set
3674 * Convienience macro to set the label in a layout that follows the
3675 * Elementary naming convention for its parts.
3678 * @deprecate use elm_object_text_* instead.
3680 #define elm_layout_label_set(_ly, _txt) \
3681 elm_layout_text_set((_ly), "elm.text", (_txt))
3684 * @def elm_layout_label_get
3685 * Convienience macro to get the label in a layout that follows the
3686 * Elementary naming convention for its parts.
3689 * @deprecate use elm_object_text_* instead.
3691 #define elm_layout_label_get(_ly) \
3692 elm_layout_text_get((_ly), "elm.text")
3694 /* smart callbacks called:
3698 typedef enum _Elm_Notify_Orient
3700 ELM_NOTIFY_ORIENT_TOP,
3701 ELM_NOTIFY_ORIENT_CENTER,
3702 ELM_NOTIFY_ORIENT_BOTTOM,
3703 ELM_NOTIFY_ORIENT_LEFT,
3704 ELM_NOTIFY_ORIENT_RIGHT,
3705 ELM_NOTIFY_ORIENT_TOP_LEFT,
3706 ELM_NOTIFY_ORIENT_TOP_RIGHT,
3707 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
3708 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
3709 ELM_NOTIFY_ORIENT_LAST
3710 } Elm_Notify_Orient;
3711 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3712 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3713 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3714 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3715 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3716 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3717 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
3718 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3719 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
3720 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3721 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
3722 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3723 /* smart callbacks called:
3724 * "timeout" - when timeout happens on notify and it's hidden
3725 * "block,clicked" - when it's hidden by a click outside of the notify's view
3729 typedef enum _Elm_Hover_Axis
3731 ELM_HOVER_AXIS_NONE,
3732 ELM_HOVER_AXIS_HORIZONTAL,
3733 ELM_HOVER_AXIS_VERTICAL,
3736 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3737 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
3738 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3739 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3740 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3741 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3742 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3743 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3744 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
3745 /* available styles:
3751 /* smart callbacks called:
3752 * "clicked" - the user clicked the empty space in the hover to dismiss
3753 * "smart,changed" - a content object placed under the "smart"
3754 * policy was replaced to a new slot direction.
3758 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
3759 struct _Elm_Entry_Anchor_Info
3763 Evas_Coord x, y, w, h;
3765 typedef enum _Elm_Icon_Type
3772 typedef enum _Elm_Input_Panel_Layout
3774 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default 4x4 layout */
3775 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
3776 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
3777 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
3778 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
3779 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
3780 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
3781 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
3782 ELM_INPUT_PANEL_LAYOUT_CUSTOM_1 = 100, /* Reserved for future use */
3783 ELM_INPUT_PANEL_LAYOUT_CUSTOM_2,
3784 ELM_INPUT_PANEL_LAYOUT_CUSTOM_3,
3785 ELM_INPUT_PANEL_LAYOUT_CUSTOM_4,
3786 ELM_INPUT_PANEL_LAYOUT_CUSTOM_5,
3787 ELM_INPUT_PANEL_LAYOUT_CUSTOM_6,
3788 ELM_INPUT_PANEL_LAYOUT_CUSTOM_7,
3789 ELM_INPUT_PANEL_LAYOUT_CUSTOM_8,
3790 ELM_INPUT_PANEL_LAYOUT_CUSTOM_9,
3791 ELM_INPUT_PANEL_LAYOUT_CUSTOM_10
3792 } Elm_Input_Panel_Layout;
3794 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
3796 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3797 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
3798 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3799 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
3800 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3801 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3802 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3803 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3804 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3805 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3806 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3807 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3808 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
3809 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3810 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
3811 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3812 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
3813 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3814 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
3815 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
3816 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
3817 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
3818 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3819 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3820 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3821 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3822 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
3823 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3824 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3825 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3826 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3827 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);
3828 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
3829 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3830 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
3831 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
3832 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
3833 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3834 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);
3835 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3836 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3837 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);
3838 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);
3839 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);
3840 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);
3841 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);
3842 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);
3843 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3844 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3845 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
3846 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
3847 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
3848 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
3849 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3850 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
3851 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3852 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
3853 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
3854 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
3855 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
3856 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
3857 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
3858 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
3859 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
3860 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
3861 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
3862 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
3863 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
3864 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
3866 /* pre-made filters for entries */
3867 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
3868 struct _Elm_Entry_Filter_Limit_Size
3873 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
3874 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
3875 struct _Elm_Entry_Filter_Accept_Set
3877 const char *accepted;
3878 const char *rejected;
3880 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
3881 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3882 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
3883 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
3884 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
3885 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
3886 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
3887 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
3888 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
3889 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
3891 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
3892 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
3893 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
3894 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3895 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
3897 /* smart callbacks called:
3898 * "changed" - the text content changed
3899 * "selection,start" - the user started selecting text
3900 * "selection,changed" - the user modified the selection size/location
3901 * "selection,cleared" - the user cleared the selection
3902 * "selection,paste" - the user requested a paste of text
3903 * "selection,copy" - the user copied the text
3904 * "selection,cut" - the user cut the text
3905 * "cursor,changed" - the cursor changed position
3906 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
3907 * "activated" - when the enter key is pressed (useful for single line)
3908 * "press" - when finger/mouse is pressed down
3909 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
3910 * "clicked,double" - when finger/mouse is double-pressed
3911 * "longpressed" - the entry has been longpressed
3912 * "focused" - the entry has received keyboard focus
3913 * "unfocused" - keyboard focus is gone
3916 /* composite widgets - these basically put together basic widgets above
3917 * in convenient packages that do more than basic stuff */
3921 * @defgroup Anchorview Anchorview
3923 * Anchorview is for displaying text that contains markup with anchors
3924 * like <c>\<a href=1234\>something\</\></c> in it.
3926 * Besides being styled differently, the anchorview widget provides the
3927 * necessary functionality so that clicking on these anchors brings up a
3928 * popup with user defined content such as "call", "add to contacts" or
3929 * "open web page". This popup is provided using the @ref Hover widget.
3931 * This widget is very similar to @ref Anchorblock, so refer to that
3932 * widget for an example. The only difference Anchorview has is that the
3933 * widget is already provided with scrolling functionality, so if the
3934 * text set to it is too large to fit in the given space, it will scroll,
3935 * whereas the @ref Anchorblock widget will keep growing to ensure all the
3936 * text can be displayed.
3938 * This widget emits the following signals:
3939 * @li "anchor,clicked": will be called when an anchor is clicked. The
3940 * @p event_info parameter on the callback will be a pointer of type
3941 * ::Elm_Entry_Anchorview_Info.
3943 * See @ref Anchorblock for an example on how to use both of them.
3952 * @typedef Elm_Entry_Anchorview_Info
3954 * The info sent in the callback for "anchor,clicked" signals emitted by
3955 * the Anchorview widget.
3957 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
3959 * @struct _Elm_Entry_Anchorview_Info
3961 * The info sent in the callback for "anchor,clicked" signals emitted by
3962 * the Anchorview widget.
3964 struct _Elm_Entry_Anchorview_Info
3966 const char *name; /**< Name of the anchor, as indicated in its href
3968 int button; /**< The mouse button used to click on it */
3969 Evas_Object *hover; /**< The hover object to use for the popup */
3971 Evas_Coord x, y, w, h;
3972 } anchor, /**< Geometry selection of text used as anchor */
3973 hover_parent; /**< Geometry of the object used as parent by the
3975 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
3976 for content on the left side of
3977 the hover. Before calling the
3978 callback, the widget will make the
3979 necessary calculations to check
3980 which sides are fit to be set with
3981 content, based on the position the
3982 hover is activated and its distance
3983 to the edges of its parent object
3985 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
3986 the right side of the hover.
3987 See @ref hover_left */
3988 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
3989 of the hover. See @ref hover_left */
3990 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
3991 below the hover. See @ref
3995 * Add a new Anchorview object
3997 * @param parent The parent object
3998 * @return The new object or NULL if it cannot be created
4000 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4002 * Set the text to show in the anchorview
4004 * Sets the text of the anchorview to @p text. This text can include markup
4005 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
4006 * text that will be specially styled and react to click events, ended with
4007 * either of \</a\> or \</\>. When clicked, the anchor will emit an
4008 * "anchor,clicked" signal that you can attach a callback to with
4009 * evas_object_smart_callback_add(). The name of the anchor given in the
4010 * event info struct will be the one set in the href attribute, in this
4013 * Other markup can be used to style the text in different ways, but it's
4014 * up to the style defined in the theme which tags do what.
4015 * @deprecated use elm_object_text_set() instead.
4017 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4019 * Get the markup text set for the anchorview
4021 * Retrieves the text set on the anchorview, with markup tags included.
4023 * @param obj The anchorview object
4024 * @return The markup text set or @c NULL if nothing was set or an error
4026 * @deprecated use elm_object_text_set() instead.
4028 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4030 * Set the parent of the hover popup
4032 * Sets the parent object to use by the hover created by the anchorview
4033 * when an anchor is clicked. See @ref Hover for more details on this.
4034 * If no parent is set, the same anchorview object will be used.
4036 * @param obj The anchorview object
4037 * @param parent The object to use as parent for the hover
4039 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4041 * Get the parent of the hover popup
4043 * Get the object used as parent for the hover created by the anchorview
4044 * widget. See @ref Hover for more details on this.
4046 * @param obj The anchorview object
4047 * @return The object used as parent for the hover, NULL if none is set.
4049 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4051 * Set the style that the hover should use
4053 * When creating the popup hover, anchorview will request that it's
4054 * themed according to @p style.
4056 * @param obj The anchorview object
4057 * @param style The style to use for the underlying hover
4059 * @see elm_object_style_set()
4061 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4063 * Get the style that the hover should use
4065 * Get the style the hover created by anchorview will use.
4067 * @param obj The anchorview object
4068 * @return The style to use by the hover. NULL means the default is used.
4070 * @see elm_object_style_set()
4072 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4074 * Ends the hover popup in the anchorview
4076 * When an anchor is clicked, the anchorview widget will create a hover
4077 * object to use as a popup with user provided content. This function
4078 * terminates this popup, returning the anchorview to its normal state.
4080 * @param obj The anchorview object
4082 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4084 * Set bouncing behaviour when the scrolled content reaches an edge
4086 * Tell the internal scroller object whether it should bounce or not
4087 * when it reaches the respective edges for each axis.
4089 * @param obj The anchorview object
4090 * @param h_bounce Whether to bounce or not in the horizontal axis
4091 * @param v_bounce Whether to bounce or not in the vertical axis
4093 * @see elm_scroller_bounce_set()
4095 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4097 * Get the set bouncing behaviour of the internal scroller
4099 * Get whether the internal scroller should bounce when the edge of each
4100 * axis is reached scrolling.
4102 * @param obj The anchorview object
4103 * @param h_bounce Pointer where to store the bounce state of the horizontal
4105 * @param v_bounce Pointer where to store the bounce state of the vertical
4108 * @see elm_scroller_bounce_get()
4110 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4112 * Appends a custom item provider to the given anchorview
4114 * Appends the given function to the list of items providers. This list is
4115 * called, one function at a time, with the given @p data pointer, the
4116 * anchorview object and, in the @p item parameter, the item name as
4117 * referenced in its href string. Following functions in the list will be
4118 * called in order until one of them returns something different to NULL,
4119 * which should be an Evas_Object which will be used in place of the item
4122 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4123 * href=item/name\>\</item\>
4125 * @param obj The anchorview object
4126 * @param func The function to add to the list of providers
4127 * @param data User data that will be passed to the callback function
4129 * @see elm_entry_item_provider_append()
4131 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);
4133 * Prepend a custom item provider to the given anchorview
4135 * Like elm_anchorview_item_provider_append(), but it adds the function
4136 * @p func to the beginning of the list, instead of the end.
4138 * @param obj The anchorview object
4139 * @param func The function to add to the list of providers
4140 * @param data User data that will be passed to the callback function
4142 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);
4144 * Remove a custom item provider from the list of the given anchorview
4146 * Removes the function and data pairing that matches @p func and @p data.
4147 * That is, unless the same function and same user data are given, the
4148 * function will not be removed from the list. This allows us to add the
4149 * same callback several times, with different @p data pointers and be
4150 * able to remove them later without conflicts.
4152 * @param obj The anchorview object
4153 * @param func The function to remove from the list
4154 * @param data The data matching the function to remove from the list
4156 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);
4163 * @defgroup Anchorblock Anchorblock
4165 * Anchorblock is for displaying text that contains markup with anchors
4166 * like <c>\<a href=1234\>something\</\></c> in it.
4168 * Besides being styled differently, the anchorblock widget provides the
4169 * necessary functionality so that clicking on these anchors brings up a
4170 * popup with user defined content such as "call", "add to contacts" or
4171 * "open web page". This popup is provided using the @ref Hover widget.
4173 * This widget emits the following signals:
4174 * @li "anchor,clicked": will be called when an anchor is clicked. The
4175 * @p event_info parameter on the callback will be a pointer of type
4176 * ::Elm_Entry_Anchorblock_Info.
4182 * Since examples are usually better than plain words, we might as well
4183 * try @ref tutorial_anchorblock_example "one".
4186 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
4187 * This exampel will show both Anchorblock and @ref Anchorview,
4188 * since both are very similar and it's easier to show them once and side
4189 * by side, so the difference is more clear.
4191 * We'll show the relevant snippets of the code here, but the full example
4192 * can be found here... sorry, @ref anchorblock_example_01.c "here".
4194 * As for the actual example, it's just a simple window with an anchorblock
4195 * and an anchorview, both containing the same text. After including
4196 * Elementary.h and declaring some functions we'll need, we jump to our
4197 * elm_main (see ELM_MAIN) and create our window.
4198 * @dontinclude anchorblock_example_01.c
4203 * With the needed variables declared, we'll create the window and a box to
4204 * hold our widgets, but we don't need to go through that here.
4206 * In order to make clear where the anchorblock ends and the anchorview
4207 * begins, they'll be each inside a @ref Frame. After creating the frame,
4208 * the anchorblock follows.
4209 * @skip elm_frame_add
4210 * @until elm_frame_content_set
4212 * Nothing out of the ordinary there. What's worth mentioning is the call
4213 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
4214 * when an anchor is clicked, the hover for the popup will cover the entire
4215 * window. This affects the area that will be obscured by the hover and
4216 * where clicking will dismiss it, as well as the calculations it does to
4217 * inform the best locations where to insert the popups content.
4218 * Other than that, the code is pretty standard. We also need to set our
4219 * callback for when an anchor is clicked, since it's our task to populate
4220 * the popup. There's no default for it.
4222 * The anchorview is no different, we only change a few things so it looks
4224 * @until elm_frame_content_set
4226 * Then we run, so stuff works and close our main function in the usual way.
4229 * Now, a little note. Normally you would use either one of anchorblock or
4230 * anchorview, set your one callback to clicks and do your stuff in there.
4231 * In this example, however, there are a few tricks to make it easier to
4232 * show both widgets in one go (and to save me some typing). So we have
4233 * two callbacks, one per widget, that will call a common function to do
4234 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
4235 * anchorview too, since both are equal, and passing a callback to use
4236 * for our buttons to end the hover, because each widget has a different
4238 * @until _anchorview_clicked_cb
4241 * The meat of our popup is in the following function. We check what kind
4242 * of menu we need to show, based on the name set to the anchor in the
4243 * markup text. If there's no type (something went wrong, no valid contact
4244 * in the address list) we are just putting a button that does nothing, but
4245 * it's perfectly reasonable to just end the hover and call it quits.
4247 * Our popup will consist of one main button in the middle of our hover,
4248 * and possibly a secondary button and a list of other options. We'll create
4249 * first our main button and check what kind of popup we need afterwards.
4252 * @until eina_stringshare_add
4255 * Each button has two callbacks, one is our hack to close the hover
4256 * properly based on which widget it belongs to, the other a simple
4257 * printf that will show the action with the anchors own data. This is
4258 * not how you would usually do it. Instead, the common case is to have
4259 * one callback for the button that will know which function to call to end
4260 * things, but since we are doing it this way it's worth noting that
4261 * smart callbacks will be called in reverse in respect to the order they
4262 * were added, and since our @c btn_end_cb will close the hover, and thus
4263 * delete our buttons, the other callback wouldn't be called if we had
4266 * After our telephone popup, there are a few others that are practically
4267 * the same, so they won't be shown here.
4269 * Once we are done with that, it's time to place our actions into our
4270 * hover. Main button goes in the middle without much questioning, and then
4271 * we see if we have a secondary button and a box of extra options.
4272 * Because I said so, secondary button goes on either side and box of
4273 * options either on top or below the main one, but to choose which
4274 * exactly, we use the hints our callback info has, which saves us from
4275 * having to do the math and see which side has more space available, with
4276 * a little special case where we delete our extra stuff if there's nowhere
4280 * @skip evas_object_smart
4281 * @until evas_object_del(box)
4285 * The example will look like this:
4286 * @image html screenshots/anchorblock_01.png
4287 * @image latex screenshots/anchorblock_01.eps
4289 * @example anchorblock_example_01.c
4292 * @addtogroup Anchorblock
4296 * @typedef Elm_Entry_Anchorblock_Info
4298 * The info sent in the callback for "anchor,clicked" signals emitted by
4299 * the Anchorblock widget.
4301 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
4303 * @struct _Elm_Entry_Anchorblock_Info
4305 * The info sent in the callback for "anchor,clicked" signals emitted by
4306 * the Anchorblock widget.
4308 struct _Elm_Entry_Anchorblock_Info
4310 const char *name; /**< Name of the anchor, as indicated in its href
4312 int button; /**< The mouse button used to click on it */
4313 Evas_Object *hover; /**< The hover object to use for the popup */
4315 Evas_Coord x, y, w, h;
4316 } anchor, /**< Geometry selection of text used as anchor */
4317 hover_parent; /**< Geometry of the object used as parent by the
4319 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4320 for content on the left side of
4321 the hover. Before calling the
4322 callback, the widget will make the
4323 necessary calculations to check
4324 which sides are fit to be set with
4325 content, based on the position the
4326 hover is activated and its distance
4327 to the edges of its parent object
4329 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4330 the right side of the hover.
4331 See @ref hover_left */
4332 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4333 of the hover. See @ref hover_left */
4334 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4335 below the hover. See @ref
4339 * Add a new Anchorblock object
4341 * @param parent The parent object
4342 * @return The new object or NULL if it cannot be created
4344 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4346 * Set the text to show in the anchorblock
4348 * Sets the text of the anchorblock to @p text. This text can include markup
4349 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
4350 * of text that will be specially styled and react to click events, ended
4351 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
4352 * "anchor,clicked" signal that you can attach a callback to with
4353 * evas_object_smart_callback_add(). The name of the anchor given in the
4354 * event info struct will be the one set in the href attribute, in this
4357 * Other markup can be used to style the text in different ways, but it's
4358 * up to the style defined in the theme which tags do what.
4359 * @deprecated use elm_object_text_set() instead.
4361 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4363 * Get the markup text set for the anchorblock
4365 * Retrieves the text set on the anchorblock, with markup tags included.
4367 * @param obj The anchorblock object
4368 * @return The markup text set or @c NULL if nothing was set or an error
4370 * @deprecated use elm_object_text_set() instead.
4372 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4374 * Set the parent of the hover popup
4376 * Sets the parent object to use by the hover created by the anchorblock
4377 * when an anchor is clicked. See @ref Hover for more details on this.
4379 * @param obj The anchorblock object
4380 * @param parent The object to use as parent for the hover
4382 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4384 * Get the parent of the hover popup
4386 * Get the object used as parent for the hover created by the anchorblock
4387 * widget. See @ref Hover for more details on this.
4388 * If no parent is set, the same anchorblock object will be used.
4390 * @param obj The anchorblock object
4391 * @return The object used as parent for the hover, NULL if none is set.
4393 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4395 * Set the style that the hover should use
4397 * When creating the popup hover, anchorblock will request that it's
4398 * themed according to @p style.
4400 * @param obj The anchorblock object
4401 * @param style The style to use for the underlying hover
4403 * @see elm_object_style_set()
4405 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4407 * Get the style that the hover should use
4409 * Get the style the hover created by anchorblock will use.
4411 * @param obj The anchorblock object
4412 * @return The style to use by the hover. NULL means the default is used.
4414 * @see elm_object_style_set()
4416 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4418 * Ends the hover popup in the anchorblock
4420 * When an anchor is clicked, the anchorblock widget will create a hover
4421 * object to use as a popup with user provided content. This function
4422 * terminates this popup, returning the anchorblock to its normal state.
4424 * @param obj The anchorblock object
4426 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4428 * Appends a custom item provider to the given anchorblock
4430 * Appends the given function to the list of items providers. This list is
4431 * called, one function at a time, with the given @p data pointer, the
4432 * anchorblock object and, in the @p item parameter, the item name as
4433 * referenced in its href string. Following functions in the list will be
4434 * called in order until one of them returns something different to NULL,
4435 * which should be an Evas_Object which will be used in place of the item
4438 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4439 * href=item/name\>\</item\>
4441 * @param obj The anchorblock object
4442 * @param func The function to add to the list of providers
4443 * @param data User data that will be passed to the callback function
4445 * @see elm_entry_item_provider_append()
4447 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);
4449 * Prepend a custom item provider to the given anchorblock
4451 * Like elm_anchorblock_item_provider_append(), but it adds the function
4452 * @p func to the beginning of the list, instead of the end.
4454 * @param obj The anchorblock object
4455 * @param func The function to add to the list of providers
4456 * @param data User data that will be passed to the callback function
4458 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);
4460 * Remove a custom item provider from the list of the given anchorblock
4462 * Removes the function and data pairing that matches @p func and @p data.
4463 * That is, unless the same function and same user data are given, the
4464 * function will not be removed from the list. This allows us to add the
4465 * same callback several times, with different @p data pointers and be
4466 * able to remove them later without conflicts.
4468 * @param obj The anchorblock object
4469 * @param func The function to remove from the list
4470 * @param data The data matching the function to remove from the list
4472 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);
4478 * @defgroup Bubble Bubble
4480 * @brief The Bubble is a widget to show text similarly to how speech is
4481 * represented in comics.
4483 * The bubble widget contains 5 important visual elements:
4484 * @li The frame is a rectangle with rounded rectangles and an "arrow".
4485 * @li The @p icon is an image to which the frame's arrow points to.
4486 * @li The @p label is a text which appears to the right of the icon if the
4487 * corner is "top_left" or "bottom_left" and is right aligned to the frame
4489 * @li The @p info is a text which appears to the right of the label. Info's
4490 * font is of a ligther color than label.
4491 * @li The @p content is an evas object that is shown inside the frame.
4493 * The position of the arrow, icon, label and info depends on which corner is
4494 * selected. The four available corners are:
4495 * @li "top_left" - Default
4498 * @li "bottom_right"
4500 * Signals that you can add callbacks for are:
4501 * @li "clicked" - This is called when a user has clicked the bubble.
4503 * For an example of using a buble see @ref bubble_01_example_page "this".
4508 * Add a new bubble to the parent
4510 * @param parent The parent object
4511 * @return The new object or NULL if it cannot be created
4513 * This function adds a text bubble to the given parent evas object.
4515 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4517 * Set the label of the bubble
4519 * @param obj The bubble object
4520 * @param label The string to set in the label
4522 * This function sets the title of the bubble. Where this appears depends on
4523 * the selected corner.
4524 * @deprecated use elm_object_text_set() instead.
4526 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4528 * Get the label of the bubble
4530 * @param obj The bubble object
4531 * @return The string of set in the label
4533 * This function gets the title of the bubble.
4534 * @deprecated use elm_object_text_set() instead.
4536 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4538 * Set the info of the bubble
4540 * @param obj The bubble object
4541 * @param info The given info about the bubble
4543 * This function sets the info of the bubble. Where this appears depends on
4544 * the selected corner.
4545 * @deprecated use elm_object_text_set() instead.
4547 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
4549 * Get the info of the bubble
4551 * @param obj The bubble object
4553 * @return The "info" string of the bubble
4555 * This function gets the info text.
4556 * @deprecated use elm_object_text_set() instead.
4558 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4560 * Set the content to be shown in the bubble
4562 * Once the content object is set, a previously set one will be deleted.
4563 * If you want to keep the old content object, use the
4564 * elm_bubble_content_unset() function.
4566 * @param obj The bubble object
4567 * @param content The given content of the bubble
4569 * This function sets the content shown on the middle of the bubble.
4571 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4573 * Get the content shown in the bubble
4575 * Return the content object which is set for this widget.
4577 * @param obj The bubble object
4578 * @return The content that is being used
4580 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4582 * Unset the content shown in the bubble
4584 * Unparent and return the content object which was set for this widget.
4586 * @param obj The bubble object
4587 * @return The content that was being used
4589 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4591 * Set the icon of the bubble
4593 * Once the icon object is set, a previously set one will be deleted.
4594 * If you want to keep the old content object, use the
4595 * elm_icon_content_unset() function.
4597 * @param obj The bubble object
4598 * @param icon The given icon for the bubble
4600 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4602 * Get the icon of the bubble
4604 * @param obj The bubble object
4605 * @return The icon for the bubble
4607 * This function gets the icon shown on the top left of bubble.
4609 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4611 * Unset the icon of the bubble
4613 * Unparent and return the icon object which was set for this widget.
4615 * @param obj The bubble object
4616 * @return The icon that was being used
4618 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4620 * Set the corner of the bubble
4622 * @param obj The bubble object.
4623 * @param corner The given corner for the bubble.
4625 * This function sets the corner of the bubble. The corner will be used to
4626 * determine where the arrow in the frame points to and where label, icon and
4629 * Possible values for corner are:
4630 * @li "top_left" - Default
4633 * @li "bottom_right"
4635 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
4637 * Get the corner of the bubble
4639 * @param obj The bubble object.
4640 * @return The given corner for the bubble.
4642 * This function gets the selected corner of the bubble.
4644 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4646 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
4647 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4654 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4655 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
4656 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4657 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
4658 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
4659 /* smart callbacks called:
4660 * "clicked" - the user clicked the icon
4661 * "drag,start" - Someone started dragging the image out of the object
4662 * "drag,end" - Dragged item was dropped (somewhere)
4666 /** @defgroup Elm_Gesture_Layer Gesture Layer */
4668 * @enum _Elm_Gesture_Types
4669 * Emum of supported gesture types.
4670 * @ingroup Elm_Gesture_Layer
4672 enum _Elm_Gesture_Types
4674 ELM_GESTURE_FIRST = 0,
4676 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
4677 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
4678 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
4680 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
4682 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
4683 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
4685 ELM_GESTURE_ZOOM, /**< Zoom */
4686 ELM_GESTURE_ROTATE, /**< Rotate */
4692 * @typedef Elm_Gesture_Types
4693 * Type for Emum of supported gesture types.
4694 * @ingroup Elm_Gesture_Layer
4696 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
4699 * @enum _Elm_Gesture_State
4700 * Emum of gesture states.
4701 * @ingroup Elm_Gesture_Layer
4703 enum _Elm_Gesture_State
4705 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
4706 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
4707 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
4708 ELM_GESTURE_STATE_END, /**< Gesture completed */
4709 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
4712 * @typedef Elm_Gesture_State
4714 * @ingroup Elm_Gesture_Layer
4716 typedef enum _Elm_Gesture_State Elm_Gesture_State;
4719 * @struct _Elm_Gesture_Taps_Info
4720 * Struct holds taps info for user
4721 * @ingroup Elm_Gesture_Layer
4723 struct _Elm_Gesture_Taps_Info
4725 Evas_Coord x, y; /**< Holds center point between fingers */
4726 unsigned int n; /**< Number of fingers tapped */
4727 unsigned int timestamp; /**< event timestamp */
4731 * @typedef Elm_Gesture_Taps_Info
4732 * holds taps info for user
4733 * @ingroup Elm_Gesture_Layer
4735 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
4738 * @struct _Elm_Gesture_Momentum_Info
4739 * Struct holds momentum info for user
4740 * x1 and y1 are not necessarily in sync
4741 * x1 holds x value of x direction starting point
4742 * and same holds for y1.
4743 * This is noticeable when doing V-shape movement
4744 * @ingroup Elm_Gesture_Layer
4746 struct _Elm_Gesture_Momentum_Info
4747 { /* Report line ends, timestamps, and momentum computed */
4748 Evas_Coord x1; /**< Final-swipe direction starting point on X */
4749 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
4750 Evas_Coord x2; /**< Final-swipe direction ending point on X */
4751 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
4753 unsigned int tx; /**< Timestamp of start of final x-swipe */
4754 unsigned int ty; /**< Timestamp of start of final y-swipe */
4756 Evas_Coord mx; /**< Momentum on X */
4757 Evas_Coord my; /**< Momentum on Y */
4761 * @typedef Elm_Gesture_Momentum_Info
4762 * holds momentum info for user
4763 * @ingroup Elm_Gesture_Layer
4765 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
4768 * @struct _Elm_Gesture_Line_Info
4769 * Struct holds line info for user
4770 * @ingroup Elm_Gesture_Layer
4772 struct _Elm_Gesture_Line_Info
4773 { /* Report line ends, timestamps, and momentum computed */
4774 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
4775 unsigned int n; /**< Number of fingers (lines) */
4776 /* FIXME should be radians, bot degrees */
4777 double angle; /**< Angle (direction) of lines */
4781 * @typedef _Elm_Gesture_Line_Info
4782 * Holds line info for user
4783 * @ingroup Elm_Gesture_Layer
4785 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
4788 * @struct _Elm_Gesture_Zoom_Info
4789 * Struct holds zoom info for user
4790 * @ingroup Elm_Gesture_Layer
4792 struct _Elm_Gesture_Zoom_Info
4794 Evas_Coord x, y; /**< Holds zoom center point reported to user */
4795 Evas_Coord radius; /**< Holds radius between fingers reported to user */
4796 float zoom; /**< Zoom value: 1.0 means no zoom */
4797 float momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
4801 * @typedef Elm_Gesture_Zoom_Info
4802 * Holds zoom info for user
4803 * @ingroup Elm_Gesture_Layer
4805 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
4808 * @struct _Elm_Gesture_Rotate_Info
4809 * Struct holds rotation info for user
4810 * @ingroup Elm_Gesture_Layer
4812 struct _Elm_Gesture_Rotate_Info
4814 Evas_Coord x, y; /**< Holds zoom center point reported to user */
4815 Evas_Coord radius; /**< Holds radius between fingers reported to user */
4816 double base_angle; /**< Holds start-angle */
4817 double angle; /**< Rotation value: 0.0 means no rotation */
4818 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
4822 * @typedef Elm_Gesture_Rotate_Info
4823 * Holds rotation info for user
4824 * @ingroup Elm_Gesture_Layer
4826 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
4829 * @typedef Elm_Gesture_Event_Cb
4830 * User callback used to stream gesture info from gesture layer
4831 * @param data user data
4832 * @param event_info gesture report info
4833 * Returns a flag field to be applied on the causing event.
4834 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
4835 * upon the event, in an irreversible way.
4837 * @ingroup Elm_Gesture_Layer
4839 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
4842 * Use function to set callbacks to be notified about
4843 * change of state of gesture.
4844 * When a user registers a callback with this function
4845 * this means this gesture has to be tested.
4847 * When ALL callbacks for a gesture are set to NULL
4848 * it means user isn't interested in gesture-state
4849 * and it will not be tested.
4851 * @param obj Pointer to gesture-layer.
4852 * @param idx The gesture you would like to track its state.
4853 * @param cb callback function pointer.
4854 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
4855 * @param data user info to be sent to callback (usually, Smart Data)
4857 * @ingroup Elm_Gesture_Layer
4859 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);
4862 * Call this function to get repeat-events settings.
4864 * @param obj Pointer to gesture-layer.
4866 * @return repeat events settings.
4867 * @see elm_gesture_layer_hold_events_set()
4868 * @ingroup Elm_Gesture_Layer
4870 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4873 * This function called in order to make gesture-layer repeat events.
4874 * Set this of you like to get the raw events only if gestures were not detected.
4875 * Clear this if you like gesture layer to fwd events as testing gestures.
4877 * @param obj Pointer to gesture-layer.
4878 * @param r Repeat: TRUE/FALSE
4880 * @ingroup Elm_Gesture_Layer
4882 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
4885 * This function sets step-value for zoom action.
4886 * Set step to any positive value.
4887 * Cancel step setting by setting to 0.0
4889 * @param obj Pointer to gesture-layer.
4890 * @param s new zoom step value.
4892 * @ingroup Elm_Gesture_Layer
4894 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4897 * This function sets step-value for rotate action.
4898 * Set step to any positive value.
4899 * Cancel step setting by setting to 0.0
4901 * @param obj Pointer to gesture-layer.
4902 * @param s new roatate step value.
4904 * @ingroup Elm_Gesture_Layer
4906 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4909 * This function called to attach gesture-layer to an Evas_Object.
4910 * @param obj Pointer to gesture-layer.
4911 * @param t Pointer to underlying object (AKA Target)
4913 * @return TRUE, FALSE on success, failure.
4915 * @ingroup Elm_Gesture_Layer
4917 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
4920 * Call this function to construct a new gesture-layer object.
4921 * This does not activate the gesture layer. You have to
4922 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
4924 * @param parent the parent object.
4926 * @return Pointer to new gesture-layer object.
4928 * @ingroup Elm_Gesture_Layer
4930 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4933 typedef enum _Elm_Thumb_Animation_Setting
4935 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
4936 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
4937 ELM_THUMB_ANIMATION_STOP,
4938 ELM_THUMB_ANIMATION_LAST
4939 } Elm_Thumb_Animation_Setting;
4941 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4942 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
4943 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
4944 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4945 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4946 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
4947 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4948 EAPI void *elm_thumb_ethumb_client_get(void);
4949 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
4950 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
4951 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4952 /* available styles:
4956 /* smart callbacks called:
4957 * "clicked" - This is called when a user has clicked the thumb without dragging around.
4958 * "clicked,double" - This is called when a user has double-clicked the thumb.
4959 * "press" - This is called when a user has pressed down the thumb.
4960 * "generate,start" - The thumbnail generation started.
4961 * "generate,stop" - The generation process stopped.
4962 * "generate,error" - The generation failed.
4963 * "load,error" - The thumbnail image loading failed.
4967 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4968 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4969 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4970 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4971 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4972 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4973 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4974 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4975 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4976 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4977 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
4978 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4979 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4980 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4981 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4982 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);
4983 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
4984 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4985 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
4986 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
4987 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);
4988 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);
4989 /* smart callbacks called:
4990 * "clicked" - the user clicked the hoversel button and popped up the sel
4991 * "selected" - an item in the hoversel list is selected
4992 * "dismissed" - the hover is dismissed
4996 typedef enum _Elm_Toolbar_Shrink_Mode
4998 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
4999 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
5000 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
5001 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
5002 } Elm_Toolbar_Shrink_Mode;
5004 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
5005 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
5007 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5008 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
5009 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5010 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5011 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5012 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5013 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5014 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);
5015 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);
5016 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);
5017 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);
5018 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5019 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5020 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5021 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5022 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5023 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
5024 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5025 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5026 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5027 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
5028 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5029 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
5030 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5031 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5032 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5033 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5034 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
5035 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5036 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5037 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5038 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5039 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
5040 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5041 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
5042 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5043 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5044 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5045 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5046 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5047 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5048 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5049 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
5050 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5051 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
5052 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5053 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);
5054 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5055 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5056 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5057 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5058 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5059 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5060 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
5061 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);
5062 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5063 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5064 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5065 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5066 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5067 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5068 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5069 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5070 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5071 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5072 /* smart callbacks called:
5073 * "clicked" - when the user clicks on a toolbar item and becomes selected
5075 /* available styles:
5077 * transparent (no background or shadow, just show the provided content)
5081 EAPI double elm_tooltip_delay_get(void);
5082 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
5083 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
5084 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
5085 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
5086 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);
5087 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5088 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5089 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5090 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
5091 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5092 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5093 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5094 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5095 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5096 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5099 EAPI int elm_cursor_engine_only_get(void);
5100 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
5103 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
5104 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5105 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5106 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5107 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
5108 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
5109 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5110 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5111 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);
5112 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
5113 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5114 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
5115 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5116 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5117 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5118 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5119 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5120 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5121 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
5122 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5123 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5124 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5125 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5126 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
5127 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5128 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5129 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5130 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5131 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5132 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5134 /* smart callbacks called:
5135 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
5139 typedef enum _Elm_List_Mode
5141 ELM_LIST_COMPRESS = 0,
5147 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
5148 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5149 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);
5150 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);
5151 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);
5152 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);
5153 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);
5154 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5155 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
5156 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5157 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5158 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5159 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5160 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5161 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5162 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5163 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5164 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5165 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5166 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5167 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
5168 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5169 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5170 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5171 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5172 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5173 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5174 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5175 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5176 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5177 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
5178 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5179 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
5180 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5181 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5182 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5183 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5184 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5185 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5186 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);
5187 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5188 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5189 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5190 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5191 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5192 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5193 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5194 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5195 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5196 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5197 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5198 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5199 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5200 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5201 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5202 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);
5203 /* smart callbacks called:
5204 * "clicked,double" - when the user double-clicked an item
5205 * "selected" - when the user selected an item
5206 * "unselected" - when the user selected an item
5207 * "longpressed" - an item in the hoversel list is long-pressed
5208 * "scroll,edge,top" - the list is scrolled until the top edge
5209 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
5210 * "scroll,edge,left" - the list is scrolled until the left edge
5211 * "scroll,edge,right" - the list is scrolled until the right edge
5215 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5216 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5217 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5218 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5219 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5220 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5221 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
5222 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5223 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5224 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5225 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5226 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5227 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5228 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
5229 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5230 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);
5231 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);
5232 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5233 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5234 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5235 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5236 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5237 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5238 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5239 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5240 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
5241 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5242 /* smart callbacks called:
5243 * "changed" - Whenever the slider value is changed by the user.
5244 * "slider,drag,start" - dragging the slider indicator around has started
5245 * "slider,drag,stop" - dragging the slider indicator around has stopped
5246 * "delay,changed" - A short time after the value is changed by the user.
5247 * This will be called only when the user stops dragging for a very short
5248 * period or when they release their finger/mouse, so it avoids possibly
5249 * expensive reactions to the value change.
5256 * @addtogroup Actionslider Actionslider
5258 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
5259 * properties. The indicator is the element the user drags to choose a label.
5260 * When the position is set with magnet, when released the indicator will be
5261 * moved to it if it's nearest the magnetized position.
5263 * @note By default all positions are set as enabled.
5265 * Signals that you can add callbacks for are:
5267 * "selected" - when user selects an enabled position (the label is passed
5270 * "pos_changed" - when the indicator reaches any of the positions("left",
5271 * "right" or "center").
5273 * See an example of actionslider usage @ref actionslider_example_page "here"
5277 typedef enum _Elm_Actionslider_Indicator_Pos
5279 ELM_ACTIONSLIDER_INDICATOR_NONE,
5280 ELM_ACTIONSLIDER_INDICATOR_LEFT,
5281 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
5282 ELM_ACTIONSLIDER_INDICATOR_CENTER
5283 } Elm_Actionslider_Indicator_Pos;
5285 typedef enum _Elm_Actionslider_Magnet_Pos
5287 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
5288 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
5289 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
5290 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
5291 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
5292 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
5293 } Elm_Actionslider_Magnet_Pos;
5295 typedef enum _Elm_Actionslider_Label_Pos
5297 ELM_ACTIONSLIDER_LABEL_LEFT,
5298 ELM_ACTIONSLIDER_LABEL_RIGHT,
5299 ELM_ACTIONSLIDER_LABEL_CENTER,
5300 ELM_ACTIONSLIDER_LABEL_BUTTON
5301 } Elm_Actionslider_Label_Pos;
5303 /* smart callbacks called:
5304 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
5308 * Add a new actionslider to the parent.
5310 * @param parent The parent object
5311 * @return The new actionslider object or NULL if it cannot be created
5313 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5316 * Set actionslider label.
5318 * @param[in] obj The actionslider object
5319 * @param[in] pos The position of the label.
5320 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
5321 * @param label The label which is going to be set.
5323 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
5325 * Get actionslider labels.
5327 * @param obj The actionslider object
5328 * @param left_label A char** to place the left_label of @p obj into.
5329 * @param center_label A char** to place the center_label of @p obj into.
5330 * @param right_label A char** to place the right_label of @p obj into.
5332 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);
5334 * Get actionslider selected label.
5336 * @param obj The actionslider object
5337 * @return The selected label
5339 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5341 * Set actionslider indicator position.
5343 * @param obj The actionslider object.
5344 * @param pos The position of the indicator.
5346 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
5348 * Get actionslider indicator position.
5350 * @param obj The actionslider object.
5351 * @return The position of the indicator.
5353 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5355 * Set actionslider magnet position. To make multiple positions magnets @c or
5356 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
5358 * @param obj The actionslider object.
5359 * @param pos Bit mask indicating the magnet positions.
5361 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5363 * Get actionslider magnet position.
5365 * @param obj The actionslider object.
5366 * @return The positions with magnet property.
5368 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5370 * Set actionslider enabled position. To set multiple positions as enabled @c or
5371 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
5373 * @note All the positions are enabled by default.
5375 * @param obj The actionslider object.
5376 * @param pos Bit mask indicating the enabled positions.
5378 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5380 * Get actionslider enabled position.
5382 * @param obj The actionslider object.
5383 * @return The enabled positions.
5385 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5387 * Set the label used on the indicator.
5389 * @param obj The actionslider object
5390 * @param label The label to be set on the indicator.
5391 * @deprecated use elm_object_text_set() instead.
5393 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5395 * Get the label used on the indicator object.
5397 * @param obj The actionslider object
5398 * @return The indicator label
5399 * @deprecated use elm_object_text_get() instead.
5401 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5404 * Hold actionslider object movement.
5406 * @param[in] obj The actionslider object
5407 * @param[in] flag Actionslider hold/release
5408 * (EINA_TURE = hold/EIN_FALSE = release)
5410 * @ingroup Actionslider
5412 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
5420 typedef enum _Elm_Genlist_Item_Flags
5422 ELM_GENLIST_ITEM_NONE = 0,
5423 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
5424 ELM_GENLIST_ITEM_GROUP = (1 << 1)
5425 } Elm_Genlist_Item_Flags;
5426 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
5427 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
5428 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
5429 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
5430 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
5431 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
5432 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
5433 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
5435 struct _Elm_Genlist_Item_Class
5437 const char *item_style;
5439 GenlistItemLabelGetFunc label_get;
5440 GenlistItemIconGetFunc icon_get;
5441 GenlistItemStateGetFunc state_get;
5442 GenlistItemDelFunc del;
5443 GenlistItemMovedFunc moved;
5445 const char *edit_item_style;
5446 const char *mode_item_style;
5448 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5449 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5450 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5451 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5452 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5453 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5454 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5455 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5456 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5457 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5458 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
5459 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5460 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
5461 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5462 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5463 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5464 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5465 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5466 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
5467 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5468 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5469 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5470 /* operations to add items */
5471 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);
5472 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);
5473 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);
5474 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);
5475 /* operations to retrieve existing items */
5476 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5477 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5478 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5479 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);
5480 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5481 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5482 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5483 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);
5484 /* available item styles:
5486 * default_style - The text part is a textblock
5488 * icon_top_text_bottom
5490 /* Genlist Item operation */
5491 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5492 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5493 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5494 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5495 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5496 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5497 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5498 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
5499 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5500 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5501 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5502 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5503 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
5504 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5505 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5506 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5507 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5508 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5509 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5510 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5511 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5512 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5513 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
5514 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5515 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5516 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5517 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
5518 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5519 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
5520 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);
5521 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5522 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5523 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5524 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5525 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5526 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5527 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5528 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5529 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5530 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5531 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
5532 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
5533 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5534 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5535 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5536 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5537 /* Signals that you can add callbacks for are:
5538 * "clicked,double" - This is called when a user has double-clicked an item.
5539 * The event_info parameter is the genlist item that was
5541 * "selected" - This is called when a user has made an item selected. The
5542 * event_info parameter is the genlist item that was selected.
5543 * "unselected" - This is called when a user has made an item unselected. The
5544 * event_info parameter is the genlist item that was unselected.
5545 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
5546 * and the item is now meant to be expanded. The event_info parameter is the
5547 * genlist item that was indicated to expand. It is the job of this callback
5548 * to then fill in the child items.
5549 * "contracted" - This is called when elm_genlist_item_expanded_set() is called
5550 * and the item is now meant to be contracted. The event_info parameter is
5551 * the genlist item that was indicated to contract. It is the job of this
5552 * callback to then delete the child items.
5553 * "expand,request" - This is called when a user has indicated they want to
5554 * expand a tree branch item. The callback should decide if the item can
5555 * expand (has any children) and then call elm_genlist_item_expanded_set()
5556 * appropriately to set the state. The event_info parameter is the genlist
5557 * item that was indicated to expand.
5558 * "contract,request" - This is called when a user has indicated they want to
5559 * contract a tree branch item. The callback should decide if the item can
5560 * contract (has any children) and then call elm_genlist_item_expanded_set()
5561 * appropriately to set the state. The event_info parameter is the genlist
5562 * item that was indicated to contract.
5563 * "realized" - This is called when the item in the list is created as a real
5564 * evas object. event_info parameter is the genlist item that was created.
5565 * The object may be deleted at any time, so it is up to the caller to
5566 * not use the object pointer from elm_genlist_item_object_get() in a way
5567 * where it may point to freed objects.
5568 * "unrealized" - This is called just before an item is unrealized. After
5569 * this call icon objects provided will be deleted and the item object
5570 * itself delete or be put into a floating cache.
5571 * "drag,start,up" - This is called when the item in the list has been dragged
5572 * (not scrolled) up.
5573 * "drag,start,down" - This is called when the item in the list has been dragged
5574 * (not scrolled) down.
5575 * "drag,start,left" - This is called when the item in the list has been dragged i
5576 * (not scrolled) left.
5577 * "drag,start,right" - This is called when the item in the list has been dragged
5578 * (not scrolled) right.
5579 * "drag,stop" - This is called when the item in the list has stopped being
5581 * "drag" - This is called when the item in the list is being dragged.
5582 * "longpressed" - This is called when the item is pressed for a certain amount
5583 * of time. By default it's 1 second.
5584 * "scroll,edge,top" - This is called when the genlist is scrolled until the
5586 * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
5588 * "scroll,edge,left" - This is called when the genlist is scrolled until the
5590 * "scroll,edge,right" - This is called when the genlist is scrolled until the
5592 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
5594 * "multi,swipe,right" - This is called when the genlist is multi-touch swiped
5596 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
5597 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
5599 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
5601 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
5604 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
5605 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5606 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
5607 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5608 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
5609 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
5610 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5611 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5612 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5613 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5616 * @page tutorial_check Check example
5617 * @dontinclude check_example_01.c
5619 * This example will show 2 checkboxes, one with just a label and the second
5620 * one with both a label and an icon. This example also ilustrates how to
5621 * have the checkbox change the value of a variable and how to react to those
5624 * We will start with the usual setup code:
5627 * And now we create our first checkbox, set its label, tell it to change
5628 * the value of @p value when the checkbox stats is changed and ask to be
5629 * notified of state changes:
5632 * For our second checkbox we are going to set an icon so we need to create
5635 * @note For simplicity we are using a rectangle as icon, but any evas object
5638 * And for our second checkbox we set the label, icon and state to true:
5641 * We now do some more setup:
5644 * And finally implement the callback that will be called when the first
5645 * checkbox's state changes. This callback will use @p data to print a
5648 * @note This work because @p data is @p value(from the main function) and @p
5649 * value is changed when the checkbox is changed.
5651 * Our example will look like this:
5652 * @image html screenshots/check_example_01.png
5653 * @image latex screenshots/check_example_01.eps
5655 * @example check_example_01.c
5658 * @defgroup Check Check
5660 * @brief The check widget allows for toggling a value between true and
5663 * Check objects are a lot like radio objects in layout and functionality
5664 * except they do not work as a group, but independently and only toggle the
5665 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
5666 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
5667 * returns the current state. For convenience, like the radio objects, you
5668 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
5671 * Signals that you can add callbacks for are:
5672 * "changed" - This is called whenever the user changes the state of one of
5673 * the check object(event_info is NULL).
5675 * @ref tutorial_check should give you a firm grasp of how to use this widget.
5679 * @brief Add a new Check object
5681 * @param parent The parent object
5682 * @return The new object or NULL if it cannot be created
5684 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5686 * @brief Set the text label of the check object
5688 * @param obj The check object
5689 * @param label The text label string in UTF-8
5691 * @deprecated use elm_object_text_set() instead.
5693 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5695 * @brief Get the text label of the check object
5697 * @param obj The check object
5698 * @return The text label string in UTF-8
5700 * @deprecated use elm_object_text_get() instead.
5702 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5704 * @brief Set the icon object of the check object
5706 * @param obj The check object
5707 * @param icon The icon object
5709 * Once the icon object is set, a previously set one will be deleted.
5710 * If you want to keep that old content object, use the
5711 * elm_check_icon_unset() function.
5713 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5715 * @brief Get the icon object of the check object
5717 * @param obj The check object
5718 * @return The icon object
5720 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5722 * @brief Unset the icon used for the check object
5724 * @param obj The check object
5725 * @return The icon object that was being used
5727 * Unparent and return the icon object which was set for this widget.
5729 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5731 * @brief Set the on/off state of the check object
5733 * @param obj The check object
5734 * @param state The state to use (1 == on, 0 == off)
5736 * This sets the state of the check. If set
5737 * with elm_check_state_pointer_set() the state of that variable is also
5738 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
5740 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5742 * @brief Get the state of the check object
5744 * @param obj The check object
5745 * @return The boolean state
5747 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5749 * @brief Set a convenience pointer to a boolean to change
5751 * @param obj The check object
5752 * @param statep Pointer to the boolean to modify
5754 * This sets a pointer to a boolean, that, in addition to the check objects
5755 * state will also be modified directly. To stop setting the object pointed
5756 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
5757 * then when this is called, the check objects state will also be modified to
5758 * reflect the value of the boolean @p statep points to, just like calling
5759 * elm_check_state_set().
5761 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5767 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5768 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5769 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5770 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5771 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5772 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5773 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
5774 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5775 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5776 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5777 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5778 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
5779 /* smart callbacks called:
5780 * "changed" - when the radio status is changed
5784 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5785 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5786 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
5787 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5788 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5789 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5790 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
5791 EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
5793 /* available item styles:
5799 /* smart callbacks called:
5800 * "hide,finished" - when the previous page is hided
5803 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
5804 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
5805 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
5806 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
5807 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
5809 struct _Elm_Slideshow_Item_Class
5811 struct _Elm_Slideshow_Item_Class_Func
5813 SlideshowItemGetFunc get;
5814 SlideshowItemDelFunc del;
5818 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5819 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
5820 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);
5821 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5822 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
5823 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
5824 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5825 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
5826 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5827 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5828 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5829 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
5830 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5831 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5832 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5833 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5834 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5835 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5836 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
5837 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
5838 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5839 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
5840 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5841 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5842 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5843 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5844 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5845 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5846 /* smart callbacks called:
5847 * "changed" - when the slideshow switch to another item
5851 typedef enum _Elm_Fileselector_Mode
5853 ELM_FILESELECTOR_LIST = 0,
5854 ELM_FILESELECTOR_GRID,
5855 ELM_FILESELECTOR_LAST
5856 } Elm_Fileselector_Mode;
5858 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5859 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
5860 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5861 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
5862 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5863 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
5864 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5865 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5866 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
5867 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5868 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5869 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5870 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5871 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
5872 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5873 /* smart callbacks called:
5874 * "selected" - the user click on a file
5875 * "directory,open" - the list is populate with a new content. event_info is a directory.
5876 * "done" - the user click on the ok or cancel buttons
5880 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5881 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
5882 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5883 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5884 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5885 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5886 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5887 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5888 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5889 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5890 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5891 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5892 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5893 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5894 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5895 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5896 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5897 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5898 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5899 /* smart callbacks called:
5901 /* available item styles:
5903 * wheel (simple style, no text, no progression, only pulse is available)
5907 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5908 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5909 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5910 /* smart callbacks called:
5914 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5915 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
5916 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5917 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5918 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5919 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
5920 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5921 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5922 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5923 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
5924 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5925 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
5926 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5927 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
5928 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
5929 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5930 /* smart callbacks called:
5931 * "changed" - when the spinner value changes
5932 * "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).
5934 /* available item styles:
5936 * vertical (two up/down buttons at the right side and text left aligned)
5940 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
5942 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5943 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
5944 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5945 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5946 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5947 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5948 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
5949 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
5950 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
5951 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
5952 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);
5953 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
5954 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
5955 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5956 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5957 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
5958 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
5959 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5960 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
5961 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
5962 /* smart callbacks called:
5963 * "changed" - when the selected index item changes
5964 * "delay,changed" - when the selected index item changes, but after some small idle period
5965 * "selected" - when the user releases a finger and selects an item
5966 * "level,up" - when the user moves a finger from the first level to the second level
5967 * "level,down" - when the user moves a finger from the second level to the first level
5971 typedef enum _Elm_Photocam_Zoom_Mode
5973 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
5974 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
5975 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
5976 ELM_PHOTOCAM_ZOOM_MODE_LAST
5977 } Elm_Photocam_Zoom_Mode;
5979 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5980 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
5981 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5982 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
5983 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5984 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
5985 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5986 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5987 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5988 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5989 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5990 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
5991 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5992 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5993 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5994 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5995 /* smart callbacks called:
5996 * "clicked" - when image clicked
5997 * "press" - when mouse/finger held down initially on image
5998 * "longpressed" - when mouse/finger held for long time on image
5999 * "clicked,double" - when mouse/finger double-clicked
6000 * "load" - when photo load begins
6001 * "loaded" - when photo load done
6002 * "load,detail" - when detailed image load begins
6003 * "loaded,detail" - when detailed image load done
6004 * "zoom,start" - when zooming started
6005 * "zoom,stop" - when zooming stopped
6006 * "zoom,change" - when auto zoom mode changed zoom level
6007 * "scroll - the content has been scrolled (moved)
6008 * "scroll,anim,start" - scrolling animation has started
6009 * "scroll,anim,stop" - scrolling animation has stopped
6010 * "scroll,drag,start" - dragging the contents around has started
6011 * "scroll,drag,stop" - dragging the contents around has stopped
6015 typedef enum _Elm_Map_Zoom_Mode
6017 ELM_MAP_ZOOM_MODE_MANUAL,
6018 ELM_MAP_ZOOM_MODE_AUTO_FIT,
6019 ELM_MAP_ZOOM_MODE_AUTO_FILL,
6020 ELM_MAP_ZOOM_MODE_LAST
6021 } Elm_Map_Zoom_Mode;
6023 typedef enum _Elm_Map_Route_Sources
6025 ELM_MAP_ROUTE_SOURCE_YOURS,
6026 ELM_MAP_ROUTE_SOURCE_MONAV,
6027 ELM_MAP_ROUTE_SOURCE_ORS,
6028 ELM_MAP_ROUTE_SOURCE_LAST
6029 } Elm_Map_Route_Sources;
6031 typedef enum _Elm_Map_Name_Sources
6033 ELM_MAP_NAME_SOURCE_NOMINATIM,
6034 ELM_MAP_NAME_SOURCE_LAST
6035 } Elm_Map_Name_Sources;
6037 typedef enum _Elm_Map_Route_Type
6039 ELM_MAP_ROUTE_TYPE_MOTOCAR,
6040 ELM_MAP_ROUTE_TYPE_BICYCLE,
6041 ELM_MAP_ROUTE_TYPE_FOOT,
6042 ELM_MAP_ROUTE_TYPE_LAST
6043 } Elm_Map_Route_Type;
6045 typedef enum _Elm_Map_Route_Method
6047 ELM_MAP_ROUTE_METHOD_FASTEST,
6048 ELM_MAP_ROUTE_METHOD_SHORTEST,
6049 ELM_MAP_ROUTE_METHOD_LAST
6050 } Elm_Map_Route_Method;
6052 typedef enum _Elm_Map_Name_Method
6054 ELM_MAP_NAME_METHOD_SEARCH,
6055 ELM_MAP_NAME_METHOD_REVERSE,
6056 ELM_MAP_NAME_METHOD_LAST
6057 } Elm_Map_Name_Method;
6059 typedef struct _Elm_Map_Marker Elm_Map_Marker;
6060 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
6061 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
6062 typedef struct _Elm_Map_Route Elm_Map_Route;
6063 typedef struct _Elm_Map_Name Elm_Map_Name;
6064 typedef struct _Elm_Map_Track Elm_Map_Track;
6066 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6067 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
6068 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6069 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
6071 typedef char *(*ElmMapModuleSourceFunc) (void);
6072 typedef int (*ElmMapModuleZoomMinFunc) (void);
6073 typedef int (*ElmMapModuleZoomMaxFunc) (void);
6074 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
6075 typedef int (*ElmMapModuleRouteSourceFunc) (void);
6076 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
6077 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
6078 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
6079 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
6081 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6082 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6083 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6084 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
6085 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6086 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
6087 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6088 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6089 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6090 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6091 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6092 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6093 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
6094 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);
6095 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);
6096 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6097 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
6098 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);
6099 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);
6100 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
6101 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6102 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
6103 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6104 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6105 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
6106 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6107 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6108 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
6109 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6110 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6111 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6112 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
6113 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6114 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6115 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
6116 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6117 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6118 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6119 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
6120 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
6121 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6122 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
6123 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6124 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
6125 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6126 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6127 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6128 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6129 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6130 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
6131 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6132 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);
6133 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6134 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
6135 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
6136 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6137 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6138 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6139 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6140 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
6141 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6142 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
6143 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);
6144 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6145 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6147 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
6149 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
6151 /* smart callbacks called:
6152 * "clicked" - when image clicked
6153 * "press" - when mouse/finger held down initially on image
6154 * "longpressed" - when mouse/finger held for long time on image
6155 * "clicked,double" - when mouse/finger double-clicked
6156 * "load,details" - when detailed image load begins
6157 * "loaded,details" - when detailed image load done
6158 * "zoom,start" - when zooming started
6159 * "zoom,stop" - when zooming stopped
6160 * "zoom,change" - when auto zoom mode changed zoom level
6161 * "scroll - the content has been scrolled (moved)
6162 * "scroll,anim,start" - scrolling animation has started
6163 * "scroll,anim,stop" - scrolling animation has stopped
6164 * "scroll,drag,start" - dragging the contents around has started
6165 * "scroll,drag,stop" - dragging the contents around has stopped
6169 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
6171 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
6173 EAPI double elm_route_lon_min_get(Evas_Object *obj);
6174 EAPI double elm_route_lat_min_get(Evas_Object *obj);
6175 EAPI double elm_route_lon_max_get(Evas_Object *obj);
6176 EAPI double elm_route_lat_max_get(Evas_Object *obj);
6180 typedef enum _Elm_Panel_Orient
6182 ELM_PANEL_ORIENT_TOP,
6183 ELM_PANEL_ORIENT_BOTTOM,
6184 ELM_PANEL_ORIENT_LEFT,
6185 ELM_PANEL_ORIENT_RIGHT,
6188 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6189 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
6190 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6191 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6192 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6193 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6194 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
6195 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6196 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
6202 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
6203 * Add events (move, start ...)
6205 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6206 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6207 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6208 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6209 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6210 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6211 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6212 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6213 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
6214 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6215 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6216 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
6217 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6220 typedef enum _Elm_Flip_Mode
6222 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
6223 ELM_FLIP_ROTATE_X_CENTER_AXIS,
6224 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
6225 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
6227 ELM_FLIP_CUBE_RIGHT,
6231 ELM_FLIP_PAGE_RIGHT,
6235 typedef enum _Elm_Flip_Interaction
6237 ELM_FLIP_INTERACTION_NONE,
6238 ELM_FLIP_INTERACTION_ROTATE,
6239 ELM_FLIP_INTERACTION_CUBE,
6240 ELM_FLIP_INTERACTION_PAGE
6241 } Elm_Flip_Interaction;
6242 typedef enum _Elm_Flip_Direction
6244 ELM_FLIP_DIRECTION_UP,
6245 ELM_FLIP_DIRECTION_DOWN,
6246 ELM_FLIP_DIRECTION_LEFT,
6247 ELM_FLIP_DIRECTION_RIGHT
6248 } Elm_Flip_Direction;
6250 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6251 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6252 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6253 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6254 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6255 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6256 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6257 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6258 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
6259 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
6260 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
6261 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
6262 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
6263 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
6264 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
6265 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
6266 /* smart callbacks called:
6267 * "animate,begin" - when a flip animation was started
6268 * "animate,done" - when a flip animation is finished
6272 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6273 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
6274 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6275 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
6276 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6277 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6278 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6279 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6280 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6281 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6282 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6283 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
6284 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
6285 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6286 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
6287 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6288 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6289 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6290 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
6291 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
6292 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6293 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6294 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6295 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6296 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
6297 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6298 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6299 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6300 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6301 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6302 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6303 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
6304 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
6305 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
6306 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6307 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);
6308 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6309 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6310 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);
6311 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6312 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);
6313 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
6314 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6315 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6316 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6317 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
6318 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6319 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6320 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6321 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);
6322 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);
6323 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);
6324 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);
6325 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);
6326 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);
6327 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
6328 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
6329 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
6330 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
6331 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6332 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
6333 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6334 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6335 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
6336 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
6337 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
6338 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
6339 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
6342 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6343 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6344 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6345 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6346 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6349 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6350 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6351 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6352 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6353 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6354 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6355 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
6356 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6357 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
6358 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6361 * @defgroup Flipselector Flip Selector
6363 * A flip selector is a widget to show a set of @b text items, one
6364 * at a time, with the same sheet switching style as the @ref Clock
6365 * "clock" widget, when one changes the current displaying sheet
6366 * (thus, the "flip" in the name).
6368 * User clicks to flip sheets which are @b held for some time will
6369 * make the flip selector to flip continuosly and automatically for
6370 * the user. The interval between flips will keep growing in time,
6371 * so that it helps the user to reach an item which is distant from
6372 * the current selection.
6374 * Smart callbacks one can register to:
6375 * - @c "selected" - when the widget's selected text item is changed
6376 * - @c "overflowed" - when the widget's current selection is changed
6377 * from the first item in its list to the last
6378 * - @c "underflowed" - when the widget's current selection is changed
6379 * from the last item in its list to the first
6381 * Available styles for it:
6384 * Here is an example on its usage:
6385 * @li @ref flipselector_example
6389 * @addtogroup Flipselector
6393 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
6396 * Add a new flip selector widget to the given parent Elementary
6397 * (container) widget
6399 * @param parent The parent object
6400 * @return a new flip selector widget handle or @c NULL, on errors
6402 * This function inserts a new flip selector widget on the canvas.
6404 * @ingroup Flipselector
6406 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6409 * Programmatically select the next item of a flip selector widget
6411 * @param obj The flipselector object
6413 * @note The selection will be animated. Also, if it reaches the
6414 * end of its list of member items, it will continue with the first
6417 * @ingroup Flipselector
6419 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6422 * Programmatically select the previous item of a flip selector
6425 * @param obj The flipselector object
6427 * @note The selection will be animated. Also, if it reaches the
6428 * beginning of its list of member items, it will continue with the
6429 * last one backwards.
6431 * @ingroup Flipselector
6433 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6436 * Append a (text) item to a flip selector widget
6438 * @param obj The flipselector object
6439 * @param label The (text) label of the new item
6440 * @param func Convenience callback function to take place when
6442 * @param data Data passed to @p func, above
6443 * @return A handle to the item added or @c NULL, on errors
6445 * The widget's list of labels to show will be appended with the
6446 * given value. If the user wishes so, a callback function pointer
6447 * can be passed, which will get called when this same item is
6450 * @note The current selection @b won't be modified by appending an
6451 * element to the list.
6453 * @note The maximum length of the text label is going to be
6454 * determined <b>by the widget's theme</b>. Strings larger than
6455 * that value are going to be @b truncated.
6457 * @ingroup Flipselector
6459 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6462 * Prepend a (text) item to a flip selector widget
6464 * @param obj The flipselector object
6465 * @param label The (text) label of the new item
6466 * @param func Convenience callback function to take place when
6468 * @param data Data passed to @p func, above
6469 * @return A handle to the item added or @c NULL, on errors
6471 * The widget's list of labels to show will be prepended with the
6472 * given value. If the user wishes so, a callback function pointer
6473 * can be passed, which will get called when this same item is
6476 * @note The current selection @b won't be modified by prepending
6477 * an element to the list.
6479 * @note The maximum length of the text label is going to be
6480 * determined <b>by the widget's theme</b>. Strings larger than
6481 * that value are going to be @b truncated.
6483 * @ingroup Flipselector
6485 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6488 * Get the internal list of items in a given flip selector widget.
6490 * @param obj The flipselector object
6491 * @return The list of items (#Elm_Flipselector_Item as data) or @c
6494 * This list is @b not to be modified in any way and must not be
6495 * freed. Use the list members with functions like
6496 * elm_flipselector_item_label_set(),
6497 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
6498 * elm_flipselector_item_del(),
6499 * elm_flipselector_item_selected_get(),
6500 * elm_flipselector_item_selected_set().
6502 * @warning This list is only valid until @p obj object's internal
6503 * items list is changed. It should be fetched again with another
6504 * call to this function when changes happen.
6506 * @ingroup Flipselector
6508 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6511 * Get the first item in the given flip selector widget's list of
6514 * @param obj The flipselector object
6515 * @return The first item or @c NULL, if it has no items (and on
6518 * @see elm_flipselector_item_append()
6519 * @see elm_flipselector_last_item_get()
6521 * @ingroup Flipselector
6523 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6526 * Get the last item in the given flip selector widget's list of
6529 * @param obj The flipselector object
6530 * @return The last item or @c NULL, if it has no items (and on
6533 * @see elm_flipselector_item_prepend()
6534 * @see elm_flipselector_first_item_get()
6536 * @ingroup Flipselector
6538 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6541 * Get the currently selected item in a flip selector widget.
6543 * @param obj The flipselector object
6544 * @return The selected item or @c NULL, if the widget has no items
6547 * @ingroup Flipselector
6549 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6552 * Set whether a given flip selector widget's item should be the
6553 * currently selected one.
6555 * @param item The flip selector item
6556 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
6558 * This sets whether @p item is or not the selected (thus, under
6559 * display) one. If @p item is different than one under display,
6560 * the latter will be unselected. If the @p item is set to be
6561 * unselected, on the other hand, the @b first item in the widget's
6562 * internal members list will be the new selected one.
6564 * @see elm_flipselector_item_selected_get()
6566 * @ingroup Flipselector
6568 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6571 * Get whether a given flip selector widget's item is the currently
6574 * @param item The flip selector item
6575 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6578 * @see elm_flipselector_item_selected_set()
6580 * @ingroup Flipselector
6582 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6585 * Delete a given item from a flip selector widget.
6587 * @param item The item to delete
6589 * @ingroup Flipselector
6591 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6594 * Get the label of a given flip selector widget's item.
6596 * @param item The item to get label from
6597 * @return The text label of @p item or @c NULL, on errors
6599 * @see elm_flipselector_item_label_set()
6601 * @ingroup Flipselector
6603 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6606 * Set the label of a given flip selector widget's item.
6608 * @param item The item to set label on
6609 * @param label The text label string, in UTF-8 encoding
6611 * @see elm_flipselector_item_label_get()
6613 * @ingroup Flipselector
6615 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6618 * Gets the item before @p item in a flip selector widget's
6619 * internal list of items.
6621 * @param item The item to fetch previous from
6622 * @return The item before the @p item, in its parent's list. If
6623 * there is no previous item for @p item or there's an
6624 * error, @c NULL is returned.
6626 * @see elm_flipselector_item_next_get()
6628 * @ingroup Flipselector
6630 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6633 * Gets the item after @p item in a flip selector widget's
6634 * internal list of items.
6636 * @param item The item to fetch next from
6637 * @return The item after the @p item, in its parent's list. If
6638 * there is no next item for @p item or there's an
6639 * error, @c NULL is returned.
6641 * @see elm_flipselector_item_next_get()
6643 * @ingroup Flipselector
6645 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6648 * Set the interval on time updates for an user mouse button hold
6649 * on a flip selector widget.
6651 * @param obj The flip selector object
6652 * @param interval The (first) interval value in seconds
6654 * This interval value is @b decreased while the user holds the
6655 * mouse pointer either flipping up or flipping doww a given flip
6658 * This helps the user to get to a given item distant from the
6659 * current one easier/faster, as it will start to flip quicker and
6660 * quicker on mouse button holds.
6662 * The calculation for the next flip interval value, starting from
6663 * the one set with this call, is the previous interval divided by
6664 * 1.05, so it decreases a little bit.
6666 * The default starting interval value for automatic flips is
6669 * @see elm_flipselector_interval_get()
6671 * @ingroup Flipselector
6673 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6676 * Get the interval on time updates for an user mouse button hold
6677 * on a flip selector widget.
6679 * @param obj The flip selector object
6680 * @return The (first) interval value, in seconds, set on it
6682 * @see elm_flipselector_interval_set() for more details
6684 * @ingroup Flipselector
6686 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6693 * @addtogroup Animator Animator
6694 * @ingroup Elementary
6696 * @brief Functions to ease creation of animations.
6698 * elm_animator is designed to provide an easy way to create animations.
6699 * Creating an animation with elm_animator is as simple as setting a
6700 * duration, an operating callback and telling it to run the animation.
6701 * However that is not the full extent of elm_animator's ability, animations
6702 * can be paused and resumed, reversed and the animation need not be linear.
6704 * To run an animation you must specify at least a duration and operation
6705 * callback, not setting any other properties will create a linear animation
6706 * that runs once and is not reversed.
6708 * @ref elm_animator_example_page_01 "This" example should make all of that
6711 * @warning elm_animator is @b not a widget.
6715 * @brief Type of curve desired for animation.
6717 * The speed in which an animation happens doesn't have to be linear, some
6718 * animations will look better if they're accelerating or decelerating, so
6719 * elm_animator provides four options in this regard:
6720 * @image html elm_animator_curve_style.png
6721 * @image latex elm_animator_curve_style.eps width=\textwidth
6722 * As can be seen in the image the speed of the animation will be:
6723 * @li ELM_ANIMATOR_CURVE_LINEAR constant
6724 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
6725 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
6726 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
6730 ELM_ANIMATOR_CURVE_LINEAR,
6731 ELM_ANIMATOR_CURVE_IN_OUT,
6732 ELM_ANIMATOR_CURVE_IN,
6733 ELM_ANIMATOR_CURVE_OUT
6734 } Elm_Animator_Curve_Style;
6735 typedef struct _Elm_Animator Elm_Animator;
6737 * Called back per loop of an elementary animators cycle
6738 * @param data user-data given to elm_animator_operation_callback_set()
6739 * @param animator the animator being run
6740 * @param double the position in the animation
6742 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
6744 * Called back when an elementary animator finishes
6745 * @param data user-data given to elm_animator_completion_callback_set()
6747 typedef void (*Elm_Animator_Completion_Cb) (void *data);
6750 * @brief Create a new animator.
6752 * @param[in] parent Parent object
6754 * The @a parent argument can be set to NULL for no parent. If a parent is set
6755 * there is no need to call elm_animator_del(), when the parent is deleted it
6756 * will delete the animator.
6757 * @deprecated Use @ref Transit instead.
6760 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
6762 * Deletes the animator freeing any resources it used. If the animator was
6763 * created with a NULL parent this must be called, otherwise it will be
6764 * automatically called when the parent is deleted.
6766 * @param[in] animator Animator object
6767 * @deprecated Use @ref Transit instead.
6769 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6771 * Set the duration of the animation.
6773 * @param[in] animator Animator object
6774 * @param[in] duration Duration in second
6775 * @deprecated Use @ref Transit instead.
6777 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
6779 * @brief Set the callback function for animator operation.
6781 * @param[in] animator Animator object
6782 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
6783 * @param[in] data Callback function user argument
6785 * The @p func callback will be called with a frame value in range [0, 1] which
6786 * indicates how far along the animation should be. It is the job of @p func to
6787 * actually change the state of any object(or objects) that are being animated.
6788 * @deprecated Use @ref Transit instead.
6790 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
6792 * Set the callback function for the when the animation ends.
6794 * @param[in] animator Animator object
6795 * @param[in] func Callback function pointe
6796 * @param[in] data Callback function user argument
6798 * @warning @a func will not be executed if elm_animator_stop() is called.
6799 * @deprecated Use @ref Transit instead.
6801 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
6803 * @brief Stop animator.
6805 * @param[in] animator Animator object
6807 * If called before elm_animator_animate() it does nothing. If there is an
6808 * animation in progress the animation will be stopped(the operation callback
6809 * will not be executed again) and it can't be restarted using
6810 * elm_animator_resume().
6811 * @deprecated Use @ref Transit instead.
6813 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6815 * Set the animator repeat count.
6817 * @param[in] animator Animator object
6818 * @param[in] repeat_cnt Repeat count
6819 * @deprecated Use @ref Transit instead.
6821 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
6823 * @brief Start animation.
6825 * @param[in] animator Animator object
6827 * This function starts the animation if the nescessary properties(duration
6828 * and operation callback) have been set. Once started the animation will
6829 * run until complete or elm_animator_stop() is called.
6830 * @deprecated Use @ref Transit instead.
6832 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6834 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6836 * @param[in] animator Animator object
6837 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6838 * @deprecated Use @ref Transit instead.
6840 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
6842 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6844 * @param[in] animator Animator object
6845 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6846 * @deprecated Use @ref Transit instead.
6848 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6850 * @brief Sets wether the animation should be automatically reversed.
6852 * @param[in] animator Animator object
6853 * @param[in] reverse Reverse or not
6855 * This controls wether the animation will be run on reverse imediately after
6856 * running forward. When this is set together with repetition the animation
6857 * will run in reverse once for each time it ran forward.@n
6858 * Runnin an animation in reverse is accomplished by calling the operation
6859 * callback with a frame value starting at 1 and diminshing until 0.
6860 * @deprecated Use @ref Transit instead.
6862 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
6864 * Gets wether the animation will automatically reversed
6866 * @param[in] animator Animator object
6867 * @deprecated Use @ref Transit instead.
6869 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6871 * Gets the status for the animator operation. The status of the animator @b
6872 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
6873 * only informs if the animation was started and has not ended(either normally
6874 * or through elm_animator_stop()).
6876 * @param[in] animator Animator object
6877 * @deprecated Use @ref Transit instead.
6879 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6881 * Gets how many times the animation will be repeated
6883 * @param[in] animator Animator object
6884 * @deprecated Use @ref Transit instead.
6886 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6888 * Pause the animator.
6890 * @param[in] animator Animator object
6892 * This causes the animation to be temporarily stopped(the operation callback
6893 * will not be called). If the animation is not yet running this is a no-op.
6894 * Once an animation has been paused with this function it can be resumed
6895 * using elm_animator_resume().
6896 * @deprecated Use @ref Transit instead.
6898 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6900 * @brief Resumes the animator.
6902 * @param[in] animator Animator object
6904 * Resumes an animation that was paused using elm_animator_pause(), after
6905 * calling this function calls to the operation callback will happen
6906 * normally. If an animation is stopped by means of elm_animator_stop it
6907 * @b can't be restarted with this function.@n
6909 * @warning When an animation is resumed it doesn't start from where it was paused, it
6910 * will go to where it would have been if it had not been paused. If an
6911 * animation with a duration of 3 seconds is paused after 1 second for 1 second
6912 * it will resume as if it had ben animating for 2 seconds, the operating
6913 * callback will be called with a frame value of aproximately 2/3.
6914 * @deprecated Use @ref Transit instead.
6916 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6924 ELM_CALENDAR_UNIQUE,
6926 ELM_CALENDAR_WEEKLY,
6927 ELM_CALENDAR_MONTHLY,
6928 ELM_CALENDAR_ANNUALLY
6929 } Elm_Calendar_Mark_Repeat;
6930 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
6932 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6933 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6934 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
6935 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6936 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6937 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
6938 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
6939 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6940 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6941 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
6942 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
6943 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
6944 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);
6945 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
6946 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6947 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6948 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
6949 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6950 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6951 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6952 /* smart callbacks called:
6953 * changed - emitted when the user select a day or change the displayed
6958 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
6960 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6961 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6962 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
6963 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6964 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
6965 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6966 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
6967 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6968 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6969 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);
6970 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6971 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6972 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6973 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);
6974 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6975 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6976 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6977 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6978 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
6979 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6980 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6981 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6982 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6983 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6984 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6985 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6986 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6987 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6988 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
6989 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);
6990 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6991 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
6992 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6993 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6994 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6995 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6996 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
6997 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6998 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6999 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7000 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
7001 /* smart callbacks called:
7002 * "selected" - when item is selected (scroller stops)
7006 * @page tutorial_colorselector Color selector example
7007 * @dontinclude colorselector_example_01.c
7009 * This example shows how to change the color of a rectangle using a color
7010 * selector. We aren't going to explain a lot of the code since it's the
7014 * Now that we have a window with background and a rectangle we can create
7015 * our color_selector and set it's initial color to fully opaque blue:
7018 * Next we tell ask to be notified whenever the color changes:
7021 * We follow that we some more run of the mill setup code:
7024 * And now get to the callback that sets the color of the rectangle:
7027 * This example will look like this:
7028 * @image html screenshots/colorselector_example_01.png
7029 * @image latex screenshots/colorselector_example_01.eps
7031 * @example colorselector_example_01.c
7034 * @defgroup Colorselector Colorselector
7038 * @brief Widget for user to select a color.
7040 * Signals that you can add callbacks for are:
7041 * "changed" - When the color value changes(event_info is NULL).
7043 * See @ref tutorial_colorselector.
7046 * @brief Add a new colorselector to the parent
7048 * @param parent The parent object
7049 * @return The new object or NULL if it cannot be created
7051 * @ingroup Colorselector
7053 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7055 * Set a color for the colorselector
7057 * @param obj Colorselector object
7058 * @param r r-value of color
7059 * @param g g-value of color
7060 * @param b b-value of color
7061 * @param a a-value of color
7063 * @ingroup Colorselector
7065 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
7067 * Get a color from the colorselector
7069 * @param obj Colorselector object
7070 * @param r integer pointer for r-value of color
7071 * @param g integer pointer for g-value of color
7072 * @param b integer pointer for b-value of color
7073 * @param a integer pointer for a-value of color
7075 * @ingroup Colorselector
7077 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
7082 /* Contextual Popup */
7083 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
7085 typedef enum _Elm_Ctxpopup_Direction
7087 ELM_CTXPOPUP_DIRECTION_DOWN,
7088 ELM_CTXPOPUP_DIRECTION_RIGHT,
7089 ELM_CTXPOPUP_DIRECTION_LEFT,
7090 ELM_CTXPOPUP_DIRECTION_UP,
7091 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
7092 } Elm_Ctxpopup_Direction;
7094 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7095 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7096 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7097 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7098 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
7099 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
7100 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7101 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7102 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7103 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7104 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);
7105 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7106 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7107 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7108 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
7109 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7110 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);
7111 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);
7112 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7113 /* smart callbacks called:
7114 * "dismissed" - the ctxpopup was dismissed
7120 * @defgroup Transit Transit
7121 * @ingroup Elementary
7123 * Transit is designed to apply various animated transition effects to @c
7124 * Evas_Object, such like translation, rotation, etc. For using these
7125 * effects, create an @ref Elm_Transit and add the desired transition effects.
7127 * Once the effects are added into transit, they will be automatically
7128 * managed (their callback will be called until the duration is ended, and
7129 * they will be deleted on completion).
7133 * Elm_Transit *trans = elm_transit_add();
7134 * elm_transit_object_add(trans, obj);
7135 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
7136 * elm_transit_duration_set(transit, 1);
7137 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
7138 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
7139 * elm_transit_repeat_times_set(transit, 3);
7142 * Some transition effects are used to change the properties of objects. They
7144 * @li @ref elm_transit_effect_translation_add
7145 * @li @ref elm_transit_effect_color_add
7146 * @li @ref elm_transit_effect_rotation_add
7147 * @li @ref elm_transit_effect_wipe_add
7148 * @li @ref elm_transit_effect_zoom_add
7149 * @li @ref elm_transit_effect_resizing_add
7151 * Other transition effects are used to make one object disappear and another
7152 * object appear on its old place. These effects are:
7154 * @li @ref elm_transit_effect_flip_add
7155 * @li @ref elm_transit_effect_resizable_flip_add
7156 * @li @ref elm_transit_effect_fade_add
7157 * @li @ref elm_transit_effect_blend_add
7159 * It's also possible to make a transition chain with @ref
7160 * elm_transit_chain_transit_add.
7162 * @warning We strongly recommend to use elm_transit just when edje can not do
7163 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
7164 * animations can be manipulated inside the theme.
7167 * @li @ref transit_example_01_explained
7168 * @li @ref transit_example_02_explained
7169 * @li @ref transit_example_03_c
7170 * @li @ref transit_example_04_c
7176 * @enum Elm_Transit_Tween_Mode
7178 * The type of acceleration used in the transition.
7182 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
7183 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
7184 over time, then decrease again
7186 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
7188 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
7190 } Elm_Transit_Tween_Mode;
7193 * @enum Elm_Transit_Effect_Flip_Axis
7195 * The axis where flip effect should be applied.
7199 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
7200 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
7201 } Elm_Transit_Effect_Flip_Axis;
7203 * @enum Elm_Transit_Effect_Wipe_Dir
7205 * The direction where the wipe effect should occur.
7209 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
7210 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
7211 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
7212 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
7213 } Elm_Transit_Effect_Wipe_Dir;
7214 /** @enum Elm_Transit_Effect_Wipe_Type
7216 * Whether the wipe effect should show or hide the object.
7220 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
7222 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
7224 } Elm_Transit_Effect_Wipe_Type;
7227 * @typedef Elm_Transit
7229 * The Transit created with elm_transit_add(). This type has the information
7230 * about the objects which the transition will be applied, and the
7231 * transition effects that will be used. It also contains info about
7232 * duration, number of repetitions, auto-reverse, etc.
7234 typedef struct _Elm_Transit Elm_Transit;
7235 typedef void Elm_Transit_Effect;
7237 * @typedef Elm_Transit_Effect_Transition_Cb
7239 * Transition callback called for this effect on each transition iteration.
7241 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
7243 * Elm_Transit_Effect_End_Cb
7245 * Transition callback called for this effect when the transition is over.
7247 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
7250 * Elm_Transit_Del_Cb
7252 * A callback called when the transit is deleted.
7254 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
7259 * @note Is not necessary to delete the transit object, it will be deleted at
7260 * the end of its operation.
7261 * @note The transit will start playing when the program enter in the main loop, is not
7262 * necessary to give a start to the transit.
7264 * @return The transit object.
7268 EAPI Elm_Transit *elm_transit_add(void);
7271 * Stops the animation and delete the @p transit object.
7273 * Call this function if you wants to stop the animation before the duration
7274 * time. Make sure the @p transit object is still alive with
7275 * elm_transit_del_cb_set() function.
7276 * All added effects will be deleted, calling its repective data_free_cb
7277 * functions. The function setted by elm_transit_del_cb_set() will be called.
7279 * @see elm_transit_del_cb_set()
7281 * @param transit The transit object to be deleted.
7284 * @warning Just call this function if you are sure the transit is alive.
7286 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7289 * Add a new effect to the transit.
7291 * @note The cb function and the data are the key to the effect. If you try to
7292 * add an already added effect, nothing is done.
7293 * @note After the first addition of an effect in @p transit, if its
7294 * effect list become empty again, the @p transit will be killed by
7295 * elm_transit_del(transit) function.
7299 * Elm_Transit *transit = elm_transit_add();
7300 * elm_transit_effect_add(transit,
7301 * elm_transit_effect_blend_op,
7302 * elm_transit_effect_blend_context_new(),
7303 * elm_transit_effect_blend_context_free);
7306 * @param transit The transit object.
7307 * @param transition_cb The operation function. It is called when the
7308 * animation begins, it is the function that actually performs the animation.
7309 * It is called with the @p data, @p transit and the time progression of the
7310 * animation (a double value between 0.0 and 1.0).
7311 * @param effect The context data of the effect.
7312 * @param end_cb The function to free the context data, it will be called
7313 * at the end of the effect, it must finalize the animation and free the
7317 * @warning The transit free the context data at the and of the transition with
7318 * the data_free_cb function, do not use the context data in another transit.
7320 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);
7323 * Delete an added effect.
7325 * This function will remove the effect from the @p transit, calling the
7326 * data_free_cb to free the @p data.
7328 * @see elm_transit_effect_add()
7330 * @note If the effect is not found, nothing is done.
7331 * @note If the effect list become empty, this function will call
7332 * elm_transit_del(transit), that is, it will kill the @p transit.
7334 * @param transit The transit object.
7335 * @param transition_cb The operation function.
7336 * @param effect The context data of the effect.
7340 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);
7343 * Add new object to apply the effects.
7345 * @note After the first addition of an object in @p transit, if its
7346 * object list become empty again, the @p transit will be killed by
7347 * elm_transit_del(transit) function.
7348 * @note If the @p obj belongs to another transit, the @p obj will be
7349 * removed from it and it will only belong to the @p transit. If the old
7350 * transit stays without objects, it will die.
7351 * @note When you add an object into the @p transit, its state from
7352 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7353 * transit ends, if you change this state whith evas_object_pass_events_set()
7354 * after add the object, this state will change again when @p transit stops to
7357 * @param transit The transit object.
7358 * @param obj Object to be animated.
7361 * @warning It is not allowed to add a new object after transit begins to go.
7363 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7366 * Removes an added object from the transit.
7368 * @note If the @p obj is not in the @p transit, nothing is done.
7369 * @note If the list become empty, this function will call
7370 * elm_transit_del(transit), that is, it will kill the @p transit.
7372 * @param transit The transit object.
7373 * @param obj Object to be removed from @p transit.
7376 * @warning It is not allowed to remove objects after transit begins to go.
7378 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7381 * Get the objects of the transit.
7383 * @param transit The transit object.
7384 * @return a Eina_List with the objects from the transit.
7388 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7391 * Enable/disable keeping up the objects states.
7392 * If it is not kept, the objects states will be reset when transition ends.
7394 * @note @p transit can not be NULL.
7395 * @note One state includes geometry, color, map data.
7397 * @param transit The transit object.
7398 * @param state_keep Keeping or Non Keeping.
7402 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
7405 * Get a value whether the objects states will be reset or not.
7407 * @note @p transit can not be NULL
7409 * @see elm_transit_objects_final_state_keep_set()
7411 * @param transit The transit object.
7412 * @return EINA_TRUE means the states of the objects will be reset.
7413 * If @p transit is NULL, EINA_FALSE is returned
7417 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7420 * Set the event enabled when transit is operating.
7422 * If @p enabled is EINA_TRUE, the objects of the transit will receives
7423 * events from mouse and keyboard during the animation.
7424 * @note When you add an object with elm_transit_object_add(), its state from
7425 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7426 * transit ends, if you change this state with evas_object_pass_events_set()
7427 * after adding the object, this state will change again when @p transit stops
7430 * @param transit The transit object.
7431 * @param enabled Events are received when enabled is @c EINA_TRUE, and
7432 * ignored otherwise.
7436 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7439 * Get the value of event enabled status.
7441 * @see elm_transit_event_enabled_set()
7443 * @param transit The Transit object
7444 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
7445 * EINA_FALSE is returned
7449 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7452 * Set the user-callback function when the transit is deleted.
7454 * @note Using this function twice will overwrite the first function setted.
7455 * @note the @p transit object will be deleted after call @p cb function.
7457 * @param transit The transit object.
7458 * @param cb Callback function pointer. This function will be called before
7459 * the deletion of the transit.
7460 * @param data Callback funtion user data. It is the @p op parameter.
7464 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
7467 * Set reverse effect automatically.
7469 * If auto reverse is setted, after running the effects with the progress
7470 * parameter from 0 to 1, it will call the effecs again with the progress
7471 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
7472 * where the duration was setted with the function elm_transit_add and
7473 * the repeat with the function elm_transit_repeat_times_set().
7475 * @param transit The transit object.
7476 * @param reverse EINA_TRUE means the auto_reverse is on.
7480 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
7483 * Get if the auto reverse is on.
7485 * @see elm_transit_auto_reverse_set()
7487 * @param transit The transit object.
7488 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
7489 * EINA_FALSE is returned
7493 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7496 * Set the transit repeat count. Effect will be repeated by repeat count.
7498 * This function sets the number of repetition the transit will run after
7499 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
7500 * If the @p repeat is a negative number, it will repeat infinite times.
7502 * @note If this function is called during the transit execution, the transit
7503 * will run @p repeat times, ignoring the times it already performed.
7505 * @param transit The transit object
7506 * @param repeat Repeat count
7510 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
7513 * Get the transit repeat count.
7515 * @see elm_transit_repeat_times_set()
7517 * @param transit The Transit object.
7518 * @return The repeat count. If @p transit is NULL
7523 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7526 * Set the transit animation acceleration type.
7528 * This function sets the tween mode of the transit that can be:
7529 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
7530 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
7531 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
7532 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
7534 * @param transit The transit object.
7535 * @param tween_mode The tween type.
7539 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
7542 * Get the transit animation acceleration type.
7544 * @note @p transit can not be NULL
7546 * @param transit The transit object.
7547 * @return The tween type. If @p transit is NULL
7548 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
7552 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7555 * Set the transit animation time
7557 * @note @p transit can not be NULL
7559 * @param transit The transit object.
7560 * @param duration The animation time.
7564 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
7567 * Get the transit animation time
7569 * @note @p transit can not be NULL
7571 * @param transit The transit object.
7573 * @return The transit animation time.
7577 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7580 * Starts the transition.
7581 * Once this API is called, the transit begins to measure the time.
7583 * @note @p transit can not be NULL
7585 * @param transit The transit object.
7589 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7592 * Pause/Resume the transition.
7594 * If you call elm_transit_go again, the transit will be started from the
7595 * beginning, and will be unpaused.
7597 * @note @p transit can not be NULL
7599 * @param transit The transit object.
7600 * @param paused Whether the transition should be paused or not.
7604 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
7607 * Get the value of paused status.
7609 * @see elm_transit_paused_set()
7611 * @note @p transit can not be NULL
7613 * @param transit The transit object.
7614 * @return EINA_TRUE means transition is paused. If @p transit is NULL
7615 * EINA_FALSE is returned
7619 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7622 * Get the time progression of the animation (a double value between 0.0 and 1.0).
7624 * The value returned is a fraction (current time / total time). It
7625 * represents the progression position relative to the total.
7627 * @note @p transit can not be NULL
7629 * @param transit The transit object.
7631 * @return The time progression value. If @p transit is NULL
7636 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7639 * Makes the chain relationship between two transits.
7641 * @note @p transit can not be NULL. Transit would have multiple chain transits.
7642 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
7644 * @param transit The transit object.
7645 * @param chain_transit The chain transit object. This transit will be operated
7646 * after transit is done.
7648 * This function adds @p chain_transit transition to a chain after the @p
7649 * transit, and will be started as soon as @p transit ends. See @ref
7650 * transit_example_02_explained for a full example.
7654 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
7657 * Cut off the chain relationship between two transits.
7659 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
7660 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
7662 * @param transit The transit object.
7663 * @param chain_transit The chain transit object.
7665 * This function remove the @p chain_transit transition from the @p transit.
7669 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
7672 * Get the current chain transit list.
7674 * @note @p transit can not be NULL.
7676 * @param transit The transit object.
7677 * @return chain transit list.
7681 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
7684 * Add the Resizing Effect to Elm_Transit.
7686 * @note This API is one of the facades. It creates resizing effect context
7687 * and add it's required APIs to elm_transit_effect_add.
7689 * @see elm_transit_effect_add()
7691 * @param transit Transit object.
7692 * @param from_w Object width size when effect begins.
7693 * @param from_h Object height size when effect begins.
7694 * @param to_w Object width size when effect ends.
7695 * @param to_h Object height size when effect ends.
7696 * @return Resizing effect context data.
7700 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);
7703 * Add the Translation Effect to Elm_Transit.
7705 * @note This API is one of the facades. It creates translation effect context
7706 * and add it's required APIs to elm_transit_effect_add.
7708 * @see elm_transit_effect_add()
7710 * @param transit Transit object.
7711 * @param from_dx X Position variation when effect begins.
7712 * @param from_dy Y Position variation when effect begins.
7713 * @param to_dx X Position variation when effect ends.
7714 * @param to_dy Y Position variation when effect ends.
7715 * @return Translation 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_translation_add(Elm_Transit* transit, Evas_Coord from_dx, Evas_Coord from_dy, Evas_Coord to_dx, Evas_Coord to_dy);
7726 * Add the Zoom Effect to Elm_Transit.
7728 * @note This API is one of the facades. It creates zoom effect context
7729 * and add it's required APIs to elm_transit_effect_add.
7731 * @see elm_transit_effect_add()
7733 * @param transit Transit object.
7734 * @param from_rate Scale rate when effect begins (1 is current rate).
7735 * @param to_rate Scale rate when effect ends.
7736 * @return Zoom effect context data.
7739 * @warning It is highly recommended just create a transit with this effect when
7740 * the window that the objects of the transit belongs has already been created.
7741 * This is because this effect needs the geometry information about the objects,
7742 * and if the window was not created yet, it can get a wrong information.
7744 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
7747 * Add the Flip Effect to Elm_Transit.
7749 * @note This API is one of the facades. It creates flip effect context
7750 * and add it's required APIs to elm_transit_effect_add.
7751 * @note This effect is applied to each pair of objects in the order they are listed
7752 * in the transit list of objects. The first object in the pair will be the
7753 * "front" object and the second will be the "back" object.
7755 * @see elm_transit_effect_add()
7757 * @param transit Transit object.
7758 * @param axis Flipping Axis(X or Y).
7759 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7760 * @return Flip 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_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7771 * Add the Resizable Flip Effect to Elm_Transit.
7773 * @note This API is one of the facades. It creates resizable flip effect context
7774 * and add it's required APIs to elm_transit_effect_add.
7775 * @note This effect is applied to each pair of objects in the order they are listed
7776 * in the transit list of objects. The first object in the pair will be the
7777 * "front" object and the second will be the "back" object.
7779 * @see elm_transit_effect_add()
7781 * @param transit Transit object.
7782 * @param axis Flipping Axis(X or Y).
7783 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7784 * @return Resizable flip effect context data.
7787 * @warning It is highly recommended just create a transit with this effect when
7788 * the window that the objects of the transit belongs has already been created.
7789 * This is because this effect needs the geometry information about the objects,
7790 * and if the window was not created yet, it can get a wrong information.
7792 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7795 * Add the Wipe Effect to Elm_Transit.
7797 * @note This API is one of the facades. It creates wipe effect context
7798 * and add it's required APIs to elm_transit_effect_add.
7800 * @see elm_transit_effect_add()
7802 * @param transit Transit object.
7803 * @param type Wipe type. Hide or show.
7804 * @param dir Wipe Direction.
7805 * @return Wipe 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 geometry 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_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
7816 * Add the Color Effect to Elm_Transit.
7818 * @note This API is one of the facades. It creates color effect context
7819 * and add it's required APIs to elm_transit_effect_add.
7821 * @see elm_transit_effect_add()
7823 * @param transit Transit object.
7824 * @param from_r RGB R when effect begins.
7825 * @param from_g RGB G when effect begins.
7826 * @param from_b RGB B when effect begins.
7827 * @param from_a RGB A when effect begins.
7828 * @param to_r RGB R when effect ends.
7829 * @param to_g RGB G when effect ends.
7830 * @param to_b RGB B when effect ends.
7831 * @param to_a RGB A when effect ends.
7832 * @return Color effect context data.
7836 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);
7839 * Add the Fade Effect to Elm_Transit.
7841 * @note This API is one of the facades. It creates fade effect context
7842 * and add it's required APIs to elm_transit_effect_add.
7843 * @note This effect is applied to each pair of objects in the order they are listed
7844 * in the transit list of objects. The first object in the pair will be the
7845 * "before" object and the second will be the "after" object.
7847 * @see elm_transit_effect_add()
7849 * @param transit Transit object.
7850 * @return Fade effect context data.
7853 * @warning It is highly recommended just create a transit with this effect when
7854 * the window that the objects of the transit belongs has already been created.
7855 * This is because this effect needs the color information about the objects,
7856 * and if the window was not created yet, it can get a wrong information.
7858 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
7861 * Add the Blend Effect to Elm_Transit.
7863 * @note This API is one of the facades. It creates blend effect context
7864 * and add it's required APIs to elm_transit_effect_add.
7865 * @note This effect is applied to each pair of objects in the order they are listed
7866 * in the transit list of objects. The first object in the pair will be the
7867 * "before" object and the second will be the "after" object.
7869 * @see elm_transit_effect_add()
7871 * @param transit Transit object.
7872 * @return Blend effect context data.
7875 * @warning It is highly recommended just create a transit with this effect when
7876 * the window that the objects of the transit belongs has already been created.
7877 * This is because this effect needs the color information about the objects,
7878 * and if the window was not created yet, it can get a wrong information.
7880 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
7883 * Add the Rotation Effect to Elm_Transit.
7885 * @note This API is one of the facades. It creates rotation effect context
7886 * and add it's required APIs to elm_transit_effect_add.
7888 * @see elm_transit_effect_add()
7890 * @param transit Transit object.
7891 * @param from_degree Degree when effect begins.
7892 * @param to_degree Degree when effect is ends.
7893 * @return Rotation effect context data.
7896 * @warning It is highly recommended just create a transit with this effect when
7897 * the window that the objects of the transit belongs has already been created.
7898 * This is because this effect needs the geometry information about the objects,
7899 * and if the window was not created yet, it can get a wrong information.
7901 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
7904 * Add the ImageAnimation Effect to Elm_Transit.
7906 * @note This API is one of the facades. It creates image animation effect context
7907 * and add it's required APIs to elm_transit_effect_add.
7908 * The @p images parameter is a list images paths. This list and
7909 * its contents will be deleted at the end of the effect by
7910 * elm_transit_effect_image_animation_context_free() function.
7914 * char buf[PATH_MAX];
7915 * Eina_List *images = NULL;
7916 * Elm_Transit *transi = elm_transit_add();
7918 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
7919 * images = eina_list_append(images, eina_stringshare_add(buf));
7921 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
7922 * images = eina_list_append(images, eina_stringshare_add(buf));
7923 * elm_transit_effect_image_animation_add(transi, images);
7927 * @see elm_transit_effect_add()
7929 * @param transit Transit object.
7930 * @param images Eina_List of images file paths. This list and
7931 * its contents will be deleted at the end of the effect by
7932 * elm_transit_effect_image_animation_context_free() function.
7933 * @return Image Animation effect context data.
7937 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
7943 typedef struct _Elm_Store Elm_Store;
7944 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
7945 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
7946 typedef struct _Elm_Store_Item Elm_Store_Item;
7947 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
7948 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
7949 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
7950 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
7951 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
7952 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
7953 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
7954 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
7955 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
7957 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
7958 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
7959 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
7960 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
7961 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
7962 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
7963 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
7967 ELM_STORE_ITEM_MAPPING_NONE = 0,
7968 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
7969 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
7970 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
7971 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
7972 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
7973 // can add more here as needed by common apps
7974 ELM_STORE_ITEM_MAPPING_LAST
7975 } Elm_Store_Item_Mapping_Type;
7977 struct _Elm_Store_Item_Mapping_Icon
7979 // FIXME: allow edje file icons
7981 Elm_Icon_Lookup_Order lookup_order;
7982 Eina_Bool standard_name : 1;
7983 Eina_Bool no_scale : 1;
7984 Eina_Bool smooth : 1;
7985 Eina_Bool scale_up : 1;
7986 Eina_Bool scale_down : 1;
7989 struct _Elm_Store_Item_Mapping_Empty
7994 struct _Elm_Store_Item_Mapping_Photo
7999 struct _Elm_Store_Item_Mapping_Custom
8001 Elm_Store_Item_Mapping_Cb func;
8004 struct _Elm_Store_Item_Mapping
8006 Elm_Store_Item_Mapping_Type type;
8010 Elm_Store_Item_Mapping_Empty empty;
8011 Elm_Store_Item_Mapping_Icon icon;
8012 Elm_Store_Item_Mapping_Photo photo;
8013 Elm_Store_Item_Mapping_Custom custom;
8014 // add more types here
8018 struct _Elm_Store_Item_Info
8024 int pre_group_index;
8026 Elm_Genlist_Item_Class *item_class;
8027 const Elm_Store_Item_Mapping *mapping;
8032 struct _Elm_Store_Item_Info_Filesystem
8034 Elm_Store_Item_Info base;
8038 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
8039 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
8041 EAPI Elm_Store *elm_store_dbsystem_new(void);
8042 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
8043 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
8044 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
8045 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
8046 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8047 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8048 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
8049 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8050 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
8051 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8052 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
8053 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8054 EAPI void elm_store_free(Elm_Store *st);
8055 EAPI Elm_Store *elm_store_filesystem_new(void);
8056 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
8057 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8058 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8059 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
8060 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
8061 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8062 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8063 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8064 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
8065 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8066 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8067 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
8068 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8069 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
8070 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8071 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8072 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8074 /* SegmentControl */
8075 typedef struct _Elm_Segment_Item Elm_Segment_Item;
8076 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8077 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
8078 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);
8079 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8080 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8081 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8082 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8083 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8084 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
8085 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8086 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
8087 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8088 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8089 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8090 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
8091 /* smart callbacks called:
8092 * "changed" -when the user clicks on a segment item which is not previously
8093 * selected and get selected. The event_info parameter is the
8094 * segment item index.
8097 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
8098 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
8099 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
8100 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
8101 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
8102 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
8103 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
8104 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
8106 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
8107 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
8109 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
8110 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
8111 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
8112 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
8113 EAPI void elm_video_play(Evas_Object *video);
8114 EAPI void elm_video_pause(Evas_Object *video);
8115 EAPI void elm_video_stop(Evas_Object *video);
8116 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
8117 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
8118 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
8119 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
8120 EAPI double elm_video_audio_level_get(Evas_Object *video);
8121 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
8122 EAPI double elm_video_play_position_get(Evas_Object *video);
8123 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
8124 EAPI double elm_video_play_length_get(Evas_Object *video);
8125 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
8126 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
8127 EAPI const char *elm_video_title_get(Evas_Object *video);
8129 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
8130 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
8132 // FIXME: incomplete - carousel. don't use this until this comment is removed
8133 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
8134 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
8135 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
8136 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
8137 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
8138 /* smart callbacks called:
8139 * "clicked" - when the user clicks on a carousel item and becomes selected
8144 typedef enum _Elm_Datefield_ItemType
8146 ELM_DATEFIELD_YEAR = 0,
8147 ELM_DATEFIELD_MONTH,
8150 ELM_DATEFIELD_MINUTE,
8152 } Elm_Datefield_ItemType;
8154 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
8155 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
8156 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
8157 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
8158 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8159 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
8160 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8161 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
8162 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8163 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8164 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
8165 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8166 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8168 /* smart callbacks called:
8169 * "changed" - when datefield value is changed, this signal is sent.
8172 ////////////////////// DEPRECATED ///////////////////////////////////
8174 typedef enum _Elm_Datefield_Layout
8176 ELM_DATEFIELD_LAYOUT_TIME,
8177 ELM_DATEFIELD_LAYOUT_DATE,
8178 ELM_DATEFIELD_LAYOUT_DATEANDTIME
8179 } Elm_Datefield_Layout;
8181 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
8182 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
8183 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
8184 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
8185 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
8186 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
8187 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
8188 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
8189 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
8190 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
8191 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
8192 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
8193 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);
8194 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
8195 /////////////////////////////////////////////////////////////////////
8198 typedef enum _Elm_Popup_Response
8200 ELM_POPUP_RESPONSE_NONE = -1,
8201 ELM_POPUP_RESPONSE_TIMEOUT = -2,
8202 ELM_POPUP_RESPONSE_OK = -3,
8203 ELM_POPUP_RESPONSE_CANCEL = -4,
8204 ELM_POPUP_RESPONSE_CLOSE = -5
8205 } Elm_Popup_Response;
8207 typedef enum _Elm_Popup_Mode
8209 ELM_POPUP_TYPE_NONE = 0,
8210 ELM_POPUP_TYPE_ALERT = (1 << 0)
8213 typedef enum _Elm_Popup_Orient
8215 ELM_POPUP_ORIENT_TOP,
8216 ELM_POPUP_ORIENT_CENTER,
8217 ELM_POPUP_ORIENT_BOTTOM,
8218 ELM_POPUP_ORIENT_LEFT,
8219 ELM_POPUP_ORIENT_RIGHT,
8220 ELM_POPUP_ORIENT_TOP_LEFT,
8221 ELM_POPUP_ORIENT_TOP_RIGHT,
8222 ELM_POPUP_ORIENT_BOTTOM_LEFT,
8223 ELM_POPUP_ORIENT_BOTTOM_RIGHT
8226 /* smart callbacks called:
8227 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
8230 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
8231 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
8232 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
8233 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
8234 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
8235 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
8236 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
8237 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
8238 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
8239 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
8240 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, ... );
8241 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
8242 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
8243 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
8244 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
8245 EAPI int elm_popup_run(Evas_Object *obj);
8248 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8249 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8253 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
8254 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
8255 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
8256 ELM_NAVIGATIONBAR_BACK_BUTTON
8257 } Elm_Navi_Button_Type;
8259 EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
8260 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);
8261 EAPI void elm_navigationbar_pop(Evas_Object *obj);
8262 EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
8263 EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
8264 EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
8265 EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
8266 EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
8267 EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
8268 EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
8269 EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
8270 EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
8271 EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
8272 EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
8273 EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
8274 EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
8275 EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
8276 EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
8277 EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
8278 Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
8279 EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
8280 EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
8283 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8284 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8288 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
8289 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
8290 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
8291 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
8292 ELM_NAVIGATIONBAR_EX_MAX
8293 } Elm_Navi_ex_Button_Type;
8294 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
8296 EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
8297 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
8298 EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
8299 EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
8300 EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
8301 EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
8302 EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
8303 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
8304 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
8305 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);
8306 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
8307 EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
8308 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
8309 EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
8310 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
8311 EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
8312 EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
8313 EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
8314 EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
8315 EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
8316 EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
8317 EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
8318 EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
8319 EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
8320 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
8321 EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
8322 EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
8323 Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
8326 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
8327 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
8328 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
8329 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
8330 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
8331 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
8332 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
8333 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
8334 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
8335 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
8338 * @defgroup Naviframe Naviframe
8340 * @brief Naviframe is a kind of view manager for the applications.
8342 * Naviframe provides functions to switch different pages with stack
8343 * mechanism. It means if one page(item) needs to be changed to the new one,
8344 * then naviframe would push the new page to it's internal stack. Of course,
8345 * it can be back to the previous page by popping the top page. Naviframe
8346 * provides some transition effect while the pages are switching (same as
8349 * Since each item could keep the different styles, users could keep the
8350 * same look & feel for the pages or different styles for the items in it's
8353 * Signals that you can add callback for are:
8355 * @li "transition,finished" - When the transition is finished in changing
8357 * @li "title,clicked" - User clicked title area
8359 * Default contents parts for the naviframe items that you can use for are:
8361 * @li "elm.swallow.content" - The main content of the page
8362 * @li "elm.swallow.prev_btn" - The button to go to the previous page
8363 * @li "elm.swallow.next_btn" - The button to go to the next page
8365 * Default text parts of naviframe items that you can be used are:
8367 * @li "elm.text.title" - The title label in the title area
8369 * @ref tutorial_naviframe gives a good overview of the usage of the API.
8373 * @brief Add a new Naviframe object to the parent.
8375 * @param parent Parent object
8376 * @return New object or @c NULL, if it cannot be created
8378 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8380 * @brief Push a new item to the top of the naviframe stack (and show it).
8382 * @param obj The naviframe object
8383 * @param title_label The label in the title area. The name of the title
8384 * label part is "elm.text.title"
8385 * @param prev_btn The button to go to the previous item. If it is NULL,
8386 * then naviframe will create a back button automatically. The name of
8387 * the prev_btn part is "elm.swallow.prev_btn"
8388 * @param next_btn The button to go to the next item. Or It could be just an
8389 * extra function button. The name of the next_btn part is
8390 * "elm.swallow.next_btn"
8391 * @param content The main content object. The name of content part is
8392 * "elm.swallow.content"
8393 * @param item_style The current item style name. @c NULL would be default.
8394 * @return The created item or @c NULL upon failure.
8396 * The item pushed becomes one page of the naviframe, this item will be
8397 * deleted when it is popped.
8399 * @see also elm_naviframe_item_style_set()
8401 * The following styles are available for this item:
8404 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);
8406 * @brief Pop an item that is on top of the stack
8408 * @param obj The naviframe object
8409 * @return @c NULL or the content object(if the
8410 * elm_naviframe_content_preserve_on_pop_get is true).
8412 * This pops an item that is on the top(visible) of the naviframe, makes it
8413 * disappear, then deletes the item. The item that was underneath it on the
8414 * stack will become visible.
8416 * @see also elm_naviframe_content_preserve_on_pop_get()
8418 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
8420 * @brief Pop the items between the top and the above one on the given item.
8422 * @param it The naviframe item
8424 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8426 * @brief Delete the given item instantly.
8428 * @param it The naviframe item
8430 * This just deletes the given item from the naviframe item list instantly.
8431 * So this would not emit any signals for view transitions but just change
8432 * the current view if the given item is a top one.
8435 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8437 * @brief preserve the content objects when items are popped.
8439 * @param obj The naviframe object
8440 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
8442 * @see also elm_naviframe_content_preserve_on_pop_get()
8444 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
8446 * @brief Get a value whether preserve mode is enabled or not.
8448 * @param obj The naviframe object
8449 * @return If @c EINA_TRUE, preserve mode is enabled
8451 * @see also elm_naviframe_content_preserve_on_pop_set()
8453 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8455 * @brief Get a top item on the naviframe stack
8457 * @param obj The naviframe object
8458 * @return The top item on the naviframe stack or @c NULL, if the stack is
8461 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8463 * @brief Get a bottom item on the naviframe stack
8465 * @param obj The naviframe object
8466 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
8469 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8471 * @brief Set an item style
8473 * @param obj The naviframe item
8474 * @param item_style The current item style name. @c NULL would be default
8476 * The following styles are available for this item:
8479 * @see also elm_naviframe_item_style_get()
8481 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
8483 * @brief Get an item style
8485 * @param obj The naviframe item
8486 * @return The current item style name
8488 * @see also elm_naviframe_item_style_set()
8490 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8492 * @brief Show/Hide the title area
8494 * @param it The naviframe item
8495 * @param visible If @c EINA_TRUE, title area will be visible, hidden
8498 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
8500 * @see also elm_naviframe_item_title_visible_get()
8502 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
8504 * @brief Get a value whether title area is visible or not.
8506 * @param it The naviframe item
8507 * @return If @c EINA_TRUE, title area is visible
8509 * @see also elm_naviframe_item_title_visible_set()
8511 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8513 * @brief Set creating prev button automatically or not
8515 * @param obj The naviframe object
8516 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
8517 * be created internally when you pass the @c NULL to the prev_btn
8518 * parameter in elm_naviframe_item_push
8520 * @see also elm_naviframe_item_push()
8522 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
8524 * @brief Get a value whether prev button(back button) will be auto pushed or
8527 * @param obj The naviframe object
8528 * @return If @c EINA_TRUE, prev button will be auto pushed.
8530 * @see also elm_naviframe_item_push()
8531 * elm_naviframe_prev_btn_auto_pushed_set()
8533 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
8536 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
8537 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
8538 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
8539 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
8540 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
8541 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
8542 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
8543 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
8544 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
8546 typedef enum _Elm_Controlbar_Mode_Type
8548 ELM_CONTROLBAR_MODE_DEFAULT = 0,
8549 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
8550 ELM_CONTROLBAR_MODE_TRANSPARENCY,
8551 ELM_CONTROLBAR_MODE_LARGE,
8552 ELM_CONTROLBAR_MODE_SMALL,
8553 ELM_CONTROLBAR_MODE_LEFT,
8554 ELM_CONTROLBAR_MODE_RIGHT
8555 } Elm_Controlbar_Mode_Type;
8557 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
8558 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
8559 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8560 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8561 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);
8562 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);
8563 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);
8564 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);
8565 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);
8566 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);
8567 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8568 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8569 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
8570 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
8571 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
8572 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
8573 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
8574 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
8575 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
8576 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
8577 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
8578 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
8579 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
8580 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
8581 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
8582 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
8583 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
8584 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
8585 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
8586 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
8587 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
8588 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
8589 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
8590 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
8591 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
8592 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
8593 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
8594 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
8595 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
8598 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
8599 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
8600 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
8601 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
8602 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
8603 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
8604 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
8605 EAPI void elm_searchbar_clear(Evas_Object *obj);
8606 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
8608 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
8609 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
8610 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
8611 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
8614 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
8615 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
8616 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
8617 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
8618 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
8623 ELM_TICKERNOTI_ORIENT_TOP = 0,
8624 ELM_TICKERNOTI_ORIENT_BOTTOM,
8625 ELM_TICKERNOTI_ORIENT_LAST
8626 } Elm_Tickernoti_Orient;
8628 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
8629 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
8630 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8631 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8632 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
8633 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8634 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
8637 ELM_TICKERNOTI_DEFAULT,
8638 ELM_TICKERNOTI_DETAILVIEW
8639 } Elm_Tickernoti_Mode;
8640 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8641 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
8642 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
8643 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8644 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8645 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8646 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8647 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
8648 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8649 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
8650 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8651 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8652 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8653 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8654 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8655 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
8656 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8657 /* ############################################################################### */
8659 * Parts which can be used with elm_object_text_part_set() and
8660 * elm_object_text_part_get():
8662 * @li NULL/"default" - Operates on tickernoti content-text
8664 * Parts which can be used with elm_object_content_part_set() and
8665 * elm_object_content_part_get():
8667 * @li "icon" - Operates on tickernoti's icon
8668 * @li "button" - Operates on tickernoti's button
8670 * smart callbacks called:
8671 * @li "clicked" - emitted when tickernoti is clicked, except at the
8672 * swallow/button region, if any.
8673 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
8674 * any hide animation, this signal is emitted after the animation.
8678 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
8680 struct _Colorpalette_Color
8682 unsigned int r, g, b;
8685 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
8686 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
8687 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
8688 /* smart callbacks called:
8689 * "clicked" - when image clicked
8693 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
8694 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
8695 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
8696 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
8697 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
8698 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
8699 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
8700 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
8701 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
8702 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
8703 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
8704 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
8705 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
8706 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
8707 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
8708 /* smart callbacks called:
8709 * "clicked" - when an editfield is clicked
8710 * "unfocused" - when an editfield is unfocused
8714 /* Sliding Drawer */
8715 typedef enum _Elm_SlidingDrawer_Pos
8717 ELM_SLIDINGDRAWER_BOTTOM,
8718 ELM_SLIDINGDRAWER_LEFT,
8719 ELM_SLIDINGDRAWER_RIGHT,
8720 ELM_SLIDINGDRAWER_TOP
8721 } Elm_SlidingDrawer_Pos;
8723 typedef struct _Elm_SlidingDrawer_Drag_Value
8726 } Elm_SlidingDrawer_Drag_Value;
8728 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
8729 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
8730 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
8731 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
8732 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
8733 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
8735 /* multibuttonentry */
8736 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
8737 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
8738 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
8739 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
8740 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
8741 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
8742 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
8743 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
8744 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
8745 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
8746 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
8747 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
8748 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
8749 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
8750 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
8751 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
8752 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
8753 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
8754 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
8755 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
8756 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
8757 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
8758 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
8759 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
8760 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
8761 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
8762 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
8763 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
8764 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
8765 /* smart callback called:
8766 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
8767 * "added" - This signal is emitted when a new multibuttonentry item is added.
8768 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
8769 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
8770 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
8771 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
8772 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
8773 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
8774 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
8775 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
8776 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
8777 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
8779 /* available styles:
8784 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
8785 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
8786 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
8787 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
8788 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
8789 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
8790 /* smart callback called:
8791 * "expanded" - This signal is emitted when a stackedicon is expanded.
8792 * "clicked" - This signal is emitted when a stackedicon is clicked.
8794 /* available styles:
8799 typedef struct _Dialogue_Item Dialogue_Item;
8801 typedef enum _Elm_Dialoguegourp_Item_Style
8803 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
8804 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
8805 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
8806 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
8807 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
8808 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
8809 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
8810 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
8811 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
8812 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
8813 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
8814 } Elm_Dialoguegroup_Item_Style;
8816 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
8817 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
8818 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
8819 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
8820 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
8821 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
8822 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
8823 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
8824 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
8825 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
8826 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
8827 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
8828 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
8829 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
8830 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
8831 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
8836 ELM_DAYSELECTOR_SUN,
8837 ELM_DAYSELECTOR_MON,
8838 ELM_DAYSELECTOR_TUE,
8839 ELM_DAYSELECTOR_WED,
8840 ELM_DAYSELECTOR_THU,
8841 ELM_DAYSELECTOR_FRI,
8843 } Elm_DaySelector_Day;
8845 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
8846 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
8847 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
8850 typedef struct _Imageslider_Item Elm_Imageslider_Item;
8851 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
8852 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8853 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);
8854 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);
8855 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);
8856 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8857 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8858 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8859 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8860 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8861 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8862 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8863 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8864 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8865 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
8866 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);