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 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
333 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
334 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
335 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
336 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
337 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
338 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
339 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
340 ELM_INPUT_PANEL_LAYOUT_INVALID
341 } Elm_Input_Panel_Layout;
345 ELM_AUTOCAPITAL_TYPE_NONE,
346 ELM_AUTOCAPITAL_TYPE_WORD,
347 ELM_AUTOCAPITAL_TYPE_SENTENCE,
348 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
349 } Elm_Autocapital_Type;
352 * @typedef Elm_Object_Item
353 * An Elementary Object item handle.
356 typedef struct _Elm_Object_Item Elm_Object_Item;
360 * Called back when a widget's tooltip is activated and needs content.
361 * @param data user-data given to elm_object_tooltip_content_cb_set()
362 * @param obj owner widget.
364 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
367 * Called back when a widget's item tooltip is activated and needs content.
368 * @param data user-data given to elm_object_tooltip_content_cb_set()
369 * @param obj owner widget.
370 * @param item context dependent item. As an example, if tooltip was
371 * set on Elm_List_Item, then it is of this type.
373 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
375 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
377 #ifndef ELM_LIB_QUICKLAUNCH
378 #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 */
380 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
383 /**************************************************************************/
387 * Initialize Elementary
389 * @param[in] argc System's argument count value
390 * @param[in] argv System's pointer to array of argument strings
391 * @return The init counter value.
393 * This function initializes Elementary and increments a counter of
394 * the number of calls to it. It returs the new counter's value.
396 * @warning This call is exported only for use by the @c ELM_MAIN()
397 * macro. There is no need to use this if you use this macro (which
398 * is highly advisable). An elm_main() should contain the entry
399 * point code for your application, having the same prototype as
400 * elm_init(), and @b not being static (putting the @c EAPI symbol
401 * in front of its type declaration is advisable). The @c
402 * ELM_MAIN() call should be placed just after it.
405 * @dontinclude bg_example_01.c
409 * See the full @ref bg_example_01_c "example".
411 * @see elm_shutdown().
414 EAPI int elm_init(int argc, char **argv);
417 * Shut down Elementary
419 * @return The init counter value.
421 * This should be called at the end of your application, just
422 * before it ceases to do any more processing. This will clean up
423 * any permanent resources your application may have allocated via
424 * Elementary that would otherwise persist.
426 * @see elm_init() for an example
430 EAPI int elm_shutdown(void);
433 * Run Elementary's main loop
435 * This call should be issued just after all initialization is
436 * completed. This function will not return until elm_exit() is
437 * called. It will keep looping, running the main
438 * (event/processing) loop for Elementary.
440 * @see elm_init() for an example
444 EAPI void elm_run(void);
447 * Exit Elementary's main loop
449 * If this call is issued, it will flag the main loop to cease
450 * processing and return back to its parent function (usually your
451 * elm_main() function).
453 * @see elm_init() for an example. There, just after a request to
454 * close the window comes, the main loop will be left.
456 * @note By using the #ELM_POLICY_QUIT on your Elementary
457 * applications, you'll this function called automatically for you.
461 EAPI void elm_exit(void);
464 * Provide information in order to make Elementary determine the @b
465 * run time location of the software in question, so other data files
466 * such as images, sound files, executable utilities, libraries,
467 * modules and locale files can be found.
469 * @param mainfunc This is your application's main function name,
470 * whose binary's location is to be found. Providing @c NULL
471 * will make Elementary not to use it
472 * @param dom This will be used as the application's "domain", in the
473 * form of a prefix to any environment variables that may
474 * override prefix detection and the directory name, inside the
475 * standard share or data directories, where the software's
476 * data files will be looked for.
477 * @param checkfile This is an (optional) magic file's path to check
478 * for existence (and it must be located in the data directory,
479 * under the share directory provided above). Its presence will
480 * help determine the prefix found was correct. Pass @c NULL if
481 * the check is not to be done.
483 * This function allows one to re-locate the application somewhere
484 * else after compilation, if the developer wishes for easier
485 * distribution of pre-compiled binaries.
487 * The prefix system is designed to locate where the given software is
488 * installed (under a common path prefix) at run time and then report
489 * specific locations of this prefix and common directories inside
490 * this prefix like the binary, library, data and locale directories,
491 * through the @c elm_app_*_get() family of functions.
493 * Call elm_app_info_set() early on before you change working
494 * directory or anything about @c argv[0], so it gets accurate
497 * It will then try and trace back which file @p mainfunc comes from,
498 * if provided, to determine the application's prefix directory.
500 * The @p dom parameter provides a string prefix to prepend before
501 * environment variables, allowing a fallback to @b specific
502 * environment variables to locate the software. You would most
503 * probably provide a lowercase string there, because it will also
504 * serve as directory domain, explained next. For environment
505 * variables purposes, this string is made uppercase. For example if
506 * @c "myapp" is provided as the prefix, then the program would expect
507 * @c "MYAPP_PREFIX" as a master environment variable to specify the
508 * exact install prefix for the software, or more specific environment
509 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
510 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
511 * the user or scripts before launching. If not provided (@c NULL),
512 * environment variables will not be used to override compiled-in
513 * defaults or auto detections.
515 * The @p dom string also provides a subdirectory inside the system
516 * shared data directory for data files. For example, if the system
517 * directory is @c /usr/local/share, then this directory name is
518 * appended, creating @c /usr/local/share/myapp, if it @p was @c
519 * "myapp". It is expected the application installs data files in
522 * The @p checkfile is a file name or path of something inside the
523 * share or data directory to be used to test that the prefix
524 * detection worked. For example, your app will install a wallpaper
525 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
526 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
529 * @see elm_app_compile_bin_dir_set()
530 * @see elm_app_compile_lib_dir_set()
531 * @see elm_app_compile_data_dir_set()
532 * @see elm_app_compile_locale_set()
533 * @see elm_app_prefix_dir_get()
534 * @see elm_app_bin_dir_get()
535 * @see elm_app_lib_dir_get()
536 * @see elm_app_data_dir_get()
537 * @see elm_app_locale_dir_get()
539 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
542 * Provide information on the @b fallback application's binaries
543 * directory, on scenarios where they get overriden by
544 * elm_app_info_set().
546 * @param dir The path to the default binaries directory (compile time
549 * @note Elementary will as well use this path to determine actual
550 * names of binaries' directory paths, maybe changing it to be @c
551 * something/local/bin instead of @c something/bin, only, for
554 * @warning You should call this function @b before
555 * elm_app_info_set().
557 EAPI void elm_app_compile_bin_dir_set(const char *dir);
560 * Provide information on the @b fallback application's libraries
561 * directory, on scenarios where they get overriden by
562 * elm_app_info_set().
564 * @param dir The path to the default libraries directory (compile
567 * @note Elementary will as well use this path to determine actual
568 * names of libraries' directory paths, maybe changing it to be @c
569 * something/lib32 or @c something/lib64 instead of @c something/lib,
572 * @warning You should call this function @b before
573 * elm_app_info_set().
575 EAPI void elm_app_compile_lib_dir_set(const char *dir);
578 * Provide information on the @b fallback application's data
579 * directory, on scenarios where they get overriden by
580 * elm_app_info_set().
582 * @param dir The path to the default data directory (compile time
585 * @note Elementary will as well use this path to determine actual
586 * names of data directory paths, maybe changing it to be @c
587 * something/local/share instead of @c something/share, only, for
590 * @warning You should call this function @b before
591 * elm_app_info_set().
593 EAPI void elm_app_compile_data_dir_set(const char *dir);
596 * Provide information on the @b fallback application's locale
597 * directory, on scenarios where they get overriden by
598 * elm_app_info_set().
600 * @param dir The path to the default locale directory (compile time
603 * @warning You should call this function @b before
604 * elm_app_info_set().
606 EAPI void elm_app_compile_locale_set(const char *dir);
609 * Retrieve the application's run time prefix directory, as set by
610 * elm_app_info_set() and the way (environment) the application was
613 * @return The directory prefix the application is actually using
615 EAPI const char *elm_app_prefix_dir_get(void);
618 * Retrieve the application's run time binaries prefix directory, as
619 * set by elm_app_info_set() and the way (environment) the application
622 * @return The binaries directory prefix the application is actually
625 EAPI const char *elm_app_bin_dir_get(void);
628 * Retrieve the application's run time libraries prefix directory, as
629 * set by elm_app_info_set() and the way (environment) the application
632 * @return The libraries directory prefix the application is actually
635 EAPI const char *elm_app_lib_dir_get(void);
638 * Retrieve the application's run time data prefix directory, as
639 * set by elm_app_info_set() and the way (environment) the application
642 * @return The data directory prefix the application is actually
645 EAPI const char *elm_app_data_dir_get(void);
648 * Retrieve the application's run time locale prefix directory, as
649 * set by elm_app_info_set() and the way (environment) the application
652 * @return The locale directory prefix the application is actually
655 EAPI const char *elm_app_locale_dir_get(void);
657 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
658 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
659 EAPI int elm_quicklaunch_init(int argc, char **argv);
660 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
661 EAPI int elm_quicklaunch_sub_shutdown(void);
662 EAPI int elm_quicklaunch_shutdown(void);
663 EAPI void elm_quicklaunch_seed(void);
664 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
665 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
666 EAPI void elm_quicklaunch_cleanup(void);
667 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
668 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
670 EAPI Eina_Bool elm_need_efreet(void);
671 EAPI Eina_Bool elm_need_e_dbus(void);
672 EAPI Eina_Bool elm_need_ethumb(void);
675 * Set a new policy's value (for a given policy group/identifier).
677 * @param policy policy identifier, as in @ref Elm_Policy.
678 * @param value policy value, which depends on the identifier
680 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
682 * Elementary policies define applications' behavior,
683 * somehow. These behaviors are divided in policy groups (see
684 * #Elm_Policy enumeration). This call will emit the Ecore event
685 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
686 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
689 * @note Currently, we have only one policy identifier/group
690 * (#ELM_POLICY_QUIT), which has two possible values.
694 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
697 * Gets the policy value set for given policy identifier.
699 * @param policy policy identifier, as in #Elm_Policy.
700 * @return The currently set policy value, for that
701 * identifier. Will be @c 0 if @p policy passed is invalid.
705 EAPI int elm_policy_get(unsigned int policy);
708 * Set a label of an object
710 * @param obj The Elementary object
711 * @param part The text part name to set (NULL for the default label)
712 * @param label The new text of the label
714 * @note Elementary objects may have many labels (e.g. Action Slider)
718 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
720 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
723 * Get a label of an object
725 * @param obj The Elementary object
726 * @param part The text part name to get (NULL for the default label)
727 * @return text of the label or NULL for any error
729 * @note Elementary objects may have many labels (e.g. Action Slider)
733 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
735 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
738 * Set a content of an object
740 * @param obj The Elementary object
741 * @param part The content part name to set (NULL for the default content)
742 * @param content The new content of the object
744 * @note Elementary objects may have many contents
748 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
750 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
753 * Get a content of an object
755 * @param obj The Elementary object
756 * @param item The content part name to get (NULL for the default content)
757 * @return content of the object or NULL for any error
759 * @note Elementary objects may have many contents
763 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
765 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
768 * Unset a content of an object
770 * @param obj The Elementary object
771 * @param item The content part name to unset (NULL for the default content)
773 * @note Elementary objects may have many contents
777 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
779 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
782 * Set a content of an object item
784 * @param it The Elementary object item
785 * @param part The content part name to set (NULL for the default content)
786 * @param content The new content of the object item
788 * @note Elementary object items may have many contents
792 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
794 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
797 * Get a content of an object item
799 * @param it The Elementary object item
800 * @param part The content part name to unset (NULL for the default content)
801 * @return content of the object item or NULL for any error
803 * @note Elementary object items may have many contents
807 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
809 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
812 * Unset a content of an object item
814 * @param it The Elementary object item
815 * @param part The content part name to unset (NULL for the default content)
817 * @note Elementary object items may have many contents
821 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
823 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
826 * Set a label of an objec itemt
828 * @param it The Elementary object item
829 * @param part The text part name to set (NULL for the default label)
830 * @param label The new text of the label
832 * @note Elementary object items may have many labels
836 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
838 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
841 * Get a label of an object
843 * @param it The Elementary object item
844 * @param part The text part name to get (NULL for the default label)
845 * @return text of the label or NULL for any error
847 * @note Elementary object items may have many labels
851 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
854 * Set the text to read out when in accessibility mode
856 * @param obj The object which is to be described
857 * @param txt The text that describes the widget to people with poor or no vision
861 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
864 * Set the text to read out when in accessibility mode
866 * @param it The object item which is to be described
867 * @param txt The text that describes the widget to people with poor or no vision
871 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
874 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
877 * Get the data associated with an object item
878 * @param it The object item
879 * @return The data associated with @p it
883 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
886 * Set the data associated with an object item
887 * @param it The object item
888 * @param data The data to be associated with @p it
892 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
895 * Send a signal to the edje object of the widget item.
897 * This function sends a signal to the edje object of the obj item. An
898 * edje program can respond to a signal by specifying matching
899 * 'signal' and 'source' fields.
901 * @param it The Elementary object item
902 * @param emission The signal's name.
903 * @param source The signal's source.
906 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
912 EAPI void elm_all_flush(void);
913 EAPI int elm_cache_flush_interval_get(void);
914 EAPI void elm_cache_flush_interval_set(int size);
915 EAPI void elm_cache_flush_interval_all_set(int size);
916 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
917 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
918 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
919 EAPI int elm_font_cache_get(void);
920 EAPI void elm_font_cache_set(int size);
921 EAPI void elm_font_cache_all_set(int size);
922 EAPI int elm_image_cache_get(void);
923 EAPI void elm_image_cache_set(int size);
924 EAPI void elm_image_cache_all_set(int size);
925 EAPI int elm_edje_file_cache_get(void);
926 EAPI void elm_edje_file_cache_set(int size);
927 EAPI void elm_edje_file_cache_all_set(int size);
928 EAPI int elm_edje_collection_cache_get(void);
929 EAPI void elm_edje_collection_cache_set(int size);
930 EAPI void elm_edje_collection_cache_all_set(int size);
933 * @defgroup Scaling Selective Widget Scaling
935 * Different widgets can be scaled independently. These functions
936 * allow you to manipulate this scaling on a per-widget basis. The
937 * object and all its children get their scaling factors multiplied
938 * by the scale factor set. This is multiplicative, in that if a
939 * child also has a scale size set it is in turn multiplied by its
940 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
941 * double size, @c 0.5 is half, etc.
943 * @ref general_functions_example_page "This" example contemplates
944 * some of these functions.
948 * Set the scaling factor for a given Elementary object
950 * @param obj The Elementary to operate on
951 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
956 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
959 * Get the scaling factor for a given Elementary object
961 * @param obj The object
962 * @return The scaling factor set by elm_object_scale_set()
966 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
969 * @defgroup Password_last_show Password last input show
971 * Last show feature of password mode enables user to view
972 * the last input entered for few seconds before masking it.
973 * These functions allow to set this feature in password mode
974 * of entry widget and also allow to manipulate the duration
975 * for which the input has to be visible.
981 * Get show last setting of password mode.
983 * This gets the show last input setting of password mode which might be
984 * enabled or disabled.
986 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
988 * @ingroup Password_last_show
990 EAPI Eina_Bool elm_password_show_last_get(void);
993 * Set show last setting in password mode.
995 * This enables or disables show last setting of password mode.
997 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
998 * @see elm_password_show_last_timeout_set()
999 * @ingroup Password_last_show
1001 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1004 * Get's the timeout value in last show password mode.
1006 * This gets the time out value for which the last input entered in password
1007 * mode will be visible.
1009 * @return The timeout value of last show password mode.
1010 * @ingroup Password_last_show
1012 EAPI double elm_password_show_last_timeout_get(void);
1015 * Set's the timeout value in last show password mode.
1017 * This sets the time out value for which the last input entered in password
1018 * mode will be visible.
1020 * @param password_show_last_timeout The timeout value.
1021 * @see elm_password_show_last_set()
1022 * @ingroup Password_last_show
1024 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1030 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1031 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1032 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1033 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1035 * Set the style to use by a widget
1037 * Sets the style name that will define the appearance of a widget. Styles
1038 * vary from widget to widget and may also be defined by other themes
1039 * by means of extensions and overlays.
1041 * @param obj The Elementary widget to style
1042 * @param style The style name to use
1044 * @see elm_theme_extension_add()
1045 * @see elm_theme_overlay_add()
1049 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1051 * Get the style used by the widget
1053 * This gets the style being used for that widget. Note that the string
1054 * pointer is only valid as longas the object is valid and the style doesn't
1057 * @param obj The Elementary widget to query for its style
1058 * @return The style name used
1060 * @see elm_object_style_set()
1064 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1067 * @defgroup Styles Styles
1069 * Widgets can have different styles of look. These generic API's
1070 * set styles of widgets, if they support them (and if the theme(s)
1073 * @ref general_functions_example_page "This" example contemplates
1074 * some of these functions.
1078 * Set the disabled state of an Elementary object.
1080 * @param obj The Elementary object to operate on
1081 * @param disabled The state to put in in: @c EINA_TRUE for
1082 * disabled, @c EINA_FALSE for enabled
1084 * Elementary objects can be @b disabled, in which state they won't
1085 * receive input and, in general, will be themed differently from
1086 * their normal state, usually greyed out. Useful for contexts
1087 * where you don't want your users to interact with some of the
1088 * parts of you interface.
1090 * This sets the state for the widget, either disabling it or
1095 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1098 * Get the disabled state of an Elementary object.
1100 * @param obj The Elementary object to operate on
1101 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1102 * if it's enabled (or on errors)
1104 * This gets the state of the widget, which might be enabled or disabled.
1108 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1111 * @defgroup WidgetNavigation Widget Tree Navigation.
1113 * How to check if an Evas Object is an Elementary widget? How to
1114 * get the first elementary widget that is parent of the given
1115 * object? These are all covered in widget tree navigation.
1117 * @ref general_functions_example_page "This" example contemplates
1118 * some of these functions.
1121 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1124 * Get the first parent of the given object that is an Elementary
1127 * @param obj the Elementary object to query parent from.
1128 * @return the parent object that is an Elementary widget, or @c
1129 * NULL, if it was not found.
1131 * Use this to query for an object's parent widget.
1133 * @note Most of Elementary users wouldn't be mixing non-Elementary
1134 * smart objects in the objects tree of an application, as this is
1135 * an advanced usage of Elementary with Evas. So, except for the
1136 * application's window, which is the root of that tree, all other
1137 * objects would have valid Elementary widget parents.
1139 * @ingroup WidgetNavigation
1141 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1142 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1143 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1145 EAPI double elm_scale_get(void);
1146 EAPI void elm_scale_set(double scale);
1147 EAPI void elm_scale_all_set(double scale);
1149 EAPI Eina_Bool elm_mirrored_get(void);
1150 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1152 EAPI Eina_Bool elm_config_save(void);
1153 EAPI void elm_config_reload(void);
1155 EAPI const char *elm_profile_current_get(void);
1156 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1157 EAPI void elm_profile_dir_free(const char *p_dir);
1158 EAPI Eina_List *elm_profile_list_get(void);
1159 EAPI void elm_profile_list_free(Eina_List *l);
1160 EAPI void elm_profile_set(const char *profile);
1161 EAPI void elm_profile_all_set(const char *profile);
1163 EAPI const char *elm_engine_current_get(void);
1164 EAPI void elm_engine_set(const char *engine);
1166 typedef struct _Elm_Text_Class
1172 typedef struct _Elm_Font_Overlay
1174 const char *text_class;
1176 Evas_Font_Size size;
1179 typedef struct _Elm_Font_Properties
1183 } Elm_Font_Properties;
1185 EAPI const Eina_List *elm_text_classes_list_get(void);
1186 EAPI void elm_text_classes_list_free(const Eina_List *list);
1188 EAPI const Eina_List *elm_font_overlay_list_get(void);
1189 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1190 EAPI void elm_font_overlay_unset(const char *text_class);
1191 EAPI void elm_font_overlay_apply(void);
1192 EAPI void elm_font_overlay_all_apply(void);
1194 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1195 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1196 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1197 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1198 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1199 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1202 * @defgroup Fingers Fingers
1204 * Elementary is designed to be finger-friendly for touchscreens,
1205 * and so in addition to scaling for display resolution, it can
1206 * also scale based on finger "resolution" (or size). You can then
1207 * customize the granularity of the areas meant to receive clicks
1210 * Different profiles may have pre-set values for finger sizes.
1212 * @ref general_functions_example_page "This" example contemplates
1213 * some of these functions.
1217 * Get the configured "finger size"
1219 * @return The finger size
1221 * This gets the globally configured finger size, <b>in pixels</b>
1225 EAPI Evas_Coord elm_finger_size_get(void);
1226 EAPI void elm_finger_size_set(Evas_Coord size);
1227 EAPI void elm_finger_size_all_set(Evas_Coord size);
1230 * @defgroup Focus Focus
1232 * An Elementary application has, at all times, one (and only one)
1233 * @b focused object. This is what determines where the input
1234 * events go to within the application's window. Also, focused
1235 * objects can be decorated differently, in order to signal to the
1236 * user where the input is, at a given moment.
1238 * Elementary applications also have the concept of <b>focus
1239 * chain</b>: one can cycle through all the windows' focusable
1240 * objects by input (tab key) or programmatically. The default
1241 * focus chain for an application is the one define by the order in
1242 * which the widgets where added in code. One will cycle through
1243 * top level widgets, and, for each one containg sub-objects, cycle
1244 * through them all, before returning to the level
1245 * above. Elementary also allows one to set @b custom focus chains
1246 * for their applications.
1248 * Besides the focused decoration a widget may exhibit, when it
1249 * gets focus, Elementary has a @b global focus highlight object
1250 * that can be enabled for a window. If one chooses to do so, this
1251 * extra highlight effect will surround the current focused object,
1254 * @note Some Elementary widgets are @b unfocusable, after
1255 * creation, by their very nature: they are not meant to be
1256 * interacted with input events, but are there just for visual
1259 * @ref general_functions_example_page "This" example contemplates
1260 * some of these functions.
1263 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1264 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1265 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1266 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1269 * Get the whether an Elementary object has the focus or not.
1271 * @param obj The Elementary object to get the information from
1272 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1273 * not (and on errors).
1275 * @see elm_object_focus()
1279 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1282 * Make a given Elementary object the focused one.
1284 * @param obj The Elementary object to make focused.
1286 * @note This object, if it can handle focus, will take the focus
1287 * away from the one who had it previously and will, for now on, be
1288 * the one receiving input events.
1290 * @see elm_object_focus_get()
1294 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1297 * Remove the focus from an Elementary object
1299 * @param obj The Elementary to take focus from
1301 * This removes the focus from @p obj, passing it back to the
1302 * previous element in the focus chain list.
1304 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1308 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1311 * Set the ability for an Element object to be focused
1313 * @param obj The Elementary object to operate on
1314 * @param enable @c EINA_TRUE if the object can be focused, @c
1315 * EINA_FALSE if not (and on errors)
1317 * This sets whether the object @p obj is able to take focus or
1318 * not. Unfocusable objects do nothing when programmatically
1319 * focused, being the nearest focusable parent object the one
1320 * really getting focus. Also, when they receive mouse input, they
1321 * will get the event, but not take away the focus from where it
1326 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1329 * Get whether an Elementary object is focusable or not
1331 * @param obj The Elementary object to operate on
1332 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1333 * EINA_FALSE if not (and on errors)
1335 * @note Objects which are meant to be interacted with by input
1336 * events are created able to be focused, by default. All the
1341 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1343 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1344 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1345 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1346 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1347 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1348 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1349 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1352 * Make the elementary object and its children to be unfocusable (or focusable).
1354 * @param obj The Elementary object to operate on
1355 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1356 * @c EINA_FALSE for focusable.
1358 * This sets whether the object @p obj and its children objects
1359 * able to take focus or not. If the tree is unfocusable,
1360 * newest focused object which is not in this tree will get focus.
1361 * This API can be helpful for an object to be deleted.
1362 * When an object will be deleted soon, it and its children may not
1363 * want to get focus (by focus reverting or by other focus controls).
1364 * Then, just use this API before deleting.
1366 * @see elm_object_tree_unfocusable_get()
1370 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1373 * Get whether an Elementary object and its children are unfocusable or not.
1375 * @param obj The Elementary object to get the information from
1376 * @return @c EINA_TRUE, if the tree is unfocussable,
1377 * @c EINA_FALSE if not (and on errors).
1379 * @see elm_object_tree_unfocusable_set()
1383 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1385 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1386 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1387 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1388 EAPI double elm_scroll_bounce_friction_get(void);
1389 EAPI void elm_scroll_bounce_friction_set(double friction);
1390 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1391 EAPI double elm_scroll_page_scroll_friction_get(void);
1392 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1393 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1394 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1395 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1396 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1397 EAPI double elm_scroll_zoom_friction_get(void);
1398 EAPI void elm_scroll_zoom_friction_set(double friction);
1399 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1400 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1401 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1402 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1403 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1404 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1405 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1406 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1407 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1408 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1409 EAPI double elm_scroll_thumbscroll_friction_get(void);
1410 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1411 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1412 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1413 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1414 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1417 * Get the sensitivity amount which is be multiplied by the length of
1420 * @return the thumb scroll sensitivity friction
1422 * @ingroup Scrolling
1424 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
1427 * Set the sensitivity amount which is be multiplied by the length of
1430 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
1431 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
1434 * @see elm_thumbscroll_sensitivity_friction_get()
1435 * @note parameter value will get bound to 0.1 - 1.0 interval, always
1437 * @ingroup Scrolling
1439 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
1442 * Set the sensitivity amount which is be multiplied by the length of
1443 * mouse dragging, for all Elementary application windows.
1445 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
1446 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
1449 * @see elm_thumbscroll_sensitivity_friction_get()
1450 * @note parameter value will get bound to 0.1 - 1.0 interval, always
1452 * @ingroup Scrolling
1454 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
1460 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1461 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1462 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1463 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1464 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1465 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1466 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1467 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1469 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1470 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);
1471 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);
1473 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1474 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1477 * Adjust size of an element for finger usage.
1479 * @param times_w How many fingers should fit horizontally
1480 * @param w Pointer to the width size to adjust
1481 * @param times_h How many fingers should fit vertically
1482 * @param h Pointer to the height size to adjust
1484 * This takes width and height sizes (in pixels) as input and a
1485 * size multiple (which is how many fingers you want to place
1486 * within the area, being "finger" the size set by
1487 * elm_finger_size_set()), and adjusts the size to be large enough
1488 * to accommodate the resulting size -- if it doesn't already
1489 * accommodate it. On return the @p w and @p h sizes pointed to by
1490 * these parameters will be modified, on those conditions.
1492 * @note This is kind of a low level Elementary call, most useful
1493 * on size evaluation times for widgets. An external user wouldn't
1494 * be calling, most of the time.
1498 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1500 EAPI double elm_longpress_timeout_get(void);
1501 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1504 * don't use it unless you are sure
1506 EAPI void elm_object_tree_dump(const Evas_Object *top);
1507 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1509 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
1510 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
1515 * @defgroup Theme Theme
1517 * Elementary uses Edje to theme its widgets, naturally. But for the most
1518 * part this is hidden behind a simpler interface that lets the user set
1519 * extensions and choose the style of widgets in a much easier way.
1521 * Instead of thinking in terms of paths to Edje files and their groups
1522 * each time you want to change the appearance of a widget, Elementary
1523 * works so you can add any theme file with extensions or replace the
1524 * main theme at one point in the application, and then just set the style
1525 * of widgets with elm_object_style_set() and related functions. Elementary
1526 * will then look in its list of themes for a matching group and apply it,
1527 * and when the theme changes midway through the application, all widgets
1528 * will be updated accordingly.
1530 * There are three concepts you need to know to understand how Elementary
1531 * theming works: default theme, extensions and overlays.
1533 * Default theme, obviously enough, is the one that provides the default
1534 * look of all widgets. End users can change the theme used by Elementary
1535 * by setting the @c ELM_THEME environment variable before running an
1536 * application, or globally for all programs using the @c elementary_config
1537 * utility. Applications can change the default theme using elm_theme_set(),
1538 * but this can go against the user wishes, so it's not an adviced practice.
1540 * Ideally, applications should find everything they need in the already
1541 * provided theme, but there may be occasions when that's not enough and
1542 * custom styles are required to correctly express the idea. For this
1543 * cases, Elementary has extensions.
1545 * Extensions allow the application developer to write styles of its own
1546 * to apply to some widgets. This requires knowledge of how each widget
1547 * is themed, as extensions will always replace the entire group used by
1548 * the widget, so important signals and parts need to be there for the
1549 * object to behave properly (see documentation of Edje for details).
1550 * Once the theme for the extension is done, the application needs to add
1551 * it to the list of themes Elementary will look into, using
1552 * elm_theme_extension_add(), and set the style of the desired widgets as
1553 * he would normally with elm_object_style_set().
1555 * Overlays, on the other hand, can replace the look of all widgets by
1556 * overriding the default style. Like extensions, it's up to the application
1557 * developer to write the theme for the widgets it wants, the difference
1558 * being that when looking for the theme, Elementary will check first the
1559 * list of overlays, then the set theme and lastly the list of extensions,
1560 * so with overlays it's possible to replace the default view and every
1561 * widget will be affected. This is very much alike to setting the whole
1562 * theme for the application and will probably clash with the end user
1563 * options, not to mention the risk of ending up with not matching styles
1564 * across the program. Unless there's a very special reason to use them,
1565 * overlays should be avoided for the resons exposed before.
1567 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1568 * keeps one default internally and every function that receives one of
1569 * these can be called with NULL to refer to this default (except for
1570 * elm_theme_free()). It's possible to create a new instance of a
1571 * ::Elm_Theme to set other theme for a specific widget (and all of its
1572 * children), but this is as discouraged, if not even more so, than using
1573 * overlays. Don't use this unless you really know what you are doing.
1575 * But to be less negative about things, you can look at the following
1577 * @li @ref theme_example_01 "Using extensions"
1578 * @li @ref theme_example_02 "Using overlays"
1583 * @typedef Elm_Theme
1585 * Opaque handler for the list of themes Elementary looks for when
1586 * rendering widgets.
1588 * Stay out of this unless you really know what you are doing. For most
1589 * cases, sticking to the default is all a developer needs.
1591 typedef struct _Elm_Theme Elm_Theme;
1594 * Create a new specific theme
1596 * This creates an empty specific theme that only uses the default theme. A
1597 * specific theme has its own private set of extensions and overlays too
1598 * (which are empty by default). Specific themes do not fall back to themes
1599 * of parent objects. They are not intended for this use. Use styles, overlays
1600 * and extensions when needed, but avoid specific themes unless there is no
1601 * other way (example: you want to have a preview of a new theme you are
1602 * selecting in a "theme selector" window. The preview is inside a scroller
1603 * and should display what the theme you selected will look like, but not
1604 * actually apply it yet. The child of the scroller will have a specific
1605 * theme set to show this preview before the user decides to apply it to all
1608 EAPI Elm_Theme *elm_theme_new(void);
1610 * Free a specific theme
1612 * @param th The theme to free
1614 * This frees a theme created with elm_theme_new().
1616 EAPI void elm_theme_free(Elm_Theme *th);
1618 * Copy the theme fom the source to the destination theme
1620 * @param th The source theme to copy from
1621 * @param thdst The destination theme to copy data to
1623 * This makes a one-time static copy of all the theme config, extensions
1624 * and overlays from @p th to @p thdst. If @p th references a theme, then
1625 * @p thdst is also set to reference it, with all the theme settings,
1626 * overlays and extensions that @p th had.
1628 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1630 * Tell the source theme to reference the ref theme
1632 * @param th The theme that will do the referencing
1633 * @param thref The theme that is the reference source
1635 * This clears @p th to be empty and then sets it to refer to @p thref
1636 * so @p th acts as an override to @p thref, but where its overrides
1637 * don't apply, it will fall through to @pthref for configuration.
1639 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1641 * Return the theme referred to
1643 * @param th The theme to get the reference from
1644 * @return The referenced theme handle
1646 * This gets the theme set as the reference theme by elm_theme_ref_set().
1647 * If no theme is set as a reference, NULL is returned.
1649 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1651 * Return the default theme
1653 * @return The default theme handle
1655 * This returns the internal default theme setup handle that all widgets
1656 * use implicitly unless a specific theme is set. This is also often use
1657 * as a shorthand of NULL.
1659 EAPI Elm_Theme *elm_theme_default_get(void);
1661 * Prepends a theme overlay to the list of overlays
1663 * @param th The theme to add to, or if NULL, the default theme
1664 * @param item The Edje file path to be used
1666 * Use this if your application needs to provide some custom overlay theme
1667 * (An Edje file that replaces some default styles of widgets) where adding
1668 * new styles, or changing system theme configuration is not possible. Do
1669 * NOT use this instead of a proper system theme configuration. Use proper
1670 * configuration files, profiles, environment variables etc. to set a theme
1671 * so that the theme can be altered by simple confiugration by a user. Using
1672 * this call to achieve that effect is abusing the API and will create lots
1675 * @see elm_theme_extension_add()
1677 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1679 * Delete a theme overlay from the list of overlays
1681 * @param th The theme to delete from, or if NULL, the default theme
1682 * @param item The name of the theme overlay
1684 * @see elm_theme_overlay_add()
1686 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1688 * Appends a theme extension to the list of extensions.
1690 * @param th The theme to add to, or if NULL, the default theme
1691 * @param item The Edje file path to be used
1693 * This is intended when an application needs more styles of widgets or new
1694 * widget themes that the default does not provide (or may not provide). The
1695 * application has "extended" usage by coming up with new custom style names
1696 * for widgets for specific uses, but as these are not "standard", they are
1697 * not guaranteed to be provided by a default theme. This means the
1698 * application is required to provide these extra elements itself in specific
1699 * Edje files. This call adds one of those Edje files to the theme search
1700 * path to be search after the default theme. The use of this call is
1701 * encouraged when default styles do not meet the needs of the application.
1702 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1704 * @see elm_object_style_set()
1706 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1708 * Deletes a theme extension from the list of extensions.
1710 * @param th The theme to delete from, or if NULL, the default theme
1711 * @param item The name of the theme extension
1713 * @see elm_theme_extension_add()
1715 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1717 * Set the theme search order for the given theme
1719 * @param th The theme to set the search order, or if NULL, the default theme
1720 * @param theme Theme search string
1722 * This sets the search string for the theme in path-notation from first
1723 * theme to search, to last, delimited by the : character. Example:
1725 * "shiny:/path/to/file.edj:default"
1727 * See the ELM_THEME environment variable for more information.
1729 * @see elm_theme_get()
1730 * @see elm_theme_list_get()
1732 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1734 * Return the theme search order
1736 * @param th The theme to get the search order, or if NULL, the default theme
1737 * @return The internal search order path
1739 * This function returns a colon separated string of theme elements as
1740 * returned by elm_theme_list_get().
1742 * @see elm_theme_set()
1743 * @see elm_theme_list_get()
1745 EAPI const char *elm_theme_get(Elm_Theme *th);
1747 * Return a list of theme elements to be used in a theme.
1749 * @param th Theme to get the list of theme elements from.
1750 * @return The internal list of theme elements
1752 * This returns the internal list of theme elements (will only be valid as
1753 * long as the theme is not modified by elm_theme_set() or theme is not
1754 * freed by elm_theme_free(). This is a list of strings which must not be
1755 * altered as they are also internal. If @p th is NULL, then the default
1756 * theme element list is returned.
1758 * A theme element can consist of a full or relative path to a .edj file,
1759 * or a name, without extension, for a theme to be searched in the known
1760 * theme paths for Elemementary.
1762 * @see elm_theme_set()
1763 * @see elm_theme_get()
1765 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1767 * Return the full patrh for a theme element
1769 * @param f The theme element name
1770 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1771 * @return The full path to the file found.
1773 * This returns a string you should free with free() on success, NULL on
1774 * failure. This will search for the given theme element, and if it is a
1775 * full or relative path element or a simple searchable name. The returned
1776 * path is the full path to the file, if searched, and the file exists, or it
1777 * is simply the full path given in the element or a resolved path if
1778 * relative to home. The @p in_search_path boolean pointed to is set to
1779 * EINA_TRUE if the file was a searchable file andis in the search path,
1780 * and EINA_FALSE otherwise.
1782 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1784 * Flush the current theme.
1786 * @param th Theme to flush
1788 * This flushes caches that let elementary know where to find theme elements
1789 * in the given theme. If @p th is NULL, then the default theme is flushed.
1790 * Call this function if source theme data has changed in such a way as to
1791 * make any caches Elementary kept invalid.
1793 EAPI void elm_theme_flush(Elm_Theme *th);
1795 * This flushes all themes (default and specific ones).
1797 * This will flush all themes in the current application context, by calling
1798 * elm_theme_flush() on each of them.
1800 EAPI void elm_theme_full_flush(void);
1802 * Set the theme for all elementary using applications on the current display
1804 * @param theme The name of the theme to use. Format same as the ELM_THEME
1805 * environment variable.
1807 EAPI void elm_theme_all_set(const char *theme);
1809 * Return a list of theme elements in the theme search path
1811 * @return A list of strings that are the theme element names.
1813 * This lists all available theme files in the standard Elementary search path
1814 * for theme elements, and returns them in alphabetical order as theme
1815 * element names in a list of strings. Free this with
1816 * elm_theme_name_available_list_free() when you are done with the list.
1818 EAPI Eina_List *elm_theme_name_available_list_new(void);
1820 * Free the list returned by elm_theme_name_available_list_new()
1822 * This frees the list of themes returned by
1823 * elm_theme_name_available_list_new(). Once freed the list should no longer
1824 * be used. a new list mys be created.
1826 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1828 * Set a specific theme to be used for this object and its children
1830 * @param obj The object to set the theme on
1831 * @param th The theme to set
1833 * This sets a specific theme that will be used for the given object and any
1834 * child objects it has. If @p th is NULL then the theme to be used is
1835 * cleared and the object will inherit its theme from its parent (which
1836 * ultimately will use the default theme if no specific themes are set).
1838 * Use special themes with great care as this will annoy users and make
1839 * configuration difficult. Avoid any custom themes at all if it can be
1842 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1844 * Get the specific theme to be used
1846 * @param obj The object to get the specific theme from
1847 * @return The specifc theme set.
1849 * This will return a specific theme set, or NULL if no specific theme is
1850 * set on that object. It will not return inherited themes from parents, only
1851 * the specific theme set for that specific object. See elm_object_theme_set()
1852 * for more information.
1854 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1860 typedef enum _Elm_Win_Type
1863 ELM_WIN_DIALOG_BASIC,
1870 ELM_WIN_DROPDOWN_MENU,
1873 ELM_WIN_NOTIFICATION,
1876 ELM_WIN_INLINED_IMAGE,
1879 typedef enum _Elm_Win_Keyboard_Mode
1881 ELM_WIN_KEYBOARD_UNKNOWN,
1882 ELM_WIN_KEYBOARD_OFF,
1883 ELM_WIN_KEYBOARD_ON,
1884 ELM_WIN_KEYBOARD_ALPHA,
1885 ELM_WIN_KEYBOARD_NUMERIC,
1886 ELM_WIN_KEYBOARD_PIN,
1887 ELM_WIN_KEYBOARD_PHONE_NUMBER,
1888 ELM_WIN_KEYBOARD_HEX,
1889 ELM_WIN_KEYBOARD_TERMINAL,
1890 ELM_WIN_KEYBOARD_PASSWORD,
1891 ELM_WIN_KEYBOARD_IP,
1892 ELM_WIN_KEYBOARD_HOST,
1893 ELM_WIN_KEYBOARD_FILE,
1894 ELM_WIN_KEYBOARD_URL,
1895 ELM_WIN_KEYBOARD_KEYPAD,
1896 ELM_WIN_KEYBOARD_J2ME
1897 } Elm_Win_Keyboard_Mode;
1899 typedef enum _Elm_Illume_Command
1901 ELM_ILLUME_COMMAND_FOCUS_BACK,
1902 ELM_ILLUME_COMMAND_FOCUS_FORWARD,
1903 ELM_ILLUME_COMMAND_FOCUS_HOME,
1904 ELM_ILLUME_COMMAND_CLOSE
1905 } Elm_Illume_Command;
1907 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1908 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1909 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1910 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1911 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1912 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1913 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1914 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1915 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1916 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
1917 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
1918 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1919 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
1920 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1921 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
1922 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1923 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
1924 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1925 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
1926 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1927 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
1928 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1929 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
1930 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1931 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
1932 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1933 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
1934 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1935 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1936 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1937 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1938 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
1939 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1940 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
1941 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1942 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
1943 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1944 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1945 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1946 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1947 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1948 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
1949 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1950 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
1951 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
1952 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1953 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1954 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1955 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1956 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1957 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
1958 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
1960 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1961 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1962 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1963 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1964 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1965 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1966 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1968 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1969 * (blank mouse, private mouse obj, defaultmouse)
1972 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
1973 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1974 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
1975 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1977 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
1979 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
1980 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1981 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1982 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1983 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1984 /* available styles:
1989 /* X specific calls - won't work on non-x engines (return 0) */
1990 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1991 /* smart callbacks called:
1992 * "delete,request" - the user requested to delete the window
1993 * "focus,in" - window got focus
1994 * "focus,out" - window lost focus
1995 * "moved" - window that holds the canvas was moved
2001 * @brief Background object, used for setting a solid color, image or Edje
2002 * group as background to a window or any container object.
2004 * The bg object is used for setting a solid background to a window or
2005 * packing into any container object. It works just like an image, but has
2006 * some properties useful to a background, like setting it to tiled,
2007 * centered, scaled or stretched.
2009 * Here is some sample code using it:
2010 * @li @ref bg_01_example_page
2011 * @li @ref bg_02_example_page
2012 * @li @ref bg_03_example_page
2016 typedef enum _Elm_Bg_Option
2018 ELM_BG_OPTION_CENTER, /**< center the background */
2019 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2020 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2021 ELM_BG_OPTION_TILE /**< tile background at its original size */
2025 * Add a new background to the parent
2027 * @param parent The parent object
2028 * @return The new object or NULL if it cannot be created
2032 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2035 * Set the file (image or edje) used for the background
2037 * @param obj The bg object
2038 * @param file The file path
2039 * @param group Optional key (group in Edje) within the file
2041 * This sets the image file used in the background object. The image (or edje)
2042 * will be stretched (retaining aspect if its an image file) to completely fill
2043 * the bg object. This may mean some parts are not visible.
2045 * @note Once the image of @p obj is set, a previously set one will be deleted,
2046 * even if @p file is NULL.
2050 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2053 * Get the file (image or edje) used for the background
2055 * @param obj The bg object
2056 * @param file The file path
2057 * @param group Optional key (group in Edje) within the file
2061 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2064 * Set the option used for the background image
2066 * @param obj The bg object
2067 * @param option The desired background option (TILE, SCALE)
2069 * This sets the option used for manipulating the display of the background
2070 * image. The image can be tiled or scaled.
2074 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2077 * Get the option used for the background image
2079 * @param obj The bg object
2080 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2084 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2086 * Set the option used for the background color
2088 * @param obj The bg object
2093 * This sets the color used for the background rectangle. Its range goes
2098 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2100 * Get the option used for the background color
2102 * @param obj The bg object
2109 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2112 * Set the overlay object used for the background object.
2114 * @param obj The bg object
2115 * @param overlay The overlay object
2117 * This provides a way for elm_bg to have an 'overlay' that will be on top
2118 * of the bg. Once the over object is set, a previously set one will be
2119 * deleted, even if you set the new one to NULL. If you want to keep that
2120 * old content object, use the elm_bg_overlay_unset() function.
2125 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2128 * Get the overlay object used for the background object.
2130 * @param obj The bg object
2131 * @return The content that is being used
2133 * Return the content object which is set for this widget
2137 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2140 * Get the overlay object used for the background object.
2142 * @param obj The bg object
2143 * @return The content that was being used
2145 * Unparent and return the overlay object which was set for this widget
2149 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2152 * Set the size of the pixmap representation of the image.
2154 * This option just makes sense if an image is going to be set in the bg.
2156 * @param obj The bg object
2157 * @param w The new width of the image pixmap representation.
2158 * @param h The new height of the image pixmap representation.
2160 * This function sets a new size for pixmap representation of the given bg
2161 * image. It allows the image to be loaded already in the specified size,
2162 * reducing the memory usage and load time when loading a big image with load
2163 * size set to a smaller size.
2165 * NOTE: this is just a hint, the real size of the pixmap may differ
2166 * depending on the type of image being loaded, being bigger than requested.
2170 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2171 /* smart callbacks called:
2175 typedef enum _Elm_Icon_Lookup_Order
2177 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2178 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2179 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
2180 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
2181 } Elm_Icon_Lookup_Order;
2183 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2184 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2185 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2186 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2187 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2188 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2189 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2190 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2191 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2192 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2193 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2194 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2195 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2196 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2197 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2198 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2199 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
2200 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2201 EAPI Eina_Bool elm_icon_anim_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2202 EAPI void elm_icon_anim_set(Evas_Object *obj, Eina_Bool anim) EINA_ARG_NONNULL(1);
2203 EAPI Eina_Bool elm_icon_anim_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2204 EAPI void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
2205 EAPI Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2207 /* smart callbacks called:
2208 * "clicked" - the user clicked the icon
2212 typedef enum _Elm_Image_Orient
2214 ELM_IMAGE_ORIENT_NONE,
2215 ELM_IMAGE_ROTATE_90_CW,
2216 ELM_IMAGE_ROTATE_180_CW,
2217 ELM_IMAGE_ROTATE_90_CCW,
2218 ELM_IMAGE_FLIP_HORIZONTAL,
2219 ELM_IMAGE_FLIP_VERTICAL,
2220 ELM_IMAGE_FLIP_TRANSPOSE,
2221 ELM_IMAGE_FLIP_TRANSVERSE
2223 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2224 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2225 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2226 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2227 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2228 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
2229 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2230 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2231 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2232 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2233 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2234 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2235 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2236 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2237 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
2238 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2239 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2240 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2241 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2242 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
2243 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2245 /* smart callbacks called:
2246 * "clicked" - the user clicked the image
2250 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
2252 typedef enum _Elm_GLView_Mode
2254 ELM_GLVIEW_ALPHA = 1,
2255 ELM_GLVIEW_DEPTH = 2,
2256 ELM_GLVIEW_STENCIL = 4
2260 * Defines a policy for the glview resizing.
2262 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
2264 typedef enum _Elm_GLView_Resize_Policy
2266 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
2267 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
2268 } Elm_GLView_Resize_Policy;
2270 typedef enum _Elm_GLView_Render_Policy
2272 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
2273 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
2274 } Elm_GLView_Render_Policy;
2277 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2278 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2279 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2280 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2281 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
2282 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
2283 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
2284 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2285 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2286 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2287 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2288 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2294 * A box arranges objects in a linear fashion, governed by a layout function
2295 * that defines the details of this arrangement.
2297 * By default, the box will use an internal function to set the layout to
2298 * a single row, either vertical or horizontal. This layout is affected
2299 * by a number of parameters, such as the homogeneous flag set by
2300 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
2301 * elm_box_align_set() and the hints set to each object in the box.
2303 * For this default layout, it's possible to change the orientation with
2304 * elm_box_horizontal_set(). The box will start in the vertical orientation,
2305 * placing its elements ordered from top to bottom. When horizontal is set,
2306 * the order will go from left to right. If the box is set to be
2307 * homogeneous, every object in it will be assigned the same space, that
2308 * of the largest object. Padding can be used to set some spacing between
2309 * the cell given to each object. The alignment of the box, set with
2310 * elm_box_align_set(), determines how the bounding box of all the elements
2311 * will be placed within the space given to the box widget itself.
2313 * The size hints of each object also affect how they are placed and sized
2314 * within the box. evas_object_size_hint_min_set() will give the minimum
2315 * size the object can have, and the box will use it as the basis for all
2316 * latter calculations. Elementary widgets set their own minimum size as
2317 * needed, so there's rarely any need to use it manually.
2319 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2320 * used to tell whether the object will be allocated the minimum size it
2321 * needs or if the space given to it should be expanded. It's important
2322 * to realize that expanding the size given to the object is not the same
2323 * thing as resizing the object. It could very well end being a small
2324 * widget floating in a much larger empty space. If not set, the weight
2325 * for objects will normally be 0.0 for both axis, meaning the widget will
2326 * not be expanded. To take as much space possible, set the weight to
2327 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2329 * Besides how much space each object is allocated, it's possible to control
2330 * how the widget will be placed within that space using
2331 * evas_object_size_hint_align_set(). By default, this value will be 0.5
2332 * for both axis, meaning the object will be centered, but any value from
2333 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2334 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2335 * is -1.0, means the object will be resized to fill the entire space it
2338 * In addition, customized functions to define the layout can be set, which
2339 * allow the application developer to organize the objects within the box
2340 * in any number of ways.
2342 * The special elm_box_layout_transition() function can be used
2343 * to switch from one layout to another, animating the motion of the
2344 * children of the box.
2346 * @note Objects should not be added to box objects using _add() calls.
2348 * Some examples on how to use boxes follow:
2349 * @li @ref box_example_01
2350 * @li @ref box_example_02
2355 * @typedef Elm_Box_Transition
2357 * Opaque handler containing the parameters to perform an animated
2358 * transition of the layout the box uses.
2360 * @see elm_box_transition_new()
2361 * @see elm_box_layout_set()
2362 * @see elm_box_layout_transition()
2364 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2367 * Add a new box to the parent
2369 * By default, the box will be in vertical mode and non-homogeneous.
2371 * @param parent The parent object
2372 * @return The new object or NULL if it cannot be created
2374 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2376 * Set the horizontal orientation
2378 * By default, box object arranges their contents vertically from top to
2380 * By calling this function with @p horizontal as EINA_TRUE, the box will
2381 * become horizontal, arranging contents from left to right.
2383 * @note This flag is ignored if a custom layout function is set.
2385 * @param obj The box object
2386 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2387 * EINA_FALSE = vertical)
2389 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2391 * Get the horizontal orientation
2393 * @param obj The box object
2394 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
2396 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2398 * Set the box to arrange its children homogeneously
2400 * If enabled, homogeneous layout makes all items the same size, according
2401 * to the size of the largest of its children.
2403 * @note This flag is ignored if a custom layout function is set.
2405 * @param obj The box object
2406 * @param homogeneous The homogeneous flag
2408 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2410 * Get whether the box is using homogeneous mode or not
2412 * @param obj The box object
2413 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2415 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2416 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2417 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2419 * Add an object to the beginning of the pack list
2421 * Pack @p subobj into the box @p obj, placing it first 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 top or left, 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_end()
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_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2439 * Add an object at the end of the pack list
2441 * Pack @p subobj into the box @p obj, placing it last in the list of
2442 * children objects. The actual position the object will get on screen
2443 * depends on the layout used. If no custom layout is set, it will be at
2444 * the bottom or right, depending if the box is vertical or horizontal,
2447 * @param obj The box object
2448 * @param subobj The object to add to the box
2450 * @see elm_box_pack_start()
2451 * @see elm_box_pack_before()
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_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2459 * Adds an object to the box before the indicated object
2461 * This will add the @p subobj to the box indicated before the object
2462 * indicated with @p before. If @p before is not already in the box, results
2463 * are undefined. Before means either to the left of the indicated object or
2464 * above it depending on orientation.
2466 * @param obj The box object
2467 * @param subobj The object to add to the box
2468 * @param before The object before which to add it
2470 * @see elm_box_pack_start()
2471 * @see elm_box_pack_end()
2472 * @see elm_box_pack_after()
2473 * @see elm_box_unpack()
2474 * @see elm_box_unpack_all()
2475 * @see elm_box_clear()
2477 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2479 * Adds an object to the box after the indicated object
2481 * This will add the @p subobj to the box indicated after the object
2482 * indicated with @p after. If @p after is not already in the box, results
2483 * are undefined. After means either to the right of the indicated object or
2484 * below it depending on orientation.
2486 * @param obj The box object
2487 * @param subobj The object to add to the box
2488 * @param after The object after which to add it
2490 * @see elm_box_pack_start()
2491 * @see elm_box_pack_end()
2492 * @see elm_box_pack_before()
2493 * @see elm_box_unpack()
2494 * @see elm_box_unpack_all()
2495 * @see elm_box_clear()
2497 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2499 * Clear the box of all children
2501 * Remove all the elements contained by the box, deleting the respective
2504 * @param obj The box object
2506 * @see elm_box_unpack()
2507 * @see elm_box_unpack_all()
2509 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2513 * Remove the object given by @p subobj from the box @p obj without
2516 * @param obj The box object
2518 * @see elm_box_unpack_all()
2519 * @see elm_box_clear()
2521 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2523 * Remove all items from the box, without deleting them
2525 * Clear the box from all children, but don't delete the respective objects.
2526 * If no other references of the box children exist, the objects will never
2527 * be deleted, and thus the application will leak the memory. Make sure
2528 * when using this function that you hold a reference to all the objects
2529 * in the box @p obj.
2531 * @param obj The box object
2533 * @see elm_box_clear()
2534 * @see elm_box_unpack()
2536 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2538 * Retrieve a list of the objects packed into the box
2540 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2541 * The order of the list corresponds to the packing order the box uses.
2543 * You must free this list with eina_list_free() once you are done with it.
2545 * @param obj The box object
2547 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2549 * Set the space (padding) between the box's elements.
2551 * Extra space in pixels that will be added between a box child and its
2552 * neighbors after its containing cell has been calculated. This padding
2553 * is set for all elements in the box, besides any possible padding that
2554 * individual elements may have through their size hints.
2556 * @param obj The box object
2557 * @param horizontal The horizontal space between elements
2558 * @param vertical The vertical space between elements
2560 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2562 * Get the space (padding) between the box's elements.
2564 * @param obj The box object
2565 * @param horizontal The horizontal space between elements
2566 * @param vertical The vertical space between elements
2568 * @see elm_box_padding_set()
2570 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2572 * Set the alignment of the whole bouding box of contents.
2574 * Sets how the bounding box containing all the elements of the box, after
2575 * their sizes and position has been calculated, will be aligned within
2576 * the space given for the whole box widget.
2578 * @param obj The box object
2579 * @param horizontal The horizontal alignment of elements
2580 * @param vertical The vertical alignment of elements
2582 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2584 * Get the alignment of the whole bouding box of contents.
2586 * @param obj The box object
2587 * @param horizontal The horizontal alignment of elements
2588 * @param vertical The vertical alignment of elements
2590 * @see elm_box_align_set()
2592 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2595 * Set the layout defining function to be used by the box
2597 * Whenever anything changes that requires the box in @p obj to recalculate
2598 * the size and position of its elements, the function @p cb will be called
2599 * to determine what the layout of the children will be.
2601 * Once a custom function is set, everything about the children layout
2602 * is defined by it. The flags set by elm_box_horizontal_set() and
2603 * elm_box_homogeneous_set() no longer have any meaning, and the values
2604 * given by elm_box_padding_set() and elm_box_align_set() are up to this
2605 * layout function to decide if they are used and how. These last two
2606 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2607 * passed to @p cb. The @c Evas_Object the function receives is not the
2608 * Elementary widget, but the internal Evas Box it uses, so none of the
2609 * functions described here can be used on it.
2611 * Any of the layout functions in @c Evas can be used here, as well as the
2612 * special elm_box_layout_transition().
2614 * The final @p data argument received by @p cb is the same @p data passed
2615 * here, and the @p free_data function will be called to free it
2616 * whenever the box is destroyed or another layout function is set.
2618 * Setting @p cb to NULL will revert back to the default layout function.
2620 * @param obj The box object
2621 * @param cb The callback function used for layout
2622 * @param data Data that will be passed to layout function
2623 * @param free_data Function called to free @p data
2625 * @see elm_box_layout_transition()
2627 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);
2629 * Special layout function that animates the transition from one layout to another
2631 * Normally, when switching the layout function for a box, this will be
2632 * reflected immediately on screen on the next render, but it's also
2633 * possible to do this through an animated transition.
2635 * This is done by creating an ::Elm_Box_Transition and setting the box
2636 * layout to this function.
2640 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2641 * evas_object_box_layout_vertical, // start
2642 * NULL, // data for initial layout
2643 * NULL, // free function for initial data
2644 * evas_object_box_layout_horizontal, // end
2645 * NULL, // data for final layout
2646 * NULL, // free function for final data
2647 * anim_end, // will be called when animation ends
2648 * NULL); // data for anim_end function\
2649 * elm_box_layout_set(box, elm_box_layout_transition, t,
2650 * elm_box_transition_free);
2653 * @note This function can only be used with elm_box_layout_set(). Calling
2654 * it directly will not have the expected results.
2656 * @see elm_box_transition_new
2657 * @see elm_box_transition_free
2658 * @see elm_box_layout_set
2660 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
2662 * Create a new ::Elm_Box_Transition to animate the switch of layouts
2664 * If you want to animate the change from one layout to another, you need
2665 * to set the layout function of the box to elm_box_layout_transition(),
2666 * passing as user data to it an instance of ::Elm_Box_Transition with the
2667 * necessary information to perform this animation. The free function to
2668 * set for the layout is elm_box_transition_free().
2670 * The parameters to create an ::Elm_Box_Transition sum up to how long
2671 * will it be, in seconds, a layout function to describe the initial point,
2672 * another for the final position of the children and one function to be
2673 * called when the whole animation ends. This last function is useful to
2674 * set the definitive layout for the box, usually the same as the end
2675 * layout for the animation, but could be used to start another transition.
2677 * @param start_layout The layout function that will be used to start the animation
2678 * @param start_layout_data The data to be passed the @p start_layout function
2679 * @param start_layout_free_data Function to free @p start_layout_data
2680 * @param end_layout The layout function that will be used to end the animation
2681 * @param end_layout_free_data The data to be passed the @p end_layout function
2682 * @param end_layout_free_data Function to free @p end_layout_data
2683 * @param transition_end_cb Callback function called when animation ends
2684 * @param transition_end_data Data to be passed to @p transition_end_cb
2685 * @return An instance of ::Elm_Box_Transition
2687 * @see elm_box_transition_new
2688 * @see elm_box_layout_transition
2690 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);
2692 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
2694 * This function is mostly useful as the @c free_data parameter in
2695 * elm_box_layout_set() when elm_box_layout_transition().
2697 * @param data The Elm_Box_Transition instance to be freed.
2699 * @see elm_box_transition_new
2700 * @see elm_box_layout_transition
2702 EAPI void elm_box_transition_free(void *data);
2709 * @defgroup Button Button
2711 * @image html widget/button/preview-00.png
2712 * @image html widget/button/preview-01.png
2713 * @image html widget/button/preview-02.png
2715 * This is a push-button. Press it and run some function. It can contain
2716 * a simple label and icon object and it also has an autorepeat feature.
2718 * This widgets emits the following signals:
2719 * @li "clicked": the user clicked the button (press/release).
2720 * @li "repeated": the user pressed the button without releasing it.
2721 * @li "pressed": button was pressed.
2722 * @li "unpressed": button was released after being pressed.
2723 * In all three cases, the @c event parameter of the callback will be
2726 * Also, defined in the default theme, the button has the following styles
2728 * @li default: a normal button.
2729 * @li anchor: Like default, but the button fades away when the mouse is not
2730 * over it, leaving only the text or icon.
2731 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
2732 * continuous look across its options.
2733 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
2735 * Follow through a complete example @ref button_example_01 "here".
2741 UIControlStateDefault,
2742 UIControlStateHighlighted,
2743 UIControlStateDisabled,
2744 UIControlStateFocused,
2745 UIControlStateReserved
2749 * Add a new button to the parent's canvas
2751 * @param parent The parent object
2752 * @return The new object or NULL if it cannot be created
2754 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2756 * Set the label used in the button
2758 * The passed @p label can be NULL to clean any existing text in it and
2759 * leave the button as an icon only object.
2761 * @param obj The button object
2762 * @param label The text will be written on the button
2763 * @deprecated use elm_object_text_set() instead.
2765 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2767 * Get the label set for the button
2769 * The string returned is an internal pointer and should not be freed or
2770 * altered. It will also become invalid when the button is destroyed.
2771 * The string returned, if not NULL, is a stringshare, so if you need to
2772 * keep it around even after the button is destroyed, you can use
2773 * eina_stringshare_ref().
2775 * @param obj The button object
2776 * @return The text set to the label, or NULL if nothing is set
2777 * @deprecated use elm_object_text_set() instead.
2779 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2781 * Set the label for each state of button
2783 * The passed @p label can be NULL to clean any existing text in it and
2784 * leave the button as an icon only object for the state.
2786 * @param obj The button object
2787 * @param label The text will be written on the button
2788 * @param state The state of button
2792 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
2794 * Get the label of button for each state
2796 * The string returned is an internal pointer and should not be freed or
2797 * altered. It will also become invalid when the button is destroyed.
2798 * The string returned, if not NULL, is a stringshare, so if you need to
2799 * keep it around even after the button is destroyed, you can use
2800 * eina_stringshare_ref().
2802 * @param obj The button object
2803 * @param state The state of button
2804 * @return The title of button for state
2808 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
2810 * Set the icon used for the button
2812 * Setting a new icon will delete any other that was previously set, making
2813 * any reference to them invalid. If you need to maintain the previous
2814 * object alive, unset it first with elm_button_icon_unset().
2816 * @param obj The button object
2817 * @param icon The icon object for the button
2819 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2821 * Get the icon used for the button
2823 * Return the icon object which is set for this widget. If the button is
2824 * destroyed or another icon is set, the returned object will be deleted
2825 * and any reference to it will be invalid.
2827 * @param obj The button object
2828 * @return The icon object that is being used
2830 * @see elm_button_icon_unset()
2832 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2834 * Remove the icon set without deleting it and return the object
2836 * This function drops the reference the button holds of the icon object
2837 * and returns this last object. It is used in case you want to remove any
2838 * icon, or set another one, without deleting the actual object. The button
2839 * will be left without an icon set.
2841 * @param obj The button object
2842 * @return The icon object that was being used
2844 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2846 * Turn on/off the autorepeat event generated when the button is kept pressed
2848 * When off, no autorepeat is performed and buttons emit a normal @c clicked
2849 * signal when they are clicked.
2851 * When on, keeping a button pressed will continuously emit a @c repeated
2852 * signal until the button is released. The time it takes until it starts
2853 * emitting the signal is given by
2854 * elm_button_autorepeat_initial_timeout_set(), and the time between each
2855 * new emission by elm_button_autorepeat_gap_timeout_set().
2857 * @param obj The button object
2858 * @param on A bool to turn on/off the event
2860 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
2862 * Get whether the autorepeat feature is enabled
2864 * @param obj The button object
2865 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
2867 * @see elm_button_autorepeat_set()
2869 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2871 * Set the initial timeout before the autorepeat event is generated
2873 * Sets the timeout, in seconds, since the button is pressed until the
2874 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
2875 * won't be any delay and the even will be fired the moment the button is
2878 * @param obj The button object
2879 * @param t Timeout in seconds
2881 * @see elm_button_autorepeat_set()
2882 * @see elm_button_autorepeat_gap_timeout_set()
2884 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2886 * Get the initial timeout before the autorepeat event is generated
2888 * @param obj The button object
2889 * @return Timeout in seconds
2891 * @see elm_button_autorepeat_initial_timeout_set()
2893 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2895 * Set the interval between each generated autorepeat event
2897 * After the first @c repeated event is fired, all subsequent ones will
2898 * follow after a delay of @p t seconds for each.
2900 * @param obj The button object
2901 * @param t Interval in seconds
2903 * @see elm_button_autorepeat_initial_timeout_set()
2905 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2907 * Get the interval between each generated autorepeat event
2909 * @param obj The button object
2910 * @return Interval in seconds
2912 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2918 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2919 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2920 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2921 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2922 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2923 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2924 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2925 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2926 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2927 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2928 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2929 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2930 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2931 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2932 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2933 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2934 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2935 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2936 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2937 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2938 /* available styles:
2942 * hoversel_vertical_entry
2944 /* smart callbacks called:
2945 * "file,chosen" - the user has selected a path, whose string pointer comes
2949 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2950 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2951 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2952 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2953 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2954 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2955 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2956 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2957 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2958 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2959 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2960 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2961 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2962 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2963 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2964 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2965 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2966 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2967 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2968 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2969 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2970 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2972 /* scroller policy */
2973 typedef enum _Elm_Scroller_Policy
2975 ELM_SCROLLER_POLICY_AUTO = 0,
2976 ELM_SCROLLER_POLICY_ON,
2977 ELM_SCROLLER_POLICY_OFF,
2978 ELM_SCROLLER_POLICY_LAST
2979 } Elm_Scroller_Policy;
2981 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2982 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
2983 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2984 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2985 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
2986 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
2987 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);
2988 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
2989 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
2990 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);
2991 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2992 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2993 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2994 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2995 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2996 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);
2997 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
2998 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
2999 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
3000 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
3001 EINA_DEPRECATED EAPI void elm_scroller_page_move_set(Evas_Object *obj, Eina_Bool set);
3002 /* smart callbacks called:
3003 * "edge,left" - the left edge of the content has been reached
3004 * "edge,right" - the right edge of the content has been reached
3005 * "edge,top" - the top edge of the content has been reached
3006 * "edge,bottom" - the bottom edge of the content has been reached
3007 * "scroll" - the content has been scrolled (moved)
3008 * "scroll,anim,start" - scrolling animation has started
3009 * "scroll,anim,stop" - scrolling animation has stopped
3010 * "scroll,drag,start" - dragging the contents around has started
3011 * "scroll,drag,stop" - dragging the contents around has stopped
3015 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3016 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 */
3017 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
3018 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3019 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3020 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
3021 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3022 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
3023 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3024 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
3025 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);
3026 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
3027 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);
3028 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
3029 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
3030 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
3031 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3032 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
3033 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3034 /* available styles:
3038 /* smart callbacks called:
3042 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3043 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3044 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3045 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3046 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3047 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3048 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
3049 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
3050 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
3051 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3052 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
3053 /* smart callbacks called:
3054 * "changed" - Whenever the toggle value has been changed. Is not called
3055 * until the toggle is released by the cursor (assuming it has been triggered
3056 * by the cursor in the first place).
3060 * @page tutorial_frame Frame example
3061 * @dontinclude frame_example_01.c
3063 * In this example we are going to create 4 Frames with different styles and
3064 * add a rectangle of different color in each.
3066 * We start we the usual setup code:
3069 * And then create one rectangle:
3072 * To add it in our first frame, which since it doesn't have it's style
3073 * specifically set uses the default style:
3076 * And then create another rectangle:
3079 * To add it in our second frame, which uses the "pad_small" style, note that
3080 * even tough we are setting a text for this frame it won't be show, only the
3081 * default style shows the Frame's title:
3083 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
3084 * very similar, their only difference is the size of the empty area around
3085 * the content of the frame.
3087 * And then create yet another rectangle:
3090 * To add it in our third frame, which uses the "outdent_top" style, note
3091 * that even tough we are setting a text for this frame it won't be show,
3092 * only the default style shows the Frame's title:
3095 * And then create one last rectangle:
3098 * To add it in our fourth and final frame, which uses the "outdent_bottom"
3099 * style, note that even tough we are setting a text for this frame it won't
3100 * be show, only the default style shows the Frame's title:
3103 * And now we are left with just some more setup code:
3106 * Our example will look like this:
3107 * @image html screenshots/frame_example_01.png
3108 * @image latex screenshots/frame_example_01.eps
3110 * @example frame_example_01.c
3113 * @defgroup Frame Frame
3115 * @brief Frame is a widget that holds some content and has a title.
3117 * The default look is a frame with a title, but Frame supports multple
3125 * @li outdent_bottom
3127 * Of all this styles only default shows the title. Frame emits no signals.
3129 * For a detailed example see the @ref tutorial_frame.
3134 * @brief Add a new frame to the parent
3136 * @param parent The parent object
3137 * @return The new object or NULL if it cannot be created
3139 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3141 * @brief Set the frame label
3143 * @param obj The frame object
3144 * @param label The label of this frame object
3146 * @deprecated use elm_object_text_set() instead.
3148 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3150 * @brief Get the frame label
3152 * @param obj The frame object
3154 * @return The label of this frame objet or NULL if unable to get frame
3156 * @deprecated use elm_object_text_get() instead.
3158 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3160 * @brief Set the content of the frame widget
3162 * Once the content object is set, a previously set one will be deleted.
3163 * If you want to keep that old content object, use the
3164 * elm_frame_content_unset() function.
3166 * @param obj The frame object
3167 * @param content The content will be filled in this frame object
3169 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3171 * @brief Get the content of the frame widget
3173 * Return the content object which is set for this widget
3175 * @param obj The frame object
3176 * @return The content that is being used
3178 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3180 * @brief Unset the content of the frame widget
3182 * Unparent and return the content object which was set for this widget
3184 * @param obj The frame object
3185 * @return The content that was being used
3187 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3193 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3194 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3195 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3196 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3197 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3198 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3199 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3200 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3201 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3202 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
3203 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3204 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
3207 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
3208 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
3209 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
3210 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
3211 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
3212 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
3213 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
3215 struct _Elm_Gengrid_Item_Class
3217 const char *item_style;
3218 struct _Elm_Gengrid_Item_Class_Func
3220 GridItemLabelGetFunc label_get;
3221 GridItemIconGetFunc icon_get;
3222 GridItemStateGetFunc state_get;
3223 GridItemDelFunc del;
3227 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3228 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
3229 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3230 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
3231 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
3233 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
3234 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3235 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
3236 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3237 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
3238 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3239 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
3240 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3241 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3242 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3243 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3244 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
3245 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3246 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
3247 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3249 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3250 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3252 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3253 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3254 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3255 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3256 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3257 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3258 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
3259 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3260 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
3261 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
3262 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3263 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3264 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3265 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3266 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3267 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3268 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3270 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
3271 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);
3272 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3273 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3274 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3275 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3276 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3277 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3278 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3279 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3280 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3281 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3283 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3284 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3285 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3287 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);
3288 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);
3289 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);
3290 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);
3291 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);
3292 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);
3293 /* smart callbacks called:
3295 * selected - User has selected an item.
3296 * unselected - User has unselected an item.
3297 * clicked,double - User has double-clicked or pressed enter on an item.
3298 * realized - An evas object for an item was built.
3299 * unrealized - An evas object for an item was deleted.
3300 * changed - An item has been added, removed, resized or moved,
3301 * or gengrid has been resized or horizontal property has been changed.
3302 * scroll - the content has been scrolled (moved).
3303 * "scroll,drag,start" - dragging the contents around has started.
3304 * "scroll,drag,stop" - dragging the contents around has stopped.
3305 * drag - Gengrid is being dragged.
3306 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
3307 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
3308 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
3309 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
3310 * "drag,stop" - Gengrid is not being dragged.
3314 * @defgroup Clock Clock
3316 * This is a @b digital clock widget. In its default theme, it has a
3317 * vintage "flipping numbers clock" appearance, which will animate
3318 * sheets of individual algarisms individually as time goes by.
3320 * A newly created clock will fetch system's time (already
3321 * considering local time adjustments) to start with, and will tick
3322 * accondingly. It may or may not show seconds.
3324 * Clocks have an @b edition mode. When in it, the sheets will
3325 * display extra arrow indications on the top and bottom and the
3326 * user may click on them to raise or lower the time values. After
3327 * it's told to exit edition mode, it will keep ticking with that
3328 * new time set (it keeps the difference from local time).
3330 * Also, when under edition mode, user clicks on the cited arrows
3331 * which are @b held for some time will make the clock to flip the
3332 * sheet, thus editing the time, continuosly and automatically for
3333 * the user. The interval between sheet flips will keep growing in
3334 * time, so that it helps the user to reach a time which is distant
3337 * The time display is, by default, in military mode (24h), but an
3338 * am/pm indicator may be optionally shown, too, when it will
3341 * Smart callbacks one can register to:
3342 * - "changed" - the clock's user changed the time
3344 * Here is an example on its usage:
3345 * @li @ref clock_example
3354 * Identifiers for which clock digits should be editable, when a
3355 * clock widget is in edition mode. Values may be ORed together to
3356 * make a mask, naturally.
3358 * @see elm_clock_edit_set()
3359 * @see elm_clock_digit_edit_set()
3361 typedef enum _Elm_Clock_Digedit
3363 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
3364 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
3365 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
3366 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
3367 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
3368 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
3369 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
3370 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
3371 } Elm_Clock_Digedit;
3374 * Add a new clock widget to the given parent Elementary
3375 * (container) object
3377 * @param parent The parent object
3378 * @return a new clock widget handle or @c NULL, on errors
3380 * This function inserts a new clock widget on the canvas.
3384 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3387 * Set a clock widget's time, programmatically
3389 * @param obj The clock widget object
3390 * @param hrs The hours to set
3391 * @param min The minutes to set
3392 * @param sec The secondes to set
3394 * This function updates the time that is showed by the clock
3397 * Values @b must be set within the following ranges:
3398 * - 0 - 23, for hours
3399 * - 0 - 59, for minutes
3400 * - 0 - 59, for seconds,
3402 * even if the clock is not in "military" mode.
3404 * @warning The behavior for values set out of those ranges is @b
3409 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
3412 * Get a clock widget's time values
3414 * @param obj The clock object
3415 * @param[out] hrs Pointer to the variable to get the hours value
3416 * @param[out] min Pointer to the variable to get the minutes value
3417 * @param[out] sec Pointer to the variable to get the seconds value
3419 * This function gets the time set for @p obj, returning
3420 * it on the variables passed as the arguments to function
3422 * @note Use @c NULL pointers on the time values you're not
3423 * interested in: they'll be ignored by the function.
3427 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
3430 * Set whether a given clock widget is under <b>edition mode</b> or
3431 * under (default) displaying-only mode.
3433 * @param obj The clock object
3434 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
3435 * put it back to "displaying only" mode
3437 * This function makes a clock's time to be editable or not <b>by
3438 * user interaction</b>. When in edition mode, clocks @b stop
3439 * ticking, until one brings them back to canonical mode. The
3440 * elm_clock_digit_edit_set() function will influence which digits
3441 * of the clock will be editable. By default, all of them will be
3442 * (#ELM_CLOCK_NONE).
3444 * @note am/pm sheets, if being shown, will @b always be editable
3445 * under edition mode.
3447 * @see elm_clock_edit_get()
3451 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
3454 * Retrieve whether a given clock widget is under <b>edition
3455 * mode</b> or under (default) displaying-only mode.
3457 * @param obj The clock object
3458 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
3461 * This function retrieves whether the clock's time can be edited
3462 * or not by user interaction.
3464 * @see elm_clock_edit_set() for more details
3468 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3471 * Set what digits of the given clock widget should be editable
3472 * when in edition mode.
3474 * @param obj The clock object
3475 * @param digedit Bit mask indicating the digits to be editable
3476 * (values in #Elm_Clock_Digedit).
3478 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
3479 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
3482 * @see elm_clock_digit_edit_get()
3486 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
3489 * Retrieve what digits of the given clock widget should be
3490 * editable when in edition mode.
3492 * @param obj The clock object
3493 * @return Bit mask indicating the digits to be editable
3494 * (values in #Elm_Clock_Digedit).
3496 * @see elm_clock_digit_edit_set() for more details
3500 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3503 * Set if the given clock widget must show hours in military or
3506 * @param obj The clock object
3507 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
3510 * This function sets if the clock must show hours in military or
3511 * am/pm mode. In some countries like Brazil the military mode
3512 * (00-24h-format) is used, in opposition to the USA, where the
3513 * am/pm mode is more commonly used.
3515 * @see elm_clock_show_am_pm_get()
3519 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
3522 * Get if the given clock widget shows hours in military or am/pm
3525 * @param obj The clock object
3526 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
3529 * This function gets if the clock shows hours in military or am/pm
3532 * @see elm_clock_show_am_pm_set() for more details
3536 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3539 * Set if the given clock widget must show time with seconds or not
3541 * @param obj The clock object
3542 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
3544 * This function sets if the given clock must show or not elapsed
3545 * seconds. By default, they are @b not shown.
3547 * @see elm_clock_show_seconds_get()
3551 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
3554 * Get whether the given clock widget is showing time with seconds
3557 * @param obj The clock object
3558 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
3560 * This function gets whether @p obj is showing or not the elapsed
3563 * @see elm_clock_show_seconds_set()
3567 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3570 * Set the interval on time updates for an user mouse button hold
3571 * on clock widgets' time edition.
3573 * @param obj The clock object
3574 * @param interval The (first) interval value in seconds
3576 * This interval value is @b decreased while the user holds the
3577 * mouse pointer either incrementing or decrementing a given the
3578 * clock digit's value.
3580 * This helps the user to get to a given time distant from the
3581 * current one easier/faster, as it will start to flip quicker and
3582 * quicker on mouse button holds.
3584 * The calculation for the next flip interval value, starting from
3585 * the one set with this call, is the previous interval divided by
3586 * 1.05, so it decreases a little bit.
3588 * The default starting interval value for automatic flips is
3591 * @see elm_clock_interval_get()
3595 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
3598 * Get the interval on time updates for an user mouse button hold
3599 * on clock widgets' time edition.
3601 * @param obj The clock object
3602 * @return The (first) interval value, in seconds, set on it
3604 * @see elm_clock_interval_set() for more details
3608 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3615 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3616 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
3617 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
3618 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3619 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3620 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3621 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
3622 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
3623 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3624 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3625 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
3626 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
3627 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
3628 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3629 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);
3630 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
3631 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3632 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3633 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
3634 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
3635 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
3636 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3637 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3638 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
3639 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3640 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);
3641 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3643 * @def elm_layout_icon_set
3644 * Convienience macro to set the icon object in a layout that follows the
3645 * Elementary naming convention for its parts.
3649 #define elm_layout_icon_set(_ly, _obj) \
3652 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
3653 if ((_obj)) sig = "elm,state,icon,visible"; \
3654 else sig = "elm,state,icon,hidden"; \
3655 elm_object_signal_emit((_ly), sig, "elm"); \
3659 * @def elm_layout_icon_get
3660 * Convienience macro to get the icon object from a layout that follows the
3661 * Elementary naming convention for its parts.
3665 #define elm_layout_icon_get(_ly) \
3666 elm_layout_content_get((_ly), "elm.swallow.icon")
3669 * @def elm_layout_end_set
3670 * Convienience macro to set the end object in a layout that follows the
3671 * Elementary naming convention for its parts.
3675 #define elm_layout_end_set(_ly, _obj) \
3678 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
3679 if ((_obj)) sig = "elm,state,end,visible"; \
3680 else sig = "elm,state,end,hidden"; \
3681 elm_object_signal_emit((_ly), sig, "elm"); \
3685 * @def elm_layout_end_get
3686 * Convienience macro to get the end object in a layout that follows the
3687 * Elementary naming convention for its parts.
3691 #define elm_layout_end_get(_ly) \
3692 elm_layout_content_get((_ly), "elm.swallow.end")
3695 * @def elm_layout_label_set
3696 * Convienience macro to set the label in a layout that follows the
3697 * Elementary naming convention for its parts.
3700 * @deprecate use elm_object_text_* instead.
3702 #define elm_layout_label_set(_ly, _txt) \
3703 elm_layout_text_set((_ly), "elm.text", (_txt))
3706 * @def elm_layout_label_get
3707 * Convienience macro to get the label in a layout that follows the
3708 * Elementary naming convention for its parts.
3711 * @deprecate use elm_object_text_* instead.
3713 #define elm_layout_label_get(_ly) \
3714 elm_layout_text_get((_ly), "elm.text")
3716 /* smart callbacks called:
3720 typedef enum _Elm_Notify_Orient
3722 ELM_NOTIFY_ORIENT_TOP,
3723 ELM_NOTIFY_ORIENT_CENTER,
3724 ELM_NOTIFY_ORIENT_BOTTOM,
3725 ELM_NOTIFY_ORIENT_LEFT,
3726 ELM_NOTIFY_ORIENT_RIGHT,
3727 ELM_NOTIFY_ORIENT_TOP_LEFT,
3728 ELM_NOTIFY_ORIENT_TOP_RIGHT,
3729 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
3730 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
3731 ELM_NOTIFY_ORIENT_LAST
3732 } Elm_Notify_Orient;
3733 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3734 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3735 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3736 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3737 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3738 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3739 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
3740 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3741 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
3742 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3743 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
3744 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3745 /* smart callbacks called:
3746 * "timeout" - when timeout happens on notify and it's hidden
3747 * "block,clicked" - when it's hidden by a click outside of the notify's view
3751 typedef enum _Elm_Hover_Axis
3753 ELM_HOVER_AXIS_NONE,
3754 ELM_HOVER_AXIS_HORIZONTAL,
3755 ELM_HOVER_AXIS_VERTICAL,
3758 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3759 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
3760 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3761 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3762 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3763 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3764 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3765 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3766 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
3767 /* available styles:
3773 /* smart callbacks called:
3774 * "clicked" - the user clicked the empty space in the hover to dismiss
3775 * "smart,changed" - a content object placed under the "smart"
3776 * policy was replaced to a new slot direction.
3780 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
3781 struct _Elm_Entry_Anchor_Info
3785 Evas_Coord x, y, w, h;
3787 typedef enum _Elm_Icon_Type
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);
3882 * Set the input panel layout of the entry
3884 * @param obj The entry object
3885 * @param layout layout type
3887 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
3889 * Get the input panel layout of the entry
3891 * @param obj The entry object
3892 * @return layout type
3894 * @see elm_entry_input_panel_layout_set
3896 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3898 * Set the autocapitalization type on the immodule.
3900 * @param obj The entry object
3901 * @param autocapital_type The type of autocapitalization
3903 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
3905 * Retrieve the autocapitalization type on the immodule.
3907 * @param obj The entry object
3908 * @return autocapitalization type
3910 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3912 * Sets the attribute to show the input panel automatically.
3914 * @param obj The entry object
3915 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
3917 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
3919 * Retrieve the attribute to show the input panel automatically.
3921 * @param obj The entry object
3922 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
3924 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3926 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3927 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
3928 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
3929 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
3930 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
3931 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
3932 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
3934 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
3935 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
3936 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
3937 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3938 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
3940 /* smart callbacks called:
3941 * "changed" - the text content changed
3942 * "selection,start" - the user started selecting text
3943 * "selection,changed" - the user modified the selection size/location
3944 * "selection,cleared" - the user cleared the selection
3945 * "selection,paste" - the user requested a paste of text
3946 * "selection,copy" - the user copied the text
3947 * "selection,cut" - the user cut the text
3948 * "cursor,changed" - the cursor changed position
3949 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
3950 * "activated" - when the enter key is pressed (useful for single line)
3951 * "press" - when finger/mouse is pressed down
3952 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
3953 * "clicked,double" - when finger/mouse is double-pressed
3954 * "longpressed" - the entry has been longpressed
3955 * "focused" - the entry has received keyboard focus
3956 * "unfocused" - keyboard focus is gone
3959 /* composite widgets - these basically put together basic widgets above
3960 * in convenient packages that do more than basic stuff */
3964 * @defgroup Anchorview Anchorview
3966 * Anchorview is for displaying text that contains markup with anchors
3967 * like <c>\<a href=1234\>something\</\></c> in it.
3969 * Besides being styled differently, the anchorview widget provides the
3970 * necessary functionality so that clicking on these anchors brings up a
3971 * popup with user defined content such as "call", "add to contacts" or
3972 * "open web page". This popup is provided using the @ref Hover widget.
3974 * This widget is very similar to @ref Anchorblock, so refer to that
3975 * widget for an example. The only difference Anchorview has is that the
3976 * widget is already provided with scrolling functionality, so if the
3977 * text set to it is too large to fit in the given space, it will scroll,
3978 * whereas the @ref Anchorblock widget will keep growing to ensure all the
3979 * text can be displayed.
3981 * This widget emits the following signals:
3982 * @li "anchor,clicked": will be called when an anchor is clicked. The
3983 * @p event_info parameter on the callback will be a pointer of type
3984 * ::Elm_Entry_Anchorview_Info.
3986 * See @ref Anchorblock for an example on how to use both of them.
3995 * @typedef Elm_Entry_Anchorview_Info
3997 * The info sent in the callback for "anchor,clicked" signals emitted by
3998 * the Anchorview widget.
4000 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
4002 * @struct _Elm_Entry_Anchorview_Info
4004 * The info sent in the callback for "anchor,clicked" signals emitted by
4005 * the Anchorview widget.
4007 struct _Elm_Entry_Anchorview_Info
4009 const char *name; /**< Name of the anchor, as indicated in its href
4011 int button; /**< The mouse button used to click on it */
4012 Evas_Object *hover; /**< The hover object to use for the popup */
4014 Evas_Coord x, y, w, h;
4015 } anchor, /**< Geometry selection of text used as anchor */
4016 hover_parent; /**< Geometry of the object used as parent by the
4018 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4019 for content on the left side of
4020 the hover. Before calling the
4021 callback, the widget will make the
4022 necessary calculations to check
4023 which sides are fit to be set with
4024 content, based on the position the
4025 hover is activated and its distance
4026 to the edges of its parent object
4028 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4029 the right side of the hover.
4030 See @ref hover_left */
4031 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4032 of the hover. See @ref hover_left */
4033 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4034 below the hover. See @ref
4038 * Add a new Anchorview object
4040 * @param parent The parent object
4041 * @return The new object or NULL if it cannot be created
4043 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4045 * Set the text to show in the anchorview
4047 * Sets the text of the anchorview to @p text. This text can include markup
4048 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
4049 * text that will be specially styled and react to click events, ended with
4050 * either of \</a\> or \</\>. When clicked, the anchor will emit an
4051 * "anchor,clicked" signal that you can attach a callback to with
4052 * evas_object_smart_callback_add(). The name of the anchor given in the
4053 * event info struct will be the one set in the href attribute, in this
4056 * Other markup can be used to style the text in different ways, but it's
4057 * up to the style defined in the theme which tags do what.
4058 * @deprecated use elm_object_text_set() instead.
4060 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4062 * Get the markup text set for the anchorview
4064 * Retrieves the text set on the anchorview, with markup tags included.
4066 * @param obj The anchorview object
4067 * @return The markup text set or @c NULL if nothing was set or an error
4069 * @deprecated use elm_object_text_set() instead.
4071 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4073 * Set the parent of the hover popup
4075 * Sets the parent object to use by the hover created by the anchorview
4076 * when an anchor is clicked. See @ref Hover for more details on this.
4077 * If no parent is set, the same anchorview object will be used.
4079 * @param obj The anchorview object
4080 * @param parent The object to use as parent for the hover
4082 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4084 * Get the parent of the hover popup
4086 * Get the object used as parent for the hover created by the anchorview
4087 * widget. See @ref Hover for more details on this.
4089 * @param obj The anchorview object
4090 * @return The object used as parent for the hover, NULL if none is set.
4092 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4094 * Set the style that the hover should use
4096 * When creating the popup hover, anchorview will request that it's
4097 * themed according to @p style.
4099 * @param obj The anchorview object
4100 * @param style The style to use for the underlying hover
4102 * @see elm_object_style_set()
4104 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4106 * Get the style that the hover should use
4108 * Get the style the hover created by anchorview will use.
4110 * @param obj The anchorview object
4111 * @return The style to use by the hover. NULL means the default is used.
4113 * @see elm_object_style_set()
4115 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4117 * Ends the hover popup in the anchorview
4119 * When an anchor is clicked, the anchorview widget will create a hover
4120 * object to use as a popup with user provided content. This function
4121 * terminates this popup, returning the anchorview to its normal state.
4123 * @param obj The anchorview object
4125 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4127 * Set bouncing behaviour when the scrolled content reaches an edge
4129 * Tell the internal scroller object whether it should bounce or not
4130 * when it reaches the respective edges for each axis.
4132 * @param obj The anchorview object
4133 * @param h_bounce Whether to bounce or not in the horizontal axis
4134 * @param v_bounce Whether to bounce or not in the vertical axis
4136 * @see elm_scroller_bounce_set()
4138 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4140 * Get the set bouncing behaviour of the internal scroller
4142 * Get whether the internal scroller should bounce when the edge of each
4143 * axis is reached scrolling.
4145 * @param obj The anchorview object
4146 * @param h_bounce Pointer where to store the bounce state of the horizontal
4148 * @param v_bounce Pointer where to store the bounce state of the vertical
4151 * @see elm_scroller_bounce_get()
4153 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4155 * Appends a custom item provider to the given anchorview
4157 * Appends the given function to the list of items providers. This list is
4158 * called, one function at a time, with the given @p data pointer, the
4159 * anchorview object and, in the @p item parameter, the item name as
4160 * referenced in its href string. Following functions in the list will be
4161 * called in order until one of them returns something different to NULL,
4162 * which should be an Evas_Object which will be used in place of the item
4165 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4166 * href=item/name\>\</item\>
4168 * @param obj The anchorview object
4169 * @param func The function to add to the list of providers
4170 * @param data User data that will be passed to the callback function
4172 * @see elm_entry_item_provider_append()
4174 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);
4176 * Prepend a custom item provider to the given anchorview
4178 * Like elm_anchorview_item_provider_append(), but it adds the function
4179 * @p func to the beginning of the list, instead of the end.
4181 * @param obj The anchorview object
4182 * @param func The function to add to the list of providers
4183 * @param data User data that will be passed to the callback function
4185 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);
4187 * Remove a custom item provider from the list of the given anchorview
4189 * Removes the function and data pairing that matches @p func and @p data.
4190 * That is, unless the same function and same user data are given, the
4191 * function will not be removed from the list. This allows us to add the
4192 * same callback several times, with different @p data pointers and be
4193 * able to remove them later without conflicts.
4195 * @param obj The anchorview object
4196 * @param func The function to remove from the list
4197 * @param data The data matching the function to remove from the list
4199 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);
4206 * @defgroup Anchorblock Anchorblock
4208 * Anchorblock is for displaying text that contains markup with anchors
4209 * like <c>\<a href=1234\>something\</\></c> in it.
4211 * Besides being styled differently, the anchorblock widget provides the
4212 * necessary functionality so that clicking on these anchors brings up a
4213 * popup with user defined content such as "call", "add to contacts" or
4214 * "open web page". This popup is provided using the @ref Hover widget.
4216 * This widget emits the following signals:
4217 * @li "anchor,clicked": will be called when an anchor is clicked. The
4218 * @p event_info parameter on the callback will be a pointer of type
4219 * ::Elm_Entry_Anchorblock_Info.
4225 * Since examples are usually better than plain words, we might as well
4226 * try @ref tutorial_anchorblock_example "one".
4229 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
4230 * This exampel will show both Anchorblock and @ref Anchorview,
4231 * since both are very similar and it's easier to show them once and side
4232 * by side, so the difference is more clear.
4234 * We'll show the relevant snippets of the code here, but the full example
4235 * can be found here... sorry, @ref anchorblock_example_01.c "here".
4237 * As for the actual example, it's just a simple window with an anchorblock
4238 * and an anchorview, both containing the same text. After including
4239 * Elementary.h and declaring some functions we'll need, we jump to our
4240 * elm_main (see ELM_MAIN) and create our window.
4241 * @dontinclude anchorblock_example_01.c
4246 * With the needed variables declared, we'll create the window and a box to
4247 * hold our widgets, but we don't need to go through that here.
4249 * In order to make clear where the anchorblock ends and the anchorview
4250 * begins, they'll be each inside a @ref Frame. After creating the frame,
4251 * the anchorblock follows.
4252 * @skip elm_frame_add
4253 * @until elm_frame_content_set
4255 * Nothing out of the ordinary there. What's worth mentioning is the call
4256 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
4257 * when an anchor is clicked, the hover for the popup will cover the entire
4258 * window. This affects the area that will be obscured by the hover and
4259 * where clicking will dismiss it, as well as the calculations it does to
4260 * inform the best locations where to insert the popups content.
4261 * Other than that, the code is pretty standard. We also need to set our
4262 * callback for when an anchor is clicked, since it's our task to populate
4263 * the popup. There's no default for it.
4265 * The anchorview is no different, we only change a few things so it looks
4267 * @until elm_frame_content_set
4269 * Then we run, so stuff works and close our main function in the usual way.
4272 * Now, a little note. Normally you would use either one of anchorblock or
4273 * anchorview, set your one callback to clicks and do your stuff in there.
4274 * In this example, however, there are a few tricks to make it easier to
4275 * show both widgets in one go (and to save me some typing). So we have
4276 * two callbacks, one per widget, that will call a common function to do
4277 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
4278 * anchorview too, since both are equal, and passing a callback to use
4279 * for our buttons to end the hover, because each widget has a different
4281 * @until _anchorview_clicked_cb
4284 * The meat of our popup is in the following function. We check what kind
4285 * of menu we need to show, based on the name set to the anchor in the
4286 * markup text. If there's no type (something went wrong, no valid contact
4287 * in the address list) we are just putting a button that does nothing, but
4288 * it's perfectly reasonable to just end the hover and call it quits.
4290 * Our popup will consist of one main button in the middle of our hover,
4291 * and possibly a secondary button and a list of other options. We'll create
4292 * first our main button and check what kind of popup we need afterwards.
4295 * @until eina_stringshare_add
4298 * Each button has two callbacks, one is our hack to close the hover
4299 * properly based on which widget it belongs to, the other a simple
4300 * printf that will show the action with the anchors own data. This is
4301 * not how you would usually do it. Instead, the common case is to have
4302 * one callback for the button that will know which function to call to end
4303 * things, but since we are doing it this way it's worth noting that
4304 * smart callbacks will be called in reverse in respect to the order they
4305 * were added, and since our @c btn_end_cb will close the hover, and thus
4306 * delete our buttons, the other callback wouldn't be called if we had
4309 * After our telephone popup, there are a few others that are practically
4310 * the same, so they won't be shown here.
4312 * Once we are done with that, it's time to place our actions into our
4313 * hover. Main button goes in the middle without much questioning, and then
4314 * we see if we have a secondary button and a box of extra options.
4315 * Because I said so, secondary button goes on either side and box of
4316 * options either on top or below the main one, but to choose which
4317 * exactly, we use the hints our callback info has, which saves us from
4318 * having to do the math and see which side has more space available, with
4319 * a little special case where we delete our extra stuff if there's nowhere
4323 * @skip evas_object_smart
4324 * @until evas_object_del(box)
4328 * The example will look like this:
4329 * @image html screenshots/anchorblock_01.png
4330 * @image latex screenshots/anchorblock_01.eps
4332 * @example anchorblock_example_01.c
4335 * @addtogroup Anchorblock
4339 * @typedef Elm_Entry_Anchorblock_Info
4341 * The info sent in the callback for "anchor,clicked" signals emitted by
4342 * the Anchorblock widget.
4344 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
4346 * @struct _Elm_Entry_Anchorblock_Info
4348 * The info sent in the callback for "anchor,clicked" signals emitted by
4349 * the Anchorblock widget.
4351 struct _Elm_Entry_Anchorblock_Info
4353 const char *name; /**< Name of the anchor, as indicated in its href
4355 int button; /**< The mouse button used to click on it */
4356 Evas_Object *hover; /**< The hover object to use for the popup */
4358 Evas_Coord x, y, w, h;
4359 } anchor, /**< Geometry selection of text used as anchor */
4360 hover_parent; /**< Geometry of the object used as parent by the
4362 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4363 for content on the left side of
4364 the hover. Before calling the
4365 callback, the widget will make the
4366 necessary calculations to check
4367 which sides are fit to be set with
4368 content, based on the position the
4369 hover is activated and its distance
4370 to the edges of its parent object
4372 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4373 the right side of the hover.
4374 See @ref hover_left */
4375 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4376 of the hover. See @ref hover_left */
4377 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4378 below the hover. See @ref
4382 * Add a new Anchorblock object
4384 * @param parent The parent object
4385 * @return The new object or NULL if it cannot be created
4387 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4389 * Set the text to show in the anchorblock
4391 * Sets the text of the anchorblock to @p text. This text can include markup
4392 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
4393 * of text that will be specially styled and react to click events, ended
4394 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
4395 * "anchor,clicked" signal that you can attach a callback to with
4396 * evas_object_smart_callback_add(). The name of the anchor given in the
4397 * event info struct will be the one set in the href attribute, in this
4400 * Other markup can be used to style the text in different ways, but it's
4401 * up to the style defined in the theme which tags do what.
4402 * @deprecated use elm_object_text_set() instead.
4404 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4406 * Get the markup text set for the anchorblock
4408 * Retrieves the text set on the anchorblock, with markup tags included.
4410 * @param obj The anchorblock object
4411 * @return The markup text set or @c NULL if nothing was set or an error
4413 * @deprecated use elm_object_text_set() instead.
4415 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4417 * Set the parent of the hover popup
4419 * Sets the parent object to use by the hover created by the anchorblock
4420 * when an anchor is clicked. See @ref Hover for more details on this.
4422 * @param obj The anchorblock object
4423 * @param parent The object to use as parent for the hover
4425 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4427 * Get the parent of the hover popup
4429 * Get the object used as parent for the hover created by the anchorblock
4430 * widget. See @ref Hover for more details on this.
4431 * If no parent is set, the same anchorblock object will be used.
4433 * @param obj The anchorblock object
4434 * @return The object used as parent for the hover, NULL if none is set.
4436 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4438 * Set the style that the hover should use
4440 * When creating the popup hover, anchorblock will request that it's
4441 * themed according to @p style.
4443 * @param obj The anchorblock object
4444 * @param style The style to use for the underlying hover
4446 * @see elm_object_style_set()
4448 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4450 * Get the style that the hover should use
4452 * Get the style the hover created by anchorblock will use.
4454 * @param obj The anchorblock object
4455 * @return The style to use by the hover. NULL means the default is used.
4457 * @see elm_object_style_set()
4459 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4461 * Ends the hover popup in the anchorblock
4463 * When an anchor is clicked, the anchorblock widget will create a hover
4464 * object to use as a popup with user provided content. This function
4465 * terminates this popup, returning the anchorblock to its normal state.
4467 * @param obj The anchorblock object
4469 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4471 * Appends a custom item provider to the given anchorblock
4473 * Appends the given function to the list of items providers. This list is
4474 * called, one function at a time, with the given @p data pointer, the
4475 * anchorblock object and, in the @p item parameter, the item name as
4476 * referenced in its href string. Following functions in the list will be
4477 * called in order until one of them returns something different to NULL,
4478 * which should be an Evas_Object which will be used in place of the item
4481 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4482 * href=item/name\>\</item\>
4484 * @param obj The anchorblock object
4485 * @param func The function to add to the list of providers
4486 * @param data User data that will be passed to the callback function
4488 * @see elm_entry_item_provider_append()
4490 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);
4492 * Prepend a custom item provider to the given anchorblock
4494 * Like elm_anchorblock_item_provider_append(), but it adds the function
4495 * @p func to the beginning of the list, instead of the end.
4497 * @param obj The anchorblock object
4498 * @param func The function to add to the list of providers
4499 * @param data User data that will be passed to the callback function
4501 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);
4503 * Remove a custom item provider from the list of the given anchorblock
4505 * Removes the function and data pairing that matches @p func and @p data.
4506 * That is, unless the same function and same user data are given, the
4507 * function will not be removed from the list. This allows us to add the
4508 * same callback several times, with different @p data pointers and be
4509 * able to remove them later without conflicts.
4511 * @param obj The anchorblock object
4512 * @param func The function to remove from the list
4513 * @param data The data matching the function to remove from the list
4515 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);
4521 * @defgroup Bubble Bubble
4523 * @brief The Bubble is a widget to show text similarly to how speech is
4524 * represented in comics.
4526 * The bubble widget contains 5 important visual elements:
4527 * @li The frame is a rectangle with rounded rectangles and an "arrow".
4528 * @li The @p icon is an image to which the frame's arrow points to.
4529 * @li The @p label is a text which appears to the right of the icon if the
4530 * corner is "top_left" or "bottom_left" and is right aligned to the frame
4532 * @li The @p info is a text which appears to the right of the label. Info's
4533 * font is of a ligther color than label.
4534 * @li The @p content is an evas object that is shown inside the frame.
4536 * The position of the arrow, icon, label and info depends on which corner is
4537 * selected. The four available corners are:
4538 * @li "top_left" - Default
4541 * @li "bottom_right"
4543 * Signals that you can add callbacks for are:
4544 * @li "clicked" - This is called when a user has clicked the bubble.
4546 * For an example of using a buble see @ref bubble_01_example_page "this".
4551 * Add a new bubble to the parent
4553 * @param parent The parent object
4554 * @return The new object or NULL if it cannot be created
4556 * This function adds a text bubble to the given parent evas object.
4558 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4560 * Set the label of the bubble
4562 * @param obj The bubble object
4563 * @param label The string to set in the label
4565 * This function sets the title of the bubble. Where this appears depends on
4566 * the selected corner.
4567 * @deprecated use elm_object_text_set() instead.
4569 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4571 * Get the label of the bubble
4573 * @param obj The bubble object
4574 * @return The string of set in the label
4576 * This function gets the title of the bubble.
4577 * @deprecated use elm_object_text_set() instead.
4579 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4581 * Set the info of the bubble
4583 * @param obj The bubble object
4584 * @param info The given info about the bubble
4586 * This function sets the info of the bubble. Where this appears depends on
4587 * the selected corner.
4588 * @deprecated use elm_object_text_set() instead.
4590 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
4592 * Get the info of the bubble
4594 * @param obj The bubble object
4596 * @return The "info" string of the bubble
4598 * This function gets the info text.
4599 * @deprecated use elm_object_text_set() instead.
4601 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4603 * Set the content to be shown in the bubble
4605 * Once the content object is set, a previously set one will be deleted.
4606 * If you want to keep the old content object, use the
4607 * elm_bubble_content_unset() function.
4609 * @param obj The bubble object
4610 * @param content The given content of the bubble
4612 * This function sets the content shown on the middle of the bubble.
4614 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4616 * Get the content shown in the bubble
4618 * Return the content object which is set for this widget.
4620 * @param obj The bubble object
4621 * @return The content that is being used
4623 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4625 * Unset the content shown in the bubble
4627 * Unparent and return the content object which was set for this widget.
4629 * @param obj The bubble object
4630 * @return The content that was being used
4632 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4634 * Set the icon of the bubble
4636 * Once the icon object is set, a previously set one will be deleted.
4637 * If you want to keep the old content object, use the
4638 * elm_icon_content_unset() function.
4640 * @param obj The bubble object
4641 * @param icon The given icon for the bubble
4643 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4645 * Get the icon of the bubble
4647 * @param obj The bubble object
4648 * @return The icon for the bubble
4650 * This function gets the icon shown on the top left of bubble.
4652 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4654 * Unset the icon of the bubble
4656 * Unparent and return the icon object which was set for this widget.
4658 * @param obj The bubble object
4659 * @return The icon that was being used
4661 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4663 * Set the corner of the bubble
4665 * @param obj The bubble object.
4666 * @param corner The given corner for the bubble.
4668 * This function sets the corner of the bubble. The corner will be used to
4669 * determine where the arrow in the frame points to and where label, icon and
4672 * Possible values for corner are:
4673 * @li "top_left" - Default
4676 * @li "bottom_right"
4678 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
4680 * Get the corner of the bubble
4682 * @param obj The bubble object.
4683 * @return The given corner for the bubble.
4685 * This function gets the selected corner of the bubble.
4687 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4689 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
4690 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4697 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4698 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
4699 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4700 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
4701 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
4702 /* smart callbacks called:
4703 * "clicked" - the user clicked the icon
4704 * "drag,start" - Someone started dragging the image out of the object
4705 * "drag,end" - Dragged item was dropped (somewhere)
4709 /** @defgroup Elm_Gesture_Layer Gesture Layer */
4711 * @enum _Elm_Gesture_Types
4712 * Emum of supported gesture types.
4713 * @ingroup Elm_Gesture_Layer
4715 enum _Elm_Gesture_Types
4717 ELM_GESTURE_FIRST = 0,
4719 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
4720 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
4721 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
4722 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
4724 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
4726 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
4727 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
4729 ELM_GESTURE_ZOOM, /**< Zoom */
4730 ELM_GESTURE_ROTATE, /**< Rotate */
4736 * @typedef Elm_Gesture_Types
4737 * Type for Emum of supported gesture types.
4738 * @ingroup Elm_Gesture_Layer
4740 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
4743 * @enum _Elm_Gesture_State
4744 * Emum of gesture states.
4745 * @ingroup Elm_Gesture_Layer
4747 enum _Elm_Gesture_State
4749 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
4750 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
4751 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
4752 ELM_GESTURE_STATE_END, /**< Gesture completed */
4753 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
4756 * @typedef Elm_Gesture_State
4758 * @ingroup Elm_Gesture_Layer
4760 typedef enum _Elm_Gesture_State Elm_Gesture_State;
4763 * @struct _Elm_Gesture_Taps_Info
4764 * Struct holds taps info for user
4765 * @ingroup Elm_Gesture_Layer
4767 struct _Elm_Gesture_Taps_Info
4769 Evas_Coord x, y; /**< Holds center point between fingers */
4770 unsigned int n; /**< Number of fingers tapped */
4771 unsigned int timestamp; /**< event timestamp */
4775 * @typedef Elm_Gesture_Taps_Info
4776 * holds taps info for user
4777 * @ingroup Elm_Gesture_Layer
4779 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
4782 * @struct _Elm_Gesture_Momentum_Info
4783 * Struct holds momentum info for user
4784 * x1 and y1 are not necessarily in sync
4785 * x1 holds x value of x direction starting point
4786 * and same holds for y1.
4787 * This is noticeable when doing V-shape movement
4788 * @ingroup Elm_Gesture_Layer
4790 struct _Elm_Gesture_Momentum_Info
4791 { /* Report line ends, timestamps, and momentum computed */
4792 Evas_Coord x1; /**< Final-swipe direction starting point on X */
4793 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
4794 Evas_Coord x2; /**< Final-swipe direction ending point on X */
4795 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
4797 unsigned int tx; /**< Timestamp of start of final x-swipe */
4798 unsigned int ty; /**< Timestamp of start of final y-swipe */
4800 Evas_Coord mx; /**< Momentum on X */
4801 Evas_Coord my; /**< Momentum on Y */
4805 * @typedef Elm_Gesture_Momentum_Info
4806 * holds momentum info for user
4807 * @ingroup Elm_Gesture_Layer
4809 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
4812 * @struct _Elm_Gesture_Line_Info
4813 * Struct holds line info for user
4814 * @ingroup Elm_Gesture_Layer
4816 struct _Elm_Gesture_Line_Info
4817 { /* Report line ends, timestamps, and momentum computed */
4818 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
4819 unsigned int n; /**< Number of fingers (lines) */
4820 /* FIXME should be radians, bot degrees */
4821 double angle; /**< Angle (direction) of lines */
4825 * @typedef _Elm_Gesture_Line_Info
4826 * Holds line info for user
4827 * @ingroup Elm_Gesture_Layer
4829 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
4832 * @struct _Elm_Gesture_Zoom_Info
4833 * Struct holds zoom info for user
4834 * @ingroup Elm_Gesture_Layer
4836 struct _Elm_Gesture_Zoom_Info
4838 Evas_Coord x, y; /**< Holds zoom center point reported to user */
4839 Evas_Coord radius; /**< Holds radius between fingers reported to user */
4840 double zoom; /**< Zoom value: 1.0 means no zoom */
4841 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
4845 * @typedef Elm_Gesture_Zoom_Info
4846 * Holds zoom info for user
4847 * @ingroup Elm_Gesture_Layer
4849 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
4852 * @struct _Elm_Gesture_Rotate_Info
4853 * Struct holds rotation info for user
4854 * @ingroup Elm_Gesture_Layer
4856 struct _Elm_Gesture_Rotate_Info
4858 Evas_Coord x, y; /**< Holds zoom center point reported to user */
4859 Evas_Coord radius; /**< Holds radius between fingers reported to user */
4860 double base_angle; /**< Holds start-angle */
4861 double angle; /**< Rotation value: 0.0 means no rotation */
4862 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
4866 * @typedef Elm_Gesture_Rotate_Info
4867 * Holds rotation info for user
4868 * @ingroup Elm_Gesture_Layer
4870 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
4873 * @typedef Elm_Gesture_Event_Cb
4874 * User callback used to stream gesture info from gesture layer
4875 * @param data user data
4876 * @param event_info gesture report info
4877 * Returns a flag field to be applied on the causing event.
4878 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
4879 * upon the event, in an irreversible way.
4881 * @ingroup Elm_Gesture_Layer
4883 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
4886 * Use function to set callbacks to be notified about
4887 * change of state of gesture.
4888 * When a user registers a callback with this function
4889 * this means this gesture has to be tested.
4891 * When ALL callbacks for a gesture are set to NULL
4892 * it means user isn't interested in gesture-state
4893 * and it will not be tested.
4895 * @param obj Pointer to gesture-layer.
4896 * @param idx The gesture you would like to track its state.
4897 * @param cb callback function pointer.
4898 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
4899 * @param data user info to be sent to callback (usually, Smart Data)
4901 * @ingroup Elm_Gesture_Layer
4903 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);
4906 * Call this function to get repeat-events settings.
4908 * @param obj Pointer to gesture-layer.
4910 * @return repeat events settings.
4911 * @see elm_gesture_layer_hold_events_set()
4912 * @ingroup Elm_Gesture_Layer
4914 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4917 * This function called in order to make gesture-layer repeat events.
4918 * Set this of you like to get the raw events only if gestures were not detected.
4919 * Clear this if you like gesture layer to fwd events as testing gestures.
4921 * @param obj Pointer to gesture-layer.
4922 * @param r Repeat: TRUE/FALSE
4924 * @ingroup Elm_Gesture_Layer
4926 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
4929 * This function sets step-value for zoom action.
4930 * Set step to any positive value.
4931 * Cancel step setting by setting to 0.0
4933 * @param obj Pointer to gesture-layer.
4934 * @param s new zoom step value.
4936 * @ingroup Elm_Gesture_Layer
4938 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4941 * This function sets step-value for rotate action.
4942 * Set step to any positive value.
4943 * Cancel step setting by setting to 0.0
4945 * @param obj Pointer to gesture-layer.
4946 * @param s new roatate step value.
4948 * @ingroup Elm_Gesture_Layer
4950 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4953 * This function called to attach gesture-layer to an Evas_Object.
4954 * @param obj Pointer to gesture-layer.
4955 * @param t Pointer to underlying object (AKA Target)
4957 * @return TRUE, FALSE on success, failure.
4959 * @ingroup Elm_Gesture_Layer
4961 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
4964 * Call this function to construct a new gesture-layer object.
4965 * This does not activate the gesture layer. You have to
4966 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
4968 * @param parent the parent object.
4970 * @return Pointer to new gesture-layer object.
4972 * @ingroup Elm_Gesture_Layer
4974 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4977 typedef enum _Elm_Thumb_Animation_Setting
4979 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
4980 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
4981 ELM_THUMB_ANIMATION_STOP,
4982 ELM_THUMB_ANIMATION_LAST
4983 } Elm_Thumb_Animation_Setting;
4985 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4986 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
4987 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
4988 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4989 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4990 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
4991 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4992 EAPI void *elm_thumb_ethumb_client_get(void);
4993 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
4994 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
4995 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4996 /* available styles:
5000 /* smart callbacks called:
5001 * "clicked" - This is called when a user has clicked the thumb without dragging around.
5002 * "clicked,double" - This is called when a user has double-clicked the thumb.
5003 * "press" - This is called when a user has pressed down the thumb.
5004 * "generate,start" - The thumbnail generation started.
5005 * "generate,stop" - The generation process stopped.
5006 * "generate,error" - The generation failed.
5007 * "load,error" - The thumbnail image loading failed.
5011 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5012 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5013 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5014 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5015 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5016 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5017 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5018 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5019 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5020 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5021 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
5022 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5023 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5024 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5025 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5026 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);
5027 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
5028 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5029 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
5030 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
5031 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);
5032 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);
5033 /* smart callbacks called:
5034 * "clicked" - the user clicked the hoversel button and popped up the sel
5035 * "selected" - an item in the hoversel list is selected
5036 * "dismissed" - the hover is dismissed
5040 typedef enum _Elm_Toolbar_Shrink_Mode
5042 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
5043 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
5044 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
5045 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
5046 } Elm_Toolbar_Shrink_Mode;
5048 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
5049 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
5051 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5052 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
5053 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5054 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5055 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5056 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5057 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5058 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);
5059 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);
5060 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);
5061 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);
5062 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5063 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5064 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5065 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5066 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5067 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
5068 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5069 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5070 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5071 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
5072 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5073 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
5074 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5075 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5076 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5077 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5078 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
5079 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5080 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5081 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5082 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5083 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
5084 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5085 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
5086 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5087 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5088 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5089 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5090 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5091 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5092 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5093 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
5094 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5095 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
5096 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5097 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);
5098 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5099 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5100 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5101 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5102 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5103 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5104 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
5105 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);
5106 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5107 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5108 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5109 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5110 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5111 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5112 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5113 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5114 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5115 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5116 /* smart callbacks called:
5117 * "clicked" - when the user clicks on a toolbar item and becomes selected
5119 /* available styles:
5121 * transparent (no background or shadow, just show the provided content)
5125 EAPI double elm_tooltip_delay_get(void);
5126 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
5127 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
5128 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
5129 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
5130 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);
5131 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5132 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5133 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5134 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
5135 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5136 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5137 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5138 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5139 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5140 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5143 EAPI int elm_cursor_engine_only_get(void);
5144 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
5147 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
5148 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5149 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5150 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5151 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
5152 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
5153 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5154 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5155 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);
5156 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
5157 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5158 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
5159 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5160 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5161 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5162 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5163 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5164 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5165 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
5166 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5167 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5168 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5169 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5170 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
5171 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5172 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5173 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5174 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5175 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5176 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5178 /* smart callbacks called:
5179 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
5183 typedef enum _Elm_List_Mode
5185 ELM_LIST_COMPRESS = 0,
5191 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
5192 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5193 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);
5194 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);
5195 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);
5196 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);
5197 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);
5198 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5199 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
5200 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5201 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5202 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5203 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5204 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5205 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5206 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5207 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5208 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5209 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5210 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5211 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
5212 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5213 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5214 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5215 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5216 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5217 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5218 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5219 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5220 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5221 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
5222 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5223 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
5224 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5225 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5226 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5227 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5228 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5229 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5230 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);
5231 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5232 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5233 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5234 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5235 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5236 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5237 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5238 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5239 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5240 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5241 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5242 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5243 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5244 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5245 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5246 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);
5247 /* smart callbacks called:
5248 * "clicked,double" - when the user double-clicked an item
5249 * "selected" - when the user selected an item
5250 * "unselected" - when the user selected an item
5251 * "longpressed" - an item in the hoversel list is long-pressed
5252 * "scroll,edge,top" - the list is scrolled until the top edge
5253 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
5254 * "scroll,edge,left" - the list is scrolled until the left edge
5255 * "scroll,edge,right" - the list is scrolled until the right edge
5259 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5260 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5261 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5262 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5263 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5264 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5265 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
5266 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5267 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5268 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5269 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5270 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5271 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5272 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
5273 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5274 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);
5275 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);
5276 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5277 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5278 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5279 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5280 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5281 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5282 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5283 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5284 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
5285 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5286 /* smart callbacks called:
5287 * "changed" - Whenever the slider value is changed by the user.
5288 * "slider,drag,start" - dragging the slider indicator around has started
5289 * "slider,drag,stop" - dragging the slider indicator around has stopped
5290 * "delay,changed" - A short time after the value is changed by the user.
5291 * This will be called only when the user stops dragging for a very short
5292 * period or when they release their finger/mouse, so it avoids possibly
5293 * expensive reactions to the value change.
5300 * @addtogroup Actionslider Actionslider
5302 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
5303 * properties. The indicator is the element the user drags to choose a label.
5304 * When the position is set with magnet, when released the indicator will be
5305 * moved to it if it's nearest the magnetized position.
5307 * @note By default all positions are set as enabled.
5309 * Signals that you can add callbacks for are:
5311 * "selected" - when user selects an enabled position (the label is passed
5314 * "pos_changed" - when the indicator reaches any of the positions("left",
5315 * "right" or "center").
5317 * See an example of actionslider usage @ref actionslider_example_page "here"
5321 typedef enum _Elm_Actionslider_Indicator_Pos
5323 ELM_ACTIONSLIDER_INDICATOR_NONE,
5324 ELM_ACTIONSLIDER_INDICATOR_LEFT,
5325 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
5326 ELM_ACTIONSLIDER_INDICATOR_CENTER
5327 } Elm_Actionslider_Indicator_Pos;
5329 typedef enum _Elm_Actionslider_Magnet_Pos
5331 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
5332 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
5333 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
5334 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
5335 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
5336 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
5337 } Elm_Actionslider_Magnet_Pos;
5339 typedef enum _Elm_Actionslider_Label_Pos
5341 ELM_ACTIONSLIDER_LABEL_LEFT,
5342 ELM_ACTIONSLIDER_LABEL_RIGHT,
5343 ELM_ACTIONSLIDER_LABEL_CENTER,
5344 ELM_ACTIONSLIDER_LABEL_BUTTON
5345 } Elm_Actionslider_Label_Pos;
5347 /* smart callbacks called:
5348 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
5352 * Add a new actionslider to the parent.
5354 * @param parent The parent object
5355 * @return The new actionslider object or NULL if it cannot be created
5357 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5360 * Set actionslider label.
5362 * @param[in] obj The actionslider object
5363 * @param[in] pos The position of the label.
5364 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
5365 * @param label The label which is going to be set.
5367 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
5369 * Get actionslider labels.
5371 * @param obj The actionslider object
5372 * @param left_label A char** to place the left_label of @p obj into.
5373 * @param center_label A char** to place the center_label of @p obj into.
5374 * @param right_label A char** to place the right_label of @p obj into.
5376 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);
5378 * Get actionslider selected label.
5380 * @param obj The actionslider object
5381 * @return The selected label
5383 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5385 * Set actionslider indicator position.
5387 * @param obj The actionslider object.
5388 * @param pos The position of the indicator.
5390 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
5392 * Get actionslider indicator position.
5394 * @param obj The actionslider object.
5395 * @return The position of the indicator.
5397 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5399 * Set actionslider magnet position. To make multiple positions magnets @c or
5400 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
5402 * @param obj The actionslider object.
5403 * @param pos Bit mask indicating the magnet positions.
5405 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5407 * Get actionslider magnet position.
5409 * @param obj The actionslider object.
5410 * @return The positions with magnet property.
5412 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5414 * Set actionslider enabled position. To set multiple positions as enabled @c or
5415 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
5417 * @note All the positions are enabled by default.
5419 * @param obj The actionslider object.
5420 * @param pos Bit mask indicating the enabled positions.
5422 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5424 * Get actionslider enabled position.
5426 * @param obj The actionslider object.
5427 * @return The enabled positions.
5429 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5431 * Set the label used on the indicator.
5433 * @param obj The actionslider object
5434 * @param label The label to be set on the indicator.
5435 * @deprecated use elm_object_text_set() instead.
5437 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5439 * Get the label used on the indicator object.
5441 * @param obj The actionslider object
5442 * @return The indicator label
5443 * @deprecated use elm_object_text_get() instead.
5445 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5448 * Hold actionslider object movement.
5450 * @param[in] obj The actionslider object
5451 * @param[in] flag Actionslider hold/release
5452 * (EINA_TURE = hold/EIN_FALSE = release)
5454 * @ingroup Actionslider
5456 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
5464 typedef enum _Elm_Genlist_Item_Flags
5466 ELM_GENLIST_ITEM_NONE = 0,
5467 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
5468 ELM_GENLIST_ITEM_GROUP = (1 << 1)
5469 } Elm_Genlist_Item_Flags;
5470 typedef enum _Elm_Genlist_Item_Field_Flags
5472 ELM_GENLIST_ITEM_FIELD_ALL = 0,
5473 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
5474 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
5475 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
5476 } Elm_Genlist_Item_Field_Flags;
5477 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
5478 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
5479 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
5480 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
5481 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
5482 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
5483 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
5484 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
5486 struct _Elm_Genlist_Item_Class
5488 const char *item_style;
5490 GenlistItemLabelGetFunc label_get;
5491 GenlistItemIconGetFunc icon_get;
5492 GenlistItemStateGetFunc state_get;
5493 GenlistItemDelFunc del;
5494 GenlistItemMovedFunc moved;
5496 const char *edit_item_style;
5497 const char *mode_item_style;
5499 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5500 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5501 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5502 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5503 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5504 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5505 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5506 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5507 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5508 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5509 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
5510 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5511 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
5512 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5513 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5514 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5515 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5516 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5517 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
5518 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5519 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5520 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5521 /* operations to add items */
5522 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);
5523 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);
5524 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);
5525 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);
5526 /* operations to retrieve existing items */
5527 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5528 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5529 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5530 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);
5531 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5532 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5533 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5534 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);
5535 /* available item styles:
5537 * default_style - The text part is a textblock
5539 * icon_top_text_bottom
5541 /* Genlist Item operation */
5542 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5543 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5544 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5545 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5546 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5547 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5548 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5549 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
5550 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5551 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5552 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5553 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5554 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
5555 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5556 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5557 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5558 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5559 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5560 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5561 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5562 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5563 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5564 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
5565 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5566 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5567 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5568 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
5569 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
5570 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5571 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
5572 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);
5573 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5574 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5575 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5576 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5577 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5578 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5579 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5580 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5581 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5582 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5583 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
5584 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
5585 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5586 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5587 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5588 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5589 /* Signals that you can add callbacks for are:
5590 * "clicked,double" - This is called when a user has double-clicked an item.
5591 * The event_info parameter is the genlist item that was
5593 * "selected" - This is called when a user has made an item selected. The
5594 * event_info parameter is the genlist item that was selected.
5595 * "unselected" - This is called when a user has made an item unselected. The
5596 * event_info parameter is the genlist item that was unselected.
5597 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
5598 * and the item is now meant to be expanded. The event_info parameter is the
5599 * genlist item that was indicated to expand. It is the job of this callback
5600 * to then fill in the child items.
5601 * "contracted" - This is called when elm_genlist_item_expanded_set() is called
5602 * and the item is now meant to be contracted. The event_info parameter is
5603 * the genlist item that was indicated to contract. It is the job of this
5604 * callback to then delete the child items.
5605 * "expand,request" - This is called when a user has indicated they want to
5606 * expand a tree branch item. The callback should decide if the item can
5607 * expand (has any children) and then call elm_genlist_item_expanded_set()
5608 * appropriately to set the state. The event_info parameter is the genlist
5609 * item that was indicated to expand.
5610 * "contract,request" - This is called when a user has indicated they want to
5611 * contract a tree branch item. The callback should decide if the item can
5612 * contract (has any children) and then call elm_genlist_item_expanded_set()
5613 * appropriately to set the state. The event_info parameter is the genlist
5614 * item that was indicated to contract.
5615 * "realized" - This is called when the item in the list is created as a real
5616 * evas object. event_info parameter is the genlist item that was created.
5617 * The object may be deleted at any time, so it is up to the caller to
5618 * not use the object pointer from elm_genlist_item_object_get() in a way
5619 * where it may point to freed objects.
5620 * "unrealized" - This is called just before an item is unrealized. After
5621 * this call icon objects provided will be deleted and the item object
5622 * itself delete or be put into a floating cache.
5623 * "drag,start,up" - This is called when the item in the list has been dragged
5624 * (not scrolled) up.
5625 * "drag,start,down" - This is called when the item in the list has been dragged
5626 * (not scrolled) down.
5627 * "drag,start,left" - This is called when the item in the list has been dragged i
5628 * (not scrolled) left.
5629 * "drag,start,right" - This is called when the item in the list has been dragged
5630 * (not scrolled) right.
5631 * "drag,stop" - This is called when the item in the list has stopped being
5633 * "drag" - This is called when the item in the list is being dragged.
5634 * "longpressed" - This is called when the item is pressed for a certain amount
5635 * of time. By default it's 1 second.
5636 * "scroll,edge,top" - This is called when the genlist is scrolled until the
5638 * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
5640 * "scroll,edge,left" - This is called when the genlist is scrolled until the
5642 * "scroll,edge,right" - This is called when the genlist is scrolled until the
5644 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
5646 * "multi,swipe,right" - This is called when the genlist is multi-touch swiped
5648 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
5649 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
5651 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
5653 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
5656 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
5657 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5658 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
5659 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5660 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
5661 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
5662 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5663 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5664 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5665 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5668 * @page tutorial_check Check example
5669 * @dontinclude check_example_01.c
5671 * This example will show 2 checkboxes, one with just a label and the second
5672 * one with both a label and an icon. This example also ilustrates how to
5673 * have the checkbox change the value of a variable and how to react to those
5676 * We will start with the usual setup code:
5679 * And now we create our first checkbox, set its label, tell it to change
5680 * the value of @p value when the checkbox stats is changed and ask to be
5681 * notified of state changes:
5684 * For our second checkbox we are going to set an icon so we need to create
5687 * @note For simplicity we are using a rectangle as icon, but any evas object
5690 * And for our second checkbox we set the label, icon and state to true:
5693 * We now do some more setup:
5696 * And finally implement the callback that will be called when the first
5697 * checkbox's state changes. This callback will use @p data to print a
5700 * @note This work because @p data is @p value(from the main function) and @p
5701 * value is changed when the checkbox is changed.
5703 * Our example will look like this:
5704 * @image html screenshots/check_example_01.png
5705 * @image latex screenshots/check_example_01.eps
5707 * @example check_example_01.c
5710 * @defgroup Check Check
5712 * @brief The check widget allows for toggling a value between true and
5715 * Check objects are a lot like radio objects in layout and functionality
5716 * except they do not work as a group, but independently and only toggle the
5717 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
5718 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
5719 * returns the current state. For convenience, like the radio objects, you
5720 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
5723 * Signals that you can add callbacks for are:
5724 * "changed" - This is called whenever the user changes the state of one of
5725 * the check object(event_info is NULL).
5727 * @ref tutorial_check should give you a firm grasp of how to use this widget.
5731 * @brief Add a new Check object
5733 * @param parent The parent object
5734 * @return The new object or NULL if it cannot be created
5736 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5738 * @brief Set the text label of the check object
5740 * @param obj The check object
5741 * @param label The text label string in UTF-8
5743 * @deprecated use elm_object_text_set() instead.
5745 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5747 * @brief Get the text label of the check object
5749 * @param obj The check object
5750 * @return The text label string in UTF-8
5752 * @deprecated use elm_object_text_get() instead.
5754 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5756 * @brief Set the icon object of the check object
5758 * @param obj The check object
5759 * @param icon The icon object
5761 * Once the icon object is set, a previously set one will be deleted.
5762 * If you want to keep that old content object, use the
5763 * elm_check_icon_unset() function.
5765 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5767 * @brief Get the icon object of the check object
5769 * @param obj The check object
5770 * @return The icon object
5772 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5774 * @brief Unset the icon used for the check object
5776 * @param obj The check object
5777 * @return The icon object that was being used
5779 * Unparent and return the icon object which was set for this widget.
5781 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5783 * @brief Set the on/off state of the check object
5785 * @param obj The check object
5786 * @param state The state to use (1 == on, 0 == off)
5788 * This sets the state of the check. If set
5789 * with elm_check_state_pointer_set() the state of that variable is also
5790 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
5792 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5794 * @brief Get the state of the check object
5796 * @param obj The check object
5797 * @return The boolean state
5799 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5801 * @brief Set a convenience pointer to a boolean to change
5803 * @param obj The check object
5804 * @param statep Pointer to the boolean to modify
5806 * This sets a pointer to a boolean, that, in addition to the check objects
5807 * state will also be modified directly. To stop setting the object pointed
5808 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
5809 * then when this is called, the check objects state will also be modified to
5810 * reflect the value of the boolean @p statep points to, just like calling
5811 * elm_check_state_set().
5813 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5819 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5820 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5821 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5822 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5823 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5824 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5825 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
5826 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5827 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5828 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5829 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5830 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
5831 /* smart callbacks called:
5832 * "changed" - when the radio status is changed
5836 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5837 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5838 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
5839 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5840 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5841 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5842 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
5843 EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
5845 /* available item styles:
5851 /* smart callbacks called:
5852 * "hide,finished" - when the previous page is hided
5855 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
5856 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
5857 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
5858 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
5859 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
5861 struct _Elm_Slideshow_Item_Class
5863 struct _Elm_Slideshow_Item_Class_Func
5865 SlideshowItemGetFunc get;
5866 SlideshowItemDelFunc del;
5870 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5871 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
5872 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);
5873 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5874 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
5875 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
5876 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5877 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
5878 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5879 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5880 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5881 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
5882 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5883 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5884 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5885 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5886 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5887 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5888 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
5889 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
5890 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5891 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
5892 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5893 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5894 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5895 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5896 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5897 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5898 /* smart callbacks called:
5899 * "changed" - when the slideshow switch to another item
5903 typedef enum _Elm_Fileselector_Mode
5905 ELM_FILESELECTOR_LIST = 0,
5906 ELM_FILESELECTOR_GRID,
5907 ELM_FILESELECTOR_LAST
5908 } Elm_Fileselector_Mode;
5910 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5911 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
5912 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5913 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
5914 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5915 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
5916 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5917 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5918 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
5919 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5920 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5921 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5922 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5923 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
5924 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5925 /* smart callbacks called:
5926 * "selected" - the user click on a file
5927 * "directory,open" - the list is populate with a new content. event_info is a directory.
5928 * "done" - the user click on the ok or cancel buttons
5932 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5933 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
5934 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5935 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5936 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5937 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5938 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5939 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5940 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5941 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5942 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5943 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5944 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5945 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5946 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5947 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5948 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5949 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5950 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5951 /* smart callbacks called:
5953 /* available item styles:
5955 * wheel (simple style, no text, no progression, only pulse is available)
5959 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5960 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5961 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5962 /* smart callbacks called:
5966 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5967 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
5968 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5969 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5970 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5971 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
5972 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5973 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5974 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5975 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
5976 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5977 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
5978 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5979 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
5980 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
5981 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5982 /* smart callbacks called:
5983 * "changed" - when the spinner value changes
5984 * "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).
5986 /* available item styles:
5988 * vertical (two up/down buttons at the right side and text left aligned)
5992 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
5994 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5995 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
5996 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5997 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5998 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5999 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6000 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
6001 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
6002 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
6003 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
6004 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);
6005 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
6006 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
6007 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6008 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6009 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
6010 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
6011 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6012 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
6013 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
6014 /* smart callbacks called:
6015 * "changed" - when the selected index item changes
6016 * "delay,changed" - when the selected index item changes, but after some small idle period
6017 * "selected" - when the user releases a finger and selects an item
6018 * "level,up" - when the user moves a finger from the first level to the second level
6019 * "level,down" - when the user moves a finger from the second level to the first level
6023 typedef enum _Elm_Photocam_Zoom_Mode
6025 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
6026 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
6027 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
6028 ELM_PHOTOCAM_ZOOM_MODE_LAST
6029 } Elm_Photocam_Zoom_Mode;
6031 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6032 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
6033 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6034 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
6035 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6036 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
6037 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6038 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
6039 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
6040 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
6041 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
6042 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6043 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6044 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6045 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6046 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6047 /* smart callbacks called:
6048 * "clicked" - when image clicked
6049 * "press" - when mouse/finger held down initially on image
6050 * "longpressed" - when mouse/finger held for long time on image
6051 * "clicked,double" - when mouse/finger double-clicked
6052 * "load" - when photo load begins
6053 * "loaded" - when photo load done
6054 * "load,detail" - when detailed image load begins
6055 * "loaded,detail" - when detailed image load done
6056 * "zoom,start" - when zooming started
6057 * "zoom,stop" - when zooming stopped
6058 * "zoom,change" - when auto zoom mode changed zoom level
6059 * "scroll - the content has been scrolled (moved)
6060 * "scroll,anim,start" - scrolling animation has started
6061 * "scroll,anim,stop" - scrolling animation has stopped
6062 * "scroll,drag,start" - dragging the contents around has started
6063 * "scroll,drag,stop" - dragging the contents around has stopped
6067 typedef enum _Elm_Map_Zoom_Mode
6069 ELM_MAP_ZOOM_MODE_MANUAL,
6070 ELM_MAP_ZOOM_MODE_AUTO_FIT,
6071 ELM_MAP_ZOOM_MODE_AUTO_FILL,
6072 ELM_MAP_ZOOM_MODE_LAST
6073 } Elm_Map_Zoom_Mode;
6075 typedef enum _Elm_Map_Route_Sources
6077 ELM_MAP_ROUTE_SOURCE_YOURS,
6078 ELM_MAP_ROUTE_SOURCE_MONAV,
6079 ELM_MAP_ROUTE_SOURCE_ORS,
6080 ELM_MAP_ROUTE_SOURCE_LAST
6081 } Elm_Map_Route_Sources;
6083 typedef enum _Elm_Map_Name_Sources
6085 ELM_MAP_NAME_SOURCE_NOMINATIM,
6086 ELM_MAP_NAME_SOURCE_LAST
6087 } Elm_Map_Name_Sources;
6089 typedef enum _Elm_Map_Route_Type
6091 ELM_MAP_ROUTE_TYPE_MOTOCAR,
6092 ELM_MAP_ROUTE_TYPE_BICYCLE,
6093 ELM_MAP_ROUTE_TYPE_FOOT,
6094 ELM_MAP_ROUTE_TYPE_LAST
6095 } Elm_Map_Route_Type;
6097 typedef enum _Elm_Map_Route_Method
6099 ELM_MAP_ROUTE_METHOD_FASTEST,
6100 ELM_MAP_ROUTE_METHOD_SHORTEST,
6101 ELM_MAP_ROUTE_METHOD_LAST
6102 } Elm_Map_Route_Method;
6104 typedef enum _Elm_Map_Name_Method
6106 ELM_MAP_NAME_METHOD_SEARCH,
6107 ELM_MAP_NAME_METHOD_REVERSE,
6108 ELM_MAP_NAME_METHOD_LAST
6109 } Elm_Map_Name_Method;
6111 typedef struct _Elm_Map_Marker Elm_Map_Marker;
6112 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
6113 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
6114 typedef struct _Elm_Map_Route Elm_Map_Route;
6115 typedef struct _Elm_Map_Name Elm_Map_Name;
6116 typedef struct _Elm_Map_Track Elm_Map_Track;
6118 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6119 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
6120 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6121 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
6123 typedef char *(*ElmMapModuleSourceFunc) (void);
6124 typedef int (*ElmMapModuleZoomMinFunc) (void);
6125 typedef int (*ElmMapModuleZoomMaxFunc) (void);
6126 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
6127 typedef int (*ElmMapModuleRouteSourceFunc) (void);
6128 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
6129 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
6130 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
6131 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
6133 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6134 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6135 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6136 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
6137 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6138 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
6139 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6140 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6141 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6142 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6143 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6144 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6145 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
6146 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);
6147 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);
6148 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6149 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
6150 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);
6151 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);
6152 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
6153 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6154 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
6155 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6156 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6157 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
6158 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6159 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6160 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
6161 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6162 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6163 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6164 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
6165 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6166 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6167 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
6168 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6169 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6170 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6171 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
6172 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
6173 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6174 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
6175 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6176 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
6177 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6178 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6179 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6180 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6181 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6182 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
6183 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6184 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);
6185 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6186 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
6187 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
6188 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6189 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6190 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6191 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6192 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
6193 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6194 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
6195 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);
6196 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6197 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6199 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
6201 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
6203 /* smart callbacks called:
6204 * "clicked" - when image clicked
6205 * "press" - when mouse/finger held down initially on image
6206 * "longpressed" - when mouse/finger held for long time on image
6207 * "clicked,double" - when mouse/finger double-clicked
6208 * "load,details" - when detailed image load begins
6209 * "loaded,details" - when detailed image load done
6210 * "zoom,start" - when zooming started
6211 * "zoom,stop" - when zooming stopped
6212 * "zoom,change" - when auto zoom mode changed zoom level
6213 * "scroll - the content has been scrolled (moved)
6214 * "scroll,anim,start" - scrolling animation has started
6215 * "scroll,anim,stop" - scrolling animation has stopped
6216 * "scroll,drag,start" - dragging the contents around has started
6217 * "scroll,drag,stop" - dragging the contents around has stopped
6221 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
6223 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
6225 EAPI double elm_route_lon_min_get(Evas_Object *obj);
6226 EAPI double elm_route_lat_min_get(Evas_Object *obj);
6227 EAPI double elm_route_lon_max_get(Evas_Object *obj);
6228 EAPI double elm_route_lat_max_get(Evas_Object *obj);
6232 typedef enum _Elm_Panel_Orient
6234 ELM_PANEL_ORIENT_TOP,
6235 ELM_PANEL_ORIENT_BOTTOM,
6236 ELM_PANEL_ORIENT_LEFT,
6237 ELM_PANEL_ORIENT_RIGHT,
6240 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6241 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
6242 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6243 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6244 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6245 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6246 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
6247 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6248 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
6254 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
6255 * Add events (move, start ...)
6257 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6258 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6259 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6260 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6261 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6262 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6263 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6264 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6265 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
6266 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6267 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6268 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
6269 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6272 typedef enum _Elm_Flip_Mode
6274 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
6275 ELM_FLIP_ROTATE_X_CENTER_AXIS,
6276 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
6277 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
6279 ELM_FLIP_CUBE_RIGHT,
6283 ELM_FLIP_PAGE_RIGHT,
6287 typedef enum _Elm_Flip_Interaction
6289 ELM_FLIP_INTERACTION_NONE,
6290 ELM_FLIP_INTERACTION_ROTATE,
6291 ELM_FLIP_INTERACTION_CUBE,
6292 ELM_FLIP_INTERACTION_PAGE
6293 } Elm_Flip_Interaction;
6294 typedef enum _Elm_Flip_Direction
6296 ELM_FLIP_DIRECTION_UP,
6297 ELM_FLIP_DIRECTION_DOWN,
6298 ELM_FLIP_DIRECTION_LEFT,
6299 ELM_FLIP_DIRECTION_RIGHT
6300 } Elm_Flip_Direction;
6302 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6303 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6304 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6305 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6306 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6307 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6308 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6309 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6310 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
6311 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
6312 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
6313 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
6314 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
6315 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
6316 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
6317 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
6318 /* smart callbacks called:
6319 * "animate,begin" - when a flip animation was started
6320 * "animate,done" - when a flip animation is finished
6324 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6325 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
6326 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6327 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
6328 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6329 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6330 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6331 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6332 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6333 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6334 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6335 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
6336 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
6337 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6338 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
6339 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6340 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6341 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6342 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
6343 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
6344 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6345 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6346 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6347 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6348 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
6349 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6350 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6351 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6352 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6353 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6354 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6355 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
6356 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
6357 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
6358 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6359 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);
6360 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6361 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6362 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);
6363 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6364 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);
6365 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
6366 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6367 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6368 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6369 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
6370 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6371 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6372 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6373 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);
6374 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);
6375 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);
6376 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);
6377 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);
6378 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);
6379 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
6380 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
6381 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
6382 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
6383 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6384 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
6385 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6386 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6387 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
6388 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
6389 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
6390 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
6391 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
6394 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6395 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6396 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6397 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6398 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6401 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6402 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6403 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6404 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6405 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6406 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6407 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
6408 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6409 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
6410 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6413 * @defgroup Flipselector Flip Selector
6415 * A flip selector is a widget to show a set of @b text items, one
6416 * at a time, with the same sheet switching style as the @ref Clock
6417 * "clock" widget, when one changes the current displaying sheet
6418 * (thus, the "flip" in the name).
6420 * User clicks to flip sheets which are @b held for some time will
6421 * make the flip selector to flip continuosly and automatically for
6422 * the user. The interval between flips will keep growing in time,
6423 * so that it helps the user to reach an item which is distant from
6424 * the current selection.
6426 * Smart callbacks one can register to:
6427 * - @c "selected" - when the widget's selected text item is changed
6428 * - @c "overflowed" - when the widget's current selection is changed
6429 * from the first item in its list to the last
6430 * - @c "underflowed" - when the widget's current selection is changed
6431 * from the last item in its list to the first
6433 * Available styles for it:
6436 * Here is an example on its usage:
6437 * @li @ref flipselector_example
6441 * @addtogroup Flipselector
6445 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
6448 * Add a new flip selector widget to the given parent Elementary
6449 * (container) widget
6451 * @param parent The parent object
6452 * @return a new flip selector widget handle or @c NULL, on errors
6454 * This function inserts a new flip selector widget on the canvas.
6456 * @ingroup Flipselector
6458 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6461 * Programmatically select the next item of a flip selector widget
6463 * @param obj The flipselector object
6465 * @note The selection will be animated. Also, if it reaches the
6466 * end of its list of member items, it will continue with the first
6469 * @ingroup Flipselector
6471 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6474 * Programmatically select the previous item of a flip selector
6477 * @param obj The flipselector object
6479 * @note The selection will be animated. Also, if it reaches the
6480 * beginning of its list of member items, it will continue with the
6481 * last one backwards.
6483 * @ingroup Flipselector
6485 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6488 * Append a (text) item to a flip selector widget
6490 * @param obj The flipselector object
6491 * @param label The (text) label of the new item
6492 * @param func Convenience callback function to take place when
6494 * @param data Data passed to @p func, above
6495 * @return A handle to the item added or @c NULL, on errors
6497 * The widget's list of labels to show will be appended with the
6498 * given value. If the user wishes so, a callback function pointer
6499 * can be passed, which will get called when this same item is
6502 * @note The current selection @b won't be modified by appending an
6503 * element to the list.
6505 * @note The maximum length of the text label is going to be
6506 * determined <b>by the widget's theme</b>. Strings larger than
6507 * that value are going to be @b truncated.
6509 * @ingroup Flipselector
6511 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6514 * Prepend a (text) item to a flip selector widget
6516 * @param obj The flipselector object
6517 * @param label The (text) label of the new item
6518 * @param func Convenience callback function to take place when
6520 * @param data Data passed to @p func, above
6521 * @return A handle to the item added or @c NULL, on errors
6523 * The widget's list of labels to show will be prepended with the
6524 * given value. If the user wishes so, a callback function pointer
6525 * can be passed, which will get called when this same item is
6528 * @note The current selection @b won't be modified by prepending
6529 * an element to the list.
6531 * @note The maximum length of the text label is going to be
6532 * determined <b>by the widget's theme</b>. Strings larger than
6533 * that value are going to be @b truncated.
6535 * @ingroup Flipselector
6537 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6540 * Get the internal list of items in a given flip selector widget.
6542 * @param obj The flipselector object
6543 * @return The list of items (#Elm_Flipselector_Item as data) or @c
6546 * This list is @b not to be modified in any way and must not be
6547 * freed. Use the list members with functions like
6548 * elm_flipselector_item_label_set(),
6549 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
6550 * elm_flipselector_item_del(),
6551 * elm_flipselector_item_selected_get(),
6552 * elm_flipselector_item_selected_set().
6554 * @warning This list is only valid until @p obj object's internal
6555 * items list is changed. It should be fetched again with another
6556 * call to this function when changes happen.
6558 * @ingroup Flipselector
6560 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6563 * Get the first item in the given flip selector widget's list of
6566 * @param obj The flipselector object
6567 * @return The first item or @c NULL, if it has no items (and on
6570 * @see elm_flipselector_item_append()
6571 * @see elm_flipselector_last_item_get()
6573 * @ingroup Flipselector
6575 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6578 * Get the last item in the given flip selector widget's list of
6581 * @param obj The flipselector object
6582 * @return The last item or @c NULL, if it has no items (and on
6585 * @see elm_flipselector_item_prepend()
6586 * @see elm_flipselector_first_item_get()
6588 * @ingroup Flipselector
6590 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6593 * Get the currently selected item in a flip selector widget.
6595 * @param obj The flipselector object
6596 * @return The selected item or @c NULL, if the widget has no items
6599 * @ingroup Flipselector
6601 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6604 * Set whether a given flip selector widget's item should be the
6605 * currently selected one.
6607 * @param item The flip selector item
6608 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
6610 * This sets whether @p item is or not the selected (thus, under
6611 * display) one. If @p item is different than one under display,
6612 * the latter will be unselected. If the @p item is set to be
6613 * unselected, on the other hand, the @b first item in the widget's
6614 * internal members list will be the new selected one.
6616 * @see elm_flipselector_item_selected_get()
6618 * @ingroup Flipselector
6620 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6623 * Get whether a given flip selector widget's item is the currently
6626 * @param item The flip selector item
6627 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6630 * @see elm_flipselector_item_selected_set()
6632 * @ingroup Flipselector
6634 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6637 * Delete a given item from a flip selector widget.
6639 * @param item The item to delete
6641 * @ingroup Flipselector
6643 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6646 * Get the label of a given flip selector widget's item.
6648 * @param item The item to get label from
6649 * @return The text label of @p item or @c NULL, on errors
6651 * @see elm_flipselector_item_label_set()
6653 * @ingroup Flipselector
6655 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6658 * Set the label of a given flip selector widget's item.
6660 * @param item The item to set label on
6661 * @param label The text label string, in UTF-8 encoding
6663 * @see elm_flipselector_item_label_get()
6665 * @ingroup Flipselector
6667 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6670 * Gets the item before @p item in a flip selector widget's
6671 * internal list of items.
6673 * @param item The item to fetch previous from
6674 * @return The item before the @p item, in its parent's list. If
6675 * there is no previous item for @p item or there's an
6676 * error, @c NULL is returned.
6678 * @see elm_flipselector_item_next_get()
6680 * @ingroup Flipselector
6682 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6685 * Gets the item after @p item in a flip selector widget's
6686 * internal list of items.
6688 * @param item The item to fetch next from
6689 * @return The item after the @p item, in its parent's list. If
6690 * there is no next item for @p item or there's an
6691 * error, @c NULL is returned.
6693 * @see elm_flipselector_item_next_get()
6695 * @ingroup Flipselector
6697 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6700 * Set the interval on time updates for an user mouse button hold
6701 * on a flip selector widget.
6703 * @param obj The flip selector object
6704 * @param interval The (first) interval value in seconds
6706 * This interval value is @b decreased while the user holds the
6707 * mouse pointer either flipping up or flipping doww a given flip
6710 * This helps the user to get to a given item distant from the
6711 * current one easier/faster, as it will start to flip quicker and
6712 * quicker on mouse button holds.
6714 * The calculation for the next flip interval value, starting from
6715 * the one set with this call, is the previous interval divided by
6716 * 1.05, so it decreases a little bit.
6718 * The default starting interval value for automatic flips is
6721 * @see elm_flipselector_interval_get()
6723 * @ingroup Flipselector
6725 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6728 * Get the interval on time updates for an user mouse button hold
6729 * on a flip selector widget.
6731 * @param obj The flip selector object
6732 * @return The (first) interval value, in seconds, set on it
6734 * @see elm_flipselector_interval_set() for more details
6736 * @ingroup Flipselector
6738 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6745 * @addtogroup Animator Animator
6746 * @ingroup Elementary
6748 * @brief Functions to ease creation of animations.
6750 * elm_animator is designed to provide an easy way to create animations.
6751 * Creating an animation with elm_animator is as simple as setting a
6752 * duration, an operating callback and telling it to run the animation.
6753 * However that is not the full extent of elm_animator's ability, animations
6754 * can be paused and resumed, reversed and the animation need not be linear.
6756 * To run an animation you must specify at least a duration and operation
6757 * callback, not setting any other properties will create a linear animation
6758 * that runs once and is not reversed.
6760 * @ref elm_animator_example_page_01 "This" example should make all of that
6763 * @warning elm_animator is @b not a widget.
6767 * @brief Type of curve desired for animation.
6769 * The speed in which an animation happens doesn't have to be linear, some
6770 * animations will look better if they're accelerating or decelerating, so
6771 * elm_animator provides four options in this regard:
6772 * @image html elm_animator_curve_style.png
6773 * @image latex elm_animator_curve_style.eps width=\textwidth
6774 * As can be seen in the image the speed of the animation will be:
6775 * @li ELM_ANIMATOR_CURVE_LINEAR constant
6776 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
6777 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
6778 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
6782 ELM_ANIMATOR_CURVE_LINEAR,
6783 ELM_ANIMATOR_CURVE_IN_OUT,
6784 ELM_ANIMATOR_CURVE_IN,
6785 ELM_ANIMATOR_CURVE_OUT
6786 } Elm_Animator_Curve_Style;
6787 typedef struct _Elm_Animator Elm_Animator;
6789 * Called back per loop of an elementary animators cycle
6790 * @param data user-data given to elm_animator_operation_callback_set()
6791 * @param animator the animator being run
6792 * @param double the position in the animation
6794 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
6796 * Called back when an elementary animator finishes
6797 * @param data user-data given to elm_animator_completion_callback_set()
6799 typedef void (*Elm_Animator_Completion_Cb) (void *data);
6802 * @brief Create a new animator.
6804 * @param[in] parent Parent object
6806 * The @a parent argument can be set to NULL for no parent. If a parent is set
6807 * there is no need to call elm_animator_del(), when the parent is deleted it
6808 * will delete the animator.
6809 * @deprecated Use @ref Transit instead.
6812 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
6814 * Deletes the animator freeing any resources it used. If the animator was
6815 * created with a NULL parent this must be called, otherwise it will be
6816 * automatically called when the parent is deleted.
6818 * @param[in] animator Animator object
6819 * @deprecated Use @ref Transit instead.
6821 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6823 * Set the duration of the animation.
6825 * @param[in] animator Animator object
6826 * @param[in] duration Duration in second
6827 * @deprecated Use @ref Transit instead.
6829 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
6831 * @brief Set the callback function for animator operation.
6833 * @param[in] animator Animator object
6834 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
6835 * @param[in] data Callback function user argument
6837 * The @p func callback will be called with a frame value in range [0, 1] which
6838 * indicates how far along the animation should be. It is the job of @p func to
6839 * actually change the state of any object(or objects) that are being animated.
6840 * @deprecated Use @ref Transit instead.
6842 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
6844 * Set the callback function for the when the animation ends.
6846 * @param[in] animator Animator object
6847 * @param[in] func Callback function pointe
6848 * @param[in] data Callback function user argument
6850 * @warning @a func will not be executed if elm_animator_stop() is called.
6851 * @deprecated Use @ref Transit instead.
6853 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
6855 * @brief Stop animator.
6857 * @param[in] animator Animator object
6859 * If called before elm_animator_animate() it does nothing. If there is an
6860 * animation in progress the animation will be stopped(the operation callback
6861 * will not be executed again) and it can't be restarted using
6862 * elm_animator_resume().
6863 * @deprecated Use @ref Transit instead.
6865 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6867 * Set the animator repeat count.
6869 * @param[in] animator Animator object
6870 * @param[in] repeat_cnt Repeat count
6871 * @deprecated Use @ref Transit instead.
6873 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
6875 * @brief Start animation.
6877 * @param[in] animator Animator object
6879 * This function starts the animation if the nescessary properties(duration
6880 * and operation callback) have been set. Once started the animation will
6881 * run until complete or elm_animator_stop() is called.
6882 * @deprecated Use @ref Transit instead.
6884 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6886 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6888 * @param[in] animator Animator object
6889 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6890 * @deprecated Use @ref Transit instead.
6892 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
6894 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6896 * @param[in] animator Animator object
6897 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6898 * @deprecated Use @ref Transit instead.
6900 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6902 * @brief Sets wether the animation should be automatically reversed.
6904 * @param[in] animator Animator object
6905 * @param[in] reverse Reverse or not
6907 * This controls wether the animation will be run on reverse imediately after
6908 * running forward. When this is set together with repetition the animation
6909 * will run in reverse once for each time it ran forward.@n
6910 * Runnin an animation in reverse is accomplished by calling the operation
6911 * callback with a frame value starting at 1 and diminshing until 0.
6912 * @deprecated Use @ref Transit instead.
6914 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
6916 * Gets wether the animation will automatically reversed
6918 * @param[in] animator Animator object
6919 * @deprecated Use @ref Transit instead.
6921 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6923 * Gets the status for the animator operation. The status of the animator @b
6924 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
6925 * only informs if the animation was started and has not ended(either normally
6926 * or through elm_animator_stop()).
6928 * @param[in] animator Animator object
6929 * @deprecated Use @ref Transit instead.
6931 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6933 * Gets how many times the animation will be repeated
6935 * @param[in] animator Animator object
6936 * @deprecated Use @ref Transit instead.
6938 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6940 * Pause the animator.
6942 * @param[in] animator Animator object
6944 * This causes the animation to be temporarily stopped(the operation callback
6945 * will not be called). If the animation is not yet running this is a no-op.
6946 * Once an animation has been paused with this function it can be resumed
6947 * using elm_animator_resume().
6948 * @deprecated Use @ref Transit instead.
6950 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6952 * @brief Resumes the animator.
6954 * @param[in] animator Animator object
6956 * Resumes an animation that was paused using elm_animator_pause(), after
6957 * calling this function calls to the operation callback will happen
6958 * normally. If an animation is stopped by means of elm_animator_stop it
6959 * @b can't be restarted with this function.@n
6961 * @warning When an animation is resumed it doesn't start from where it was paused, it
6962 * will go to where it would have been if it had not been paused. If an
6963 * animation with a duration of 3 seconds is paused after 1 second for 1 second
6964 * it will resume as if it had ben animating for 2 seconds, the operating
6965 * callback will be called with a frame value of aproximately 2/3.
6966 * @deprecated Use @ref Transit instead.
6968 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6976 ELM_CALENDAR_UNIQUE,
6978 ELM_CALENDAR_WEEKLY,
6979 ELM_CALENDAR_MONTHLY,
6980 ELM_CALENDAR_ANNUALLY
6981 } Elm_Calendar_Mark_Repeat;
6982 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
6984 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6985 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6986 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
6987 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6988 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6989 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
6990 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
6991 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6992 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6993 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
6994 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
6995 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
6996 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);
6997 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
6998 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6999 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7000 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
7001 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7002 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7003 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7004 /* smart callbacks called:
7005 * changed - emitted when the user select a day or change the displayed
7010 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
7012 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7013 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7014 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
7015 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7016 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
7017 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7018 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
7019 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7020 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7021 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);
7022 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7023 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7024 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7025 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);
7026 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7027 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
7028 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7029 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7030 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7031 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7032 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
7033 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7034 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7035 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7036 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7037 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7038 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7039 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7040 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
7041 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);
7042 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7043 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
7044 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7045 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
7046 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7047 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7048 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
7049 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7050 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7051 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7052 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
7053 /* smart callbacks called:
7054 * "selected" - when item is selected (scroller stops)
7058 * @page tutorial_colorselector Color selector example
7059 * @dontinclude colorselector_example_01.c
7061 * This example shows how to change the color of a rectangle using a color
7062 * selector. We aren't going to explain a lot of the code since it's the
7066 * Now that we have a window with background and a rectangle we can create
7067 * our color_selector and set it's initial color to fully opaque blue:
7070 * Next we tell ask to be notified whenever the color changes:
7073 * We follow that we some more run of the mill setup code:
7076 * And now get to the callback that sets the color of the rectangle:
7079 * This example will look like this:
7080 * @image html screenshots/colorselector_example_01.png
7081 * @image latex screenshots/colorselector_example_01.eps
7083 * @example colorselector_example_01.c
7086 * @defgroup Colorselector Colorselector
7090 * @brief Widget for user to select a color.
7092 * Signals that you can add callbacks for are:
7093 * "changed" - When the color value changes(event_info is NULL).
7095 * See @ref tutorial_colorselector.
7098 * @brief Add a new colorselector to the parent
7100 * @param parent The parent object
7101 * @return The new object or NULL if it cannot be created
7103 * @ingroup Colorselector
7105 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7107 * Set a color for the colorselector
7109 * @param obj Colorselector object
7110 * @param r r-value of color
7111 * @param g g-value of color
7112 * @param b b-value of color
7113 * @param a a-value of color
7115 * @ingroup Colorselector
7117 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
7119 * Get a color from the colorselector
7121 * @param obj Colorselector object
7122 * @param r integer pointer for r-value of color
7123 * @param g integer pointer for g-value of color
7124 * @param b integer pointer for b-value of color
7125 * @param a integer pointer for a-value of color
7127 * @ingroup Colorselector
7129 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
7134 /* Contextual Popup */
7135 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
7137 typedef enum _Elm_Ctxpopup_Direction
7139 ELM_CTXPOPUP_DIRECTION_DOWN,
7140 ELM_CTXPOPUP_DIRECTION_RIGHT,
7141 ELM_CTXPOPUP_DIRECTION_LEFT,
7142 ELM_CTXPOPUP_DIRECTION_UP,
7143 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
7144 } Elm_Ctxpopup_Direction;
7146 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7147 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7148 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7149 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7150 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
7151 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
7152 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7153 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7154 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7155 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7156 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);
7157 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7158 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7159 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7160 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
7161 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7162 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);
7163 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);
7164 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7165 /* smart callbacks called:
7166 * "dismissed" - the ctxpopup was dismissed
7172 * @defgroup Transit Transit
7173 * @ingroup Elementary
7175 * Transit is designed to apply various animated transition effects to @c
7176 * Evas_Object, such like translation, rotation, etc. For using these
7177 * effects, create an @ref Elm_Transit and add the desired transition effects.
7179 * Once the effects are added into transit, they will be automatically
7180 * managed (their callback will be called until the duration is ended, and
7181 * they will be deleted on completion).
7185 * Elm_Transit *trans = elm_transit_add();
7186 * elm_transit_object_add(trans, obj);
7187 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
7188 * elm_transit_duration_set(transit, 1);
7189 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
7190 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
7191 * elm_transit_repeat_times_set(transit, 3);
7194 * Some transition effects are used to change the properties of objects. They
7196 * @li @ref elm_transit_effect_translation_add
7197 * @li @ref elm_transit_effect_color_add
7198 * @li @ref elm_transit_effect_rotation_add
7199 * @li @ref elm_transit_effect_wipe_add
7200 * @li @ref elm_transit_effect_zoom_add
7201 * @li @ref elm_transit_effect_resizing_add
7203 * Other transition effects are used to make one object disappear and another
7204 * object appear on its old place. These effects are:
7206 * @li @ref elm_transit_effect_flip_add
7207 * @li @ref elm_transit_effect_resizable_flip_add
7208 * @li @ref elm_transit_effect_fade_add
7209 * @li @ref elm_transit_effect_blend_add
7211 * It's also possible to make a transition chain with @ref
7212 * elm_transit_chain_transit_add.
7214 * @warning We strongly recommend to use elm_transit just when edje can not do
7215 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
7216 * animations can be manipulated inside the theme.
7219 * @li @ref transit_example_01_explained
7220 * @li @ref transit_example_02_explained
7221 * @li @ref transit_example_03_c
7222 * @li @ref transit_example_04_c
7228 * @enum Elm_Transit_Tween_Mode
7230 * The type of acceleration used in the transition.
7234 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
7235 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
7236 over time, then decrease again
7238 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
7240 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
7242 } Elm_Transit_Tween_Mode;
7245 * @enum Elm_Transit_Effect_Flip_Axis
7247 * The axis where flip effect should be applied.
7251 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
7252 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
7253 } Elm_Transit_Effect_Flip_Axis;
7255 * @enum Elm_Transit_Effect_Wipe_Dir
7257 * The direction where the wipe effect should occur.
7261 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
7262 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
7263 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
7264 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
7265 } Elm_Transit_Effect_Wipe_Dir;
7266 /** @enum Elm_Transit_Effect_Wipe_Type
7268 * Whether the wipe effect should show or hide the object.
7272 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
7274 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
7276 } Elm_Transit_Effect_Wipe_Type;
7279 * @typedef Elm_Transit
7281 * The Transit created with elm_transit_add(). This type has the information
7282 * about the objects which the transition will be applied, and the
7283 * transition effects that will be used. It also contains info about
7284 * duration, number of repetitions, auto-reverse, etc.
7286 typedef struct _Elm_Transit Elm_Transit;
7287 typedef void Elm_Transit_Effect;
7289 * @typedef Elm_Transit_Effect_Transition_Cb
7291 * Transition callback called for this effect on each transition iteration.
7293 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
7295 * Elm_Transit_Effect_End_Cb
7297 * Transition callback called for this effect when the transition is over.
7299 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
7302 * Elm_Transit_Del_Cb
7304 * A callback called when the transit is deleted.
7306 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
7311 * @note Is not necessary to delete the transit object, it will be deleted at
7312 * the end of its operation.
7313 * @note The transit will start playing when the program enter in the main loop, is not
7314 * necessary to give a start to the transit.
7316 * @return The transit object.
7320 EAPI Elm_Transit *elm_transit_add(void);
7323 * Stops the animation and delete the @p transit object.
7325 * Call this function if you wants to stop the animation before the duration
7326 * time. Make sure the @p transit object is still alive with
7327 * elm_transit_del_cb_set() function.
7328 * All added effects will be deleted, calling its repective data_free_cb
7329 * functions. The function setted by elm_transit_del_cb_set() will be called.
7331 * @see elm_transit_del_cb_set()
7333 * @param transit The transit object to be deleted.
7336 * @warning Just call this function if you are sure the transit is alive.
7338 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7341 * Add a new effect to the transit.
7343 * @note The cb function and the data are the key to the effect. If you try to
7344 * add an already added effect, nothing is done.
7345 * @note After the first addition of an effect in @p transit, if its
7346 * effect list become empty again, the @p transit will be killed by
7347 * elm_transit_del(transit) function.
7351 * Elm_Transit *transit = elm_transit_add();
7352 * elm_transit_effect_add(transit,
7353 * elm_transit_effect_blend_op,
7354 * elm_transit_effect_blend_context_new(),
7355 * elm_transit_effect_blend_context_free);
7358 * @param transit The transit object.
7359 * @param transition_cb The operation function. It is called when the
7360 * animation begins, it is the function that actually performs the animation.
7361 * It is called with the @p data, @p transit and the time progression of the
7362 * animation (a double value between 0.0 and 1.0).
7363 * @param effect The context data of the effect.
7364 * @param end_cb The function to free the context data, it will be called
7365 * at the end of the effect, it must finalize the animation and free the
7369 * @warning The transit free the context data at the and of the transition with
7370 * the data_free_cb function, do not use the context data in another transit.
7372 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);
7375 * Delete an added effect.
7377 * This function will remove the effect from the @p transit, calling the
7378 * data_free_cb to free the @p data.
7380 * @see elm_transit_effect_add()
7382 * @note If the effect is not found, nothing is done.
7383 * @note If the effect list become empty, this function will call
7384 * elm_transit_del(transit), that is, it will kill the @p transit.
7386 * @param transit The transit object.
7387 * @param transition_cb The operation function.
7388 * @param effect The context data of the effect.
7392 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);
7395 * Add new object to apply the effects.
7397 * @note After the first addition of an object in @p transit, if its
7398 * object list become empty again, the @p transit will be killed by
7399 * elm_transit_del(transit) function.
7400 * @note If the @p obj belongs to another transit, the @p obj will be
7401 * removed from it and it will only belong to the @p transit. If the old
7402 * transit stays without objects, it will die.
7403 * @note When you add an object into the @p transit, its state from
7404 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7405 * transit ends, if you change this state whith evas_object_pass_events_set()
7406 * after add the object, this state will change again when @p transit stops to
7409 * @param transit The transit object.
7410 * @param obj Object to be animated.
7413 * @warning It is not allowed to add a new object after transit begins to go.
7415 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7418 * Removes an added object from the transit.
7420 * @note If the @p obj is not in the @p transit, nothing is done.
7421 * @note If the list become empty, this function will call
7422 * elm_transit_del(transit), that is, it will kill the @p transit.
7424 * @param transit The transit object.
7425 * @param obj Object to be removed from @p transit.
7428 * @warning It is not allowed to remove objects after transit begins to go.
7430 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7433 * Get the objects of the transit.
7435 * @param transit The transit object.
7436 * @return a Eina_List with the objects from the transit.
7440 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7443 * Enable/disable keeping up the objects states.
7444 * If it is not kept, the objects states will be reset when transition ends.
7446 * @note @p transit can not be NULL.
7447 * @note One state includes geometry, color, map data.
7449 * @param transit The transit object.
7450 * @param state_keep Keeping or Non Keeping.
7454 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
7457 * Get a value whether the objects states will be reset or not.
7459 * @note @p transit can not be NULL
7461 * @see elm_transit_objects_final_state_keep_set()
7463 * @param transit The transit object.
7464 * @return EINA_TRUE means the states of the objects will be reset.
7465 * If @p transit is NULL, EINA_FALSE is returned
7469 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7472 * Set the event enabled when transit is operating.
7474 * If @p enabled is EINA_TRUE, the objects of the transit will receives
7475 * events from mouse and keyboard during the animation.
7476 * @note When you add an object with elm_transit_object_add(), its state from
7477 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7478 * transit ends, if you change this state with evas_object_pass_events_set()
7479 * after adding the object, this state will change again when @p transit stops
7482 * @param transit The transit object.
7483 * @param enabled Events are received when enabled is @c EINA_TRUE, and
7484 * ignored otherwise.
7488 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7491 * Get the value of event enabled status.
7493 * @see elm_transit_event_enabled_set()
7495 * @param transit The Transit object
7496 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
7497 * EINA_FALSE is returned
7501 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7504 * Set the user-callback function when the transit is deleted.
7506 * @note Using this function twice will overwrite the first function setted.
7507 * @note the @p transit object will be deleted after call @p cb function.
7509 * @param transit The transit object.
7510 * @param cb Callback function pointer. This function will be called before
7511 * the deletion of the transit.
7512 * @param data Callback funtion user data. It is the @p op parameter.
7516 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
7519 * Set reverse effect automatically.
7521 * If auto reverse is setted, after running the effects with the progress
7522 * parameter from 0 to 1, it will call the effecs again with the progress
7523 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
7524 * where the duration was setted with the function elm_transit_add and
7525 * the repeat with the function elm_transit_repeat_times_set().
7527 * @param transit The transit object.
7528 * @param reverse EINA_TRUE means the auto_reverse is on.
7532 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
7535 * Get if the auto reverse is on.
7537 * @see elm_transit_auto_reverse_set()
7539 * @param transit The transit object.
7540 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
7541 * EINA_FALSE is returned
7545 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7548 * Set the transit repeat count. Effect will be repeated by repeat count.
7550 * This function sets the number of repetition the transit will run after
7551 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
7552 * If the @p repeat is a negative number, it will repeat infinite times.
7554 * @note If this function is called during the transit execution, the transit
7555 * will run @p repeat times, ignoring the times it already performed.
7557 * @param transit The transit object
7558 * @param repeat Repeat count
7562 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
7565 * Get the transit repeat count.
7567 * @see elm_transit_repeat_times_set()
7569 * @param transit The Transit object.
7570 * @return The repeat count. If @p transit is NULL
7575 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7578 * Set the transit animation acceleration type.
7580 * This function sets the tween mode of the transit that can be:
7581 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
7582 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
7583 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
7584 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
7586 * @param transit The transit object.
7587 * @param tween_mode The tween type.
7591 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
7594 * Get the transit animation acceleration type.
7596 * @note @p transit can not be NULL
7598 * @param transit The transit object.
7599 * @return The tween type. If @p transit is NULL
7600 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
7604 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7607 * Set the transit animation time
7609 * @note @p transit can not be NULL
7611 * @param transit The transit object.
7612 * @param duration The animation time.
7616 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
7619 * Get the transit animation time
7621 * @note @p transit can not be NULL
7623 * @param transit The transit object.
7625 * @return The transit animation time.
7629 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7632 * Starts the transition.
7633 * Once this API is called, the transit begins to measure the time.
7635 * @note @p transit can not be NULL
7637 * @param transit The transit object.
7641 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7644 * Pause/Resume the transition.
7646 * If you call elm_transit_go again, the transit will be started from the
7647 * beginning, and will be unpaused.
7649 * @note @p transit can not be NULL
7651 * @param transit The transit object.
7652 * @param paused Whether the transition should be paused or not.
7656 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
7659 * Get the value of paused status.
7661 * @see elm_transit_paused_set()
7663 * @note @p transit can not be NULL
7665 * @param transit The transit object.
7666 * @return EINA_TRUE means transition is paused. If @p transit is NULL
7667 * EINA_FALSE is returned
7671 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7674 * Get the time progression of the animation (a double value between 0.0 and 1.0).
7676 * The value returned is a fraction (current time / total time). It
7677 * represents the progression position relative to the total.
7679 * @note @p transit can not be NULL
7681 * @param transit The transit object.
7683 * @return The time progression value. If @p transit is NULL
7688 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7691 * Makes the chain relationship between two transits.
7693 * @note @p transit can not be NULL. Transit would have multiple chain transits.
7694 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
7696 * @param transit The transit object.
7697 * @param chain_transit The chain transit object. This transit will be operated
7698 * after transit is done.
7700 * This function adds @p chain_transit transition to a chain after the @p
7701 * transit, and will be started as soon as @p transit ends. See @ref
7702 * transit_example_02_explained for a full example.
7706 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
7709 * Cut off the chain relationship between two transits.
7711 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
7712 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
7714 * @param transit The transit object.
7715 * @param chain_transit The chain transit object.
7717 * This function remove the @p chain_transit transition from the @p transit.
7721 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
7724 * Get the current chain transit list.
7726 * @note @p transit can not be NULL.
7728 * @param transit The transit object.
7729 * @return chain transit list.
7733 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
7736 * Add the Resizing Effect to Elm_Transit.
7738 * @note This API is one of the facades. It creates resizing effect context
7739 * and add it's required APIs to elm_transit_effect_add.
7741 * @see elm_transit_effect_add()
7743 * @param transit Transit object.
7744 * @param from_w Object width size when effect begins.
7745 * @param from_h Object height size when effect begins.
7746 * @param to_w Object width size when effect ends.
7747 * @param to_h Object height size when effect ends.
7748 * @return Resizing effect context data.
7752 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);
7755 * Add the Translation Effect to Elm_Transit.
7757 * @note This API is one of the facades. It creates translation effect context
7758 * and add it's required APIs to elm_transit_effect_add.
7760 * @see elm_transit_effect_add()
7762 * @param transit Transit object.
7763 * @param from_dx X Position variation when effect begins.
7764 * @param from_dy Y Position variation when effect begins.
7765 * @param to_dx X Position variation when effect ends.
7766 * @param to_dy Y Position variation when effect ends.
7767 * @return Translation effect context data.
7770 * @warning It is highly recommended just create a transit with this effect when
7771 * the window that the objects of the transit belongs has already been created.
7772 * This is because this effect needs the geometry information about the objects,
7773 * and if the window was not created yet, it can get a wrong information.
7775 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);
7778 * Add the Zoom Effect to Elm_Transit.
7780 * @note This API is one of the facades. It creates zoom effect context
7781 * and add it's required APIs to elm_transit_effect_add.
7783 * @see elm_transit_effect_add()
7785 * @param transit Transit object.
7786 * @param from_rate Scale rate when effect begins (1 is current rate).
7787 * @param to_rate Scale rate when effect ends.
7788 * @return Zoom effect context data.
7791 * @warning It is highly recommended just create a transit with this effect when
7792 * the window that the objects of the transit belongs has already been created.
7793 * This is because this effect needs the geometry information about the objects,
7794 * and if the window was not created yet, it can get a wrong information.
7796 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
7799 * Add the Flip Effect to Elm_Transit.
7801 * @note This API is one of the facades. It creates flip effect context
7802 * and add it's required APIs to elm_transit_effect_add.
7803 * @note This effect is applied to each pair of objects in the order they are listed
7804 * in the transit list of objects. The first object in the pair will be the
7805 * "front" object and the second will be the "back" object.
7807 * @see elm_transit_effect_add()
7809 * @param transit Transit object.
7810 * @param axis Flipping Axis(X or Y).
7811 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7812 * @return Flip effect context data.
7815 * @warning It is highly recommended just create a transit with this effect when
7816 * the window that the objects of the transit belongs has already been created.
7817 * This is because this effect needs the geometry information about the objects,
7818 * and if the window was not created yet, it can get a wrong information.
7820 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7823 * Add the Resizable Flip Effect to Elm_Transit.
7825 * @note This API is one of the facades. It creates resizable flip effect context
7826 * and add it's required APIs to elm_transit_effect_add.
7827 * @note This effect is applied to each pair of objects in the order they are listed
7828 * in the transit list of objects. The first object in the pair will be the
7829 * "front" object and the second will be the "back" object.
7831 * @see elm_transit_effect_add()
7833 * @param transit Transit object.
7834 * @param axis Flipping Axis(X or Y).
7835 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7836 * @return Resizable flip effect context data.
7839 * @warning It is highly recommended just create a transit with this effect when
7840 * the window that the objects of the transit belongs has already been created.
7841 * This is because this effect needs the geometry information about the objects,
7842 * and if the window was not created yet, it can get a wrong information.
7844 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7847 * Add the Wipe Effect to Elm_Transit.
7849 * @note This API is one of the facades. It creates wipe effect context
7850 * and add it's required APIs to elm_transit_effect_add.
7852 * @see elm_transit_effect_add()
7854 * @param transit Transit object.
7855 * @param type Wipe type. Hide or show.
7856 * @param dir Wipe Direction.
7857 * @return Wipe effect context data.
7860 * @warning It is highly recommended just create a transit with this effect when
7861 * the window that the objects of the transit belongs has already been created.
7862 * This is because this effect needs the geometry information about the objects,
7863 * and if the window was not created yet, it can get a wrong information.
7865 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
7868 * Add the Color Effect to Elm_Transit.
7870 * @note This API is one of the facades. It creates color effect context
7871 * and add it's required APIs to elm_transit_effect_add.
7873 * @see elm_transit_effect_add()
7875 * @param transit Transit object.
7876 * @param from_r RGB R when effect begins.
7877 * @param from_g RGB G when effect begins.
7878 * @param from_b RGB B when effect begins.
7879 * @param from_a RGB A when effect begins.
7880 * @param to_r RGB R when effect ends.
7881 * @param to_g RGB G when effect ends.
7882 * @param to_b RGB B when effect ends.
7883 * @param to_a RGB A when effect ends.
7884 * @return Color effect context data.
7888 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);
7891 * Add the Fade Effect to Elm_Transit.
7893 * @note This API is one of the facades. It creates fade effect context
7894 * and add it's required APIs to elm_transit_effect_add.
7895 * @note This effect is applied to each pair of objects in the order they are listed
7896 * in the transit list of objects. The first object in the pair will be the
7897 * "before" object and the second will be the "after" object.
7899 * @see elm_transit_effect_add()
7901 * @param transit Transit object.
7902 * @return Fade effect context data.
7905 * @warning It is highly recommended just create a transit with this effect when
7906 * the window that the objects of the transit belongs has already been created.
7907 * This is because this effect needs the color information about the objects,
7908 * and if the window was not created yet, it can get a wrong information.
7910 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
7913 * Add the Blend Effect to Elm_Transit.
7915 * @note This API is one of the facades. It creates blend effect context
7916 * and add it's required APIs to elm_transit_effect_add.
7917 * @note This effect is applied to each pair of objects in the order they are listed
7918 * in the transit list of objects. The first object in the pair will be the
7919 * "before" object and the second will be the "after" object.
7921 * @see elm_transit_effect_add()
7923 * @param transit Transit object.
7924 * @return Blend effect context data.
7927 * @warning It is highly recommended just create a transit with this effect when
7928 * the window that the objects of the transit belongs has already been created.
7929 * This is because this effect needs the color information about the objects,
7930 * and if the window was not created yet, it can get a wrong information.
7932 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
7935 * Add the Rotation Effect to Elm_Transit.
7937 * @note This API is one of the facades. It creates rotation effect context
7938 * and add it's required APIs to elm_transit_effect_add.
7940 * @see elm_transit_effect_add()
7942 * @param transit Transit object.
7943 * @param from_degree Degree when effect begins.
7944 * @param to_degree Degree when effect is ends.
7945 * @return Rotation effect context data.
7948 * @warning It is highly recommended just create a transit with this effect when
7949 * the window that the objects of the transit belongs has already been created.
7950 * This is because this effect needs the geometry information about the objects,
7951 * and if the window was not created yet, it can get a wrong information.
7953 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
7956 * Add the ImageAnimation Effect to Elm_Transit.
7958 * @note This API is one of the facades. It creates image animation effect context
7959 * and add it's required APIs to elm_transit_effect_add.
7960 * The @p images parameter is a list images paths. This list and
7961 * its contents will be deleted at the end of the effect by
7962 * elm_transit_effect_image_animation_context_free() function.
7966 * char buf[PATH_MAX];
7967 * Eina_List *images = NULL;
7968 * Elm_Transit *transi = elm_transit_add();
7970 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
7971 * images = eina_list_append(images, eina_stringshare_add(buf));
7973 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
7974 * images = eina_list_append(images, eina_stringshare_add(buf));
7975 * elm_transit_effect_image_animation_add(transi, images);
7979 * @see elm_transit_effect_add()
7981 * @param transit Transit object.
7982 * @param images Eina_List of images file paths. This list and
7983 * its contents will be deleted at the end of the effect by
7984 * elm_transit_effect_image_animation_context_free() function.
7985 * @return Image Animation effect context data.
7989 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
7995 typedef struct _Elm_Store Elm_Store;
7996 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
7997 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
7998 typedef struct _Elm_Store_Item Elm_Store_Item;
7999 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
8000 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
8001 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
8002 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
8003 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
8004 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
8005 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
8006 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
8007 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
8009 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
8010 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
8011 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
8012 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
8013 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
8014 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
8015 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
8019 ELM_STORE_ITEM_MAPPING_NONE = 0,
8020 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
8021 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
8022 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
8023 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
8024 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
8025 // can add more here as needed by common apps
8026 ELM_STORE_ITEM_MAPPING_LAST
8027 } Elm_Store_Item_Mapping_Type;
8029 struct _Elm_Store_Item_Mapping_Icon
8031 // FIXME: allow edje file icons
8033 Elm_Icon_Lookup_Order lookup_order;
8034 Eina_Bool standard_name : 1;
8035 Eina_Bool no_scale : 1;
8036 Eina_Bool smooth : 1;
8037 Eina_Bool scale_up : 1;
8038 Eina_Bool scale_down : 1;
8041 struct _Elm_Store_Item_Mapping_Empty
8046 struct _Elm_Store_Item_Mapping_Photo
8051 struct _Elm_Store_Item_Mapping_Custom
8053 Elm_Store_Item_Mapping_Cb func;
8056 struct _Elm_Store_Item_Mapping
8058 Elm_Store_Item_Mapping_Type type;
8062 Elm_Store_Item_Mapping_Empty empty;
8063 Elm_Store_Item_Mapping_Icon icon;
8064 Elm_Store_Item_Mapping_Photo photo;
8065 Elm_Store_Item_Mapping_Custom custom;
8066 // add more types here
8070 struct _Elm_Store_Item_Info
8076 int pre_group_index;
8078 Elm_Genlist_Item_Class *item_class;
8079 const Elm_Store_Item_Mapping *mapping;
8084 struct _Elm_Store_Item_Info_Filesystem
8086 Elm_Store_Item_Info base;
8090 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
8091 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
8093 EAPI Elm_Store *elm_store_dbsystem_new(void);
8094 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
8095 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
8096 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
8097 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
8098 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8099 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8100 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
8101 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8102 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
8103 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8104 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
8105 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8106 EAPI void elm_store_free(Elm_Store *st);
8107 EAPI Elm_Store *elm_store_filesystem_new(void);
8108 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
8109 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8110 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8111 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
8112 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
8113 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8114 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8115 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8116 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
8117 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8118 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8119 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
8120 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8121 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
8122 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8123 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8124 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8126 /* SegmentControl */
8127 typedef struct _Elm_Segment_Item Elm_Segment_Item;
8128 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8129 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
8130 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);
8131 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8132 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8133 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8134 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8135 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8136 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
8137 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8138 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
8139 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8140 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8141 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8142 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
8143 /* smart callbacks called:
8144 * "changed" -when the user clicks on a segment item which is not previously
8145 * selected and get selected. The event_info parameter is the
8146 * segment item index.
8149 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
8150 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
8151 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
8152 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
8153 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
8154 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
8155 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
8156 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
8158 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
8159 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
8161 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
8162 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
8163 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
8164 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
8165 EAPI void elm_video_play(Evas_Object *video);
8166 EAPI void elm_video_pause(Evas_Object *video);
8167 EAPI void elm_video_stop(Evas_Object *video);
8168 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
8169 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
8170 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
8171 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
8172 EAPI double elm_video_audio_level_get(Evas_Object *video);
8173 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
8174 EAPI double elm_video_play_position_get(Evas_Object *video);
8175 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
8176 EAPI double elm_video_play_length_get(Evas_Object *video);
8177 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
8178 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
8179 EAPI const char *elm_video_title_get(Evas_Object *video);
8181 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
8182 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
8184 // FIXME: incomplete - carousel. don't use this until this comment is removed
8185 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
8186 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
8187 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
8188 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
8189 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
8190 /* smart callbacks called:
8191 * "clicked" - when the user clicks on a carousel item and becomes selected
8196 typedef enum _Elm_Datefield_ItemType
8198 ELM_DATEFIELD_YEAR = 0,
8199 ELM_DATEFIELD_MONTH,
8202 ELM_DATEFIELD_MINUTE,
8204 } Elm_Datefield_ItemType;
8206 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
8207 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
8208 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
8209 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
8210 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8211 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
8212 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8213 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
8214 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8215 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8216 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
8217 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8218 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8220 /* smart callbacks called:
8221 * "changed" - when datefield value is changed, this signal is sent.
8224 ////////////////////// DEPRECATED ///////////////////////////////////
8226 typedef enum _Elm_Datefield_Layout
8228 ELM_DATEFIELD_LAYOUT_TIME,
8229 ELM_DATEFIELD_LAYOUT_DATE,
8230 ELM_DATEFIELD_LAYOUT_DATEANDTIME
8231 } Elm_Datefield_Layout;
8233 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
8234 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
8235 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
8236 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
8237 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
8238 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
8239 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
8240 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
8241 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
8242 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
8243 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
8244 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
8245 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);
8246 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
8247 /////////////////////////////////////////////////////////////////////
8250 typedef enum _Elm_Popup_Response
8252 ELM_POPUP_RESPONSE_NONE = -1,
8253 ELM_POPUP_RESPONSE_TIMEOUT = -2,
8254 ELM_POPUP_RESPONSE_OK = -3,
8255 ELM_POPUP_RESPONSE_CANCEL = -4,
8256 ELM_POPUP_RESPONSE_CLOSE = -5
8257 } Elm_Popup_Response;
8259 typedef enum _Elm_Popup_Mode
8261 ELM_POPUP_TYPE_NONE = 0,
8262 ELM_POPUP_TYPE_ALERT = (1 << 0)
8265 typedef enum _Elm_Popup_Orient
8267 ELM_POPUP_ORIENT_TOP,
8268 ELM_POPUP_ORIENT_CENTER,
8269 ELM_POPUP_ORIENT_BOTTOM,
8270 ELM_POPUP_ORIENT_LEFT,
8271 ELM_POPUP_ORIENT_RIGHT,
8272 ELM_POPUP_ORIENT_TOP_LEFT,
8273 ELM_POPUP_ORIENT_TOP_RIGHT,
8274 ELM_POPUP_ORIENT_BOTTOM_LEFT,
8275 ELM_POPUP_ORIENT_BOTTOM_RIGHT
8278 /* smart callbacks called:
8279 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
8282 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
8283 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
8284 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
8285 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
8286 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
8287 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
8288 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
8289 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
8290 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
8291 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
8292 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, ... );
8293 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
8294 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
8295 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
8296 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
8297 EAPI int elm_popup_run(Evas_Object *obj);
8300 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8301 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8305 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
8306 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
8307 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
8308 ELM_NAVIGATIONBAR_BACK_BUTTON
8309 } Elm_Navi_Button_Type;
8311 EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
8312 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);
8313 EAPI void elm_navigationbar_pop(Evas_Object *obj);
8314 EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
8315 EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
8316 EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
8317 EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
8318 EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
8319 EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
8320 EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
8321 EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
8322 EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
8323 EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
8324 EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
8325 EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
8326 EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
8327 EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
8328 EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
8329 EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
8330 Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
8331 EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
8332 EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
8335 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8336 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8340 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
8341 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
8342 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
8343 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
8344 ELM_NAVIGATIONBAR_EX_MAX
8345 } Elm_Navi_ex_Button_Type;
8346 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
8348 EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
8349 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
8350 EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
8351 EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
8352 EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
8353 EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
8354 EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
8355 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
8356 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
8357 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);
8358 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
8359 EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
8360 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
8361 EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
8362 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
8363 EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
8364 EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
8365 EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
8366 EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
8367 EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
8368 EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
8369 EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
8370 EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
8371 EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
8372 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
8373 EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
8374 EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
8375 Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
8378 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
8379 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
8380 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
8381 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
8382 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
8383 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
8384 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
8385 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
8386 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
8387 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
8390 * @defgroup Naviframe Naviframe
8392 * @brief Naviframe is a kind of view manager for the applications.
8394 * Naviframe provides functions to switch different pages with stack
8395 * mechanism. It means if one page(item) needs to be changed to the new one,
8396 * then naviframe would push the new page to it's internal stack. Of course,
8397 * it can be back to the previous page by popping the top page. Naviframe
8398 * provides some transition effect while the pages are switching (same as
8401 * Since each item could keep the different styles, users could keep the
8402 * same look & feel for the pages or different styles for the items in it's
8405 * Signals that you can add callback for are:
8407 * @li "transition,finished" - When the transition is finished in changing
8409 * @li "title,clicked" - User clicked title area
8411 * Default contents parts for the naviframe items that you can use for are:
8413 * @li "elm.swallow.content" - The main content of the page
8414 * @li "elm.swallow.prev_btn" - The button to go to the previous page
8415 * @li "elm.swallow.next_btn" - The button to go to the next page
8417 * Default text parts of naviframe items that you can be used are:
8419 * @li "elm.text.title" - The title label in the title area
8421 * @ref tutorial_naviframe gives a good overview of the usage of the API.
8425 * @brief Add a new Naviframe object to the parent.
8427 * @param parent Parent object
8428 * @return New object or @c NULL, if it cannot be created
8430 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8432 * @brief Push a new item to the top of the naviframe stack (and show it).
8434 * @param obj The naviframe object
8435 * @param title_label The label in the title area. The name of the title
8436 * label part is "elm.text.title"
8437 * @param prev_btn The button to go to the previous item. If it is NULL,
8438 * then naviframe will create a back button automatically. The name of
8439 * the prev_btn part is "elm.swallow.prev_btn"
8440 * @param next_btn The button to go to the next item. Or It could be just an
8441 * extra function button. The name of the next_btn part is
8442 * "elm.swallow.next_btn"
8443 * @param content The main content object. The name of content part is
8444 * "elm.swallow.content"
8445 * @param item_style The current item style name. @c NULL would be default.
8446 * @return The created item or @c NULL upon failure.
8448 * The item pushed becomes one page of the naviframe, this item will be
8449 * deleted when it is popped.
8451 * @see also elm_naviframe_item_style_set()
8453 * The following styles are available for this item:
8456 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);
8458 * @brief Pop an item that is on top of the stack
8460 * @param obj The naviframe object
8461 * @return @c NULL or the content object(if the
8462 * elm_naviframe_content_preserve_on_pop_get is true).
8464 * This pops an item that is on the top(visible) of the naviframe, makes it
8465 * disappear, then deletes the item. The item that was underneath it on the
8466 * stack will become visible.
8468 * @see also elm_naviframe_content_preserve_on_pop_get()
8470 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
8472 * @brief Pop the items between the top and the above one on the given item.
8474 * @param it The naviframe item
8476 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8478 * Promote an item already in the naviframe stack to the top of the stack
8480 * @param it The naviframe item
8482 * This will take the indicated item and promote it to the top of the stack
8483 * as if it had been pushed there. The item must already be inside the
8484 * naviframe stack to work.
8487 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8489 * @brief Delete the given item instantly.
8491 * @param it The naviframe item
8493 * This just deletes the given item from the naviframe item list instantly.
8494 * So this would not emit any signals for view transitions but just change
8495 * the current view if the given item is a top one.
8498 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8500 * @brief preserve the content objects when items are popped.
8502 * @param obj The naviframe object
8503 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
8505 * @see also elm_naviframe_content_preserve_on_pop_get()
8507 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
8509 * @brief Get a value whether preserve mode is enabled or not.
8511 * @param obj The naviframe object
8512 * @return If @c EINA_TRUE, preserve mode is enabled
8514 * @see also elm_naviframe_content_preserve_on_pop_set()
8516 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8518 * @brief Get a top item on the naviframe stack
8520 * @param obj The naviframe object
8521 * @return The top item on the naviframe stack or @c NULL, if the stack is
8524 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8526 * @brief Get a bottom item on the naviframe stack
8528 * @param obj The naviframe object
8529 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
8532 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8534 * @brief Set an item style
8536 * @param obj The naviframe item
8537 * @param item_style The current item style name. @c NULL would be default
8539 * The following styles are available for this item:
8542 * @see also elm_naviframe_item_style_get()
8544 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
8546 * @brief Get an item style
8548 * @param obj The naviframe item
8549 * @return The current item style name
8551 * @see also elm_naviframe_item_style_set()
8553 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8555 * @brief Show/Hide the title area
8557 * @param it The naviframe item
8558 * @param visible If @c EINA_TRUE, title area will be visible, hidden
8561 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
8563 * @see also elm_naviframe_item_title_visible_get()
8565 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
8567 * @brief Get a value whether title area is visible or not.
8569 * @param it The naviframe item
8570 * @return If @c EINA_TRUE, title area is visible
8572 * @see also elm_naviframe_item_title_visible_set()
8574 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8576 * @brief Set creating prev button automatically or not
8578 * @param obj The naviframe object
8579 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
8580 * be created internally when you pass the @c NULL to the prev_btn
8581 * parameter in elm_naviframe_item_push
8583 * @see also elm_naviframe_item_push()
8585 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
8587 * @brief Get a value whether prev button(back button) will be auto pushed or
8590 * @param obj The naviframe object
8591 * @return If @c EINA_TRUE, prev button will be auto pushed.
8593 * @see also elm_naviframe_item_push()
8594 * elm_naviframe_prev_btn_auto_pushed_set()
8596 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
8599 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
8600 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
8601 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
8602 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
8603 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
8604 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
8605 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
8606 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
8607 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
8609 typedef enum _Elm_Controlbar_Mode_Type
8611 ELM_CONTROLBAR_MODE_DEFAULT = 0,
8612 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
8613 ELM_CONTROLBAR_MODE_TRANSPARENCY,
8614 ELM_CONTROLBAR_MODE_LARGE,
8615 ELM_CONTROLBAR_MODE_SMALL,
8616 ELM_CONTROLBAR_MODE_LEFT,
8617 ELM_CONTROLBAR_MODE_RIGHT
8618 } Elm_Controlbar_Mode_Type;
8620 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
8621 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
8622 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8623 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8624 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);
8625 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);
8626 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);
8627 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);
8628 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);
8629 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);
8630 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8631 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8632 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
8633 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
8634 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
8635 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
8636 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
8637 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
8638 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
8639 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
8640 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
8641 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
8642 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
8643 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
8644 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
8645 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
8646 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
8647 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
8648 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
8649 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
8650 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
8651 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
8652 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
8653 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
8654 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
8655 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
8656 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
8657 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
8658 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
8661 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
8662 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
8663 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
8664 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
8665 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
8666 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
8667 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
8668 EAPI void elm_searchbar_clear(Evas_Object *obj);
8669 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
8671 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
8672 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
8673 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
8674 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
8677 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
8678 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
8679 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
8680 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
8681 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
8686 ELM_TICKERNOTI_ORIENT_TOP = 0,
8687 ELM_TICKERNOTI_ORIENT_BOTTOM,
8688 ELM_TICKERNOTI_ORIENT_LAST
8689 } Elm_Tickernoti_Orient;
8691 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
8692 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
8693 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8694 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8695 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
8696 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8697 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
8700 ELM_TICKERNOTI_DEFAULT,
8701 ELM_TICKERNOTI_DETAILVIEW
8702 } Elm_Tickernoti_Mode;
8703 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8704 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
8705 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
8706 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8707 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8708 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8709 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8710 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
8711 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8712 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
8713 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8714 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8715 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8716 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8717 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8718 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
8719 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8720 /* ############################################################################### */
8722 * Parts which can be used with elm_object_text_part_set() and
8723 * elm_object_text_part_get():
8725 * @li NULL/"default" - Operates on tickernoti content-text
8727 * Parts which can be used with elm_object_content_part_set() and
8728 * elm_object_content_part_get():
8730 * @li "icon" - Operates on tickernoti's icon
8731 * @li "button" - Operates on tickernoti's button
8733 * smart callbacks called:
8734 * @li "clicked" - emitted when tickernoti is clicked, except at the
8735 * swallow/button region, if any.
8736 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
8737 * any hide animation, this signal is emitted after the animation.
8741 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
8743 struct _Colorpalette_Color
8745 unsigned int r, g, b;
8748 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
8749 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
8750 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
8751 /* smart callbacks called:
8752 * "clicked" - when image clicked
8756 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
8757 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
8758 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
8759 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
8760 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
8761 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
8762 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
8763 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
8764 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
8765 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
8766 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
8767 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
8768 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
8769 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
8770 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
8771 /* smart callbacks called:
8772 * "clicked" - when an editfield is clicked
8773 * "unfocused" - when an editfield is unfocused
8777 /* Sliding Drawer */
8778 typedef enum _Elm_SlidingDrawer_Pos
8780 ELM_SLIDINGDRAWER_BOTTOM,
8781 ELM_SLIDINGDRAWER_LEFT,
8782 ELM_SLIDINGDRAWER_RIGHT,
8783 ELM_SLIDINGDRAWER_TOP
8784 } Elm_SlidingDrawer_Pos;
8786 typedef struct _Elm_SlidingDrawer_Drag_Value
8789 } Elm_SlidingDrawer_Drag_Value;
8791 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
8792 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
8793 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
8794 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
8795 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
8796 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
8798 /* multibuttonentry */
8799 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
8800 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
8801 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
8802 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
8803 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
8804 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
8805 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
8806 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
8807 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
8808 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
8809 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
8810 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
8811 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
8812 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
8813 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
8814 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
8815 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
8816 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
8817 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
8818 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
8819 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
8820 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
8821 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
8822 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
8823 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
8824 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
8825 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
8826 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
8827 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
8828 /* smart callback called:
8829 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
8830 * "added" - This signal is emitted when a new multibuttonentry item is added.
8831 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
8832 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
8833 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
8834 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
8835 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
8836 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
8837 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
8838 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
8839 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
8840 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
8842 /* available styles:
8847 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
8848 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
8849 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
8850 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
8851 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
8852 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
8853 /* smart callback called:
8854 * "expanded" - This signal is emitted when a stackedicon is expanded.
8855 * "clicked" - This signal is emitted when a stackedicon is clicked.
8857 /* available styles:
8862 typedef struct _Dialogue_Item Dialogue_Item;
8864 typedef enum _Elm_Dialoguegourp_Item_Style
8866 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
8867 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
8868 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
8869 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
8870 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
8871 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
8872 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
8873 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
8874 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
8875 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
8876 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
8877 } Elm_Dialoguegroup_Item_Style;
8879 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
8880 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
8881 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
8882 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
8883 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
8884 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
8885 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
8886 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
8887 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
8888 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
8889 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
8890 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
8891 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
8892 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
8893 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
8894 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
8899 ELM_DAYSELECTOR_SUN,
8900 ELM_DAYSELECTOR_MON,
8901 ELM_DAYSELECTOR_TUE,
8902 ELM_DAYSELECTOR_WED,
8903 ELM_DAYSELECTOR_THU,
8904 ELM_DAYSELECTOR_FRI,
8906 } Elm_DaySelector_Day;
8908 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
8909 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
8910 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
8913 typedef struct _Imageslider_Item Elm_Imageslider_Item;
8914 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
8915 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8916 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);
8917 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);
8918 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);
8919 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8920 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8921 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8922 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8923 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8924 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8925 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8926 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8927 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8928 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
8929 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);