src/lib/Elementary.h.in

   1 /*
   2  *
   3  * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
   4  */
   5
   6 /**
   7 @file elementary.dox
   8 @brief Elementary Widget Library
   9 */
  10
  11 /**
  12 @mainpage Elementary
  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>
  57 @date 2008-2011
  58
  59 @section intro What is Elementary?
  60
  61 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
  62 applications (yet). Small simple ones with simple needs.
  63
  64 It is meant to make the programmers work almost brainless but give them lots
  65 of flexibility.
  66
  67 License: LGPL v2 (see COPYING in the base of Elementary's source). This
  68 applies to all files in the source here.
  69
  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.
  75
  76 @verbatim
  77 Pants
  78 @endverbatim
  79 */
  80
  81 #ifndef ELEMENTARY_H
  82 #define ELEMENTARY_H
  83
  84 /**
  85  * @file Elementary.h
  86  * @brief Elementary's API
  87  *
  88  * Elementary API.
  89  */
  90
  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_DEBUG_DEF@ ELM_DEBUG
  98 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
  99 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
 100
 101 /* Standard headers for standard system calls etc. */
 102 #include <stdio.h>
 103 #include <stdlib.h>
 104 #include <unistd.h>
 105 #include <string.h>
 106 #include <sys/types.h>
 107 #include <sys/stat.h>
 108 #include <sys/time.h>
 109 #include <sys/param.h>
 110 #include <dlfcn.h>
 111 #include <math.h>
 112 #include <fnmatch.h>
 113 #include <limits.h>
 114 #include <ctype.h>
 115 #include <time.h>
 116 #include <dirent.h>
 117 #include <pwd.h>
 118 #include <errno.h>
 119
 120 #ifdef ELM_UNIX
 121 # include <locale.h>
 122 # ifdef ELM_LIBINTL_H
 123 #  include <libintl.h>
 124 # endif
 125 # include <signal.h>
 126 # include <grp.h>
 127 # include <glob.h>
 128 #endif
 129
 130 #ifdef ELM_ALLOCA_H
 131 # include <alloca.h>
 132 #endif
 133
 134 #if defined (ELM_WIN32) || defined (ELM_WINCE)
 135 # include <malloc.h>
 136 # ifndef alloca
 137 #  define alloca _alloca
 138 # endif
 139 #endif
 140
 141
 142 /* EFL headers */
 143 #include <Eina.h>
 144 #include <Eet.h>
 145 #include <Evas.h>
 146 #include <Evas_GL.h>
 147 #include <Ecore.h>
 148 #include <Ecore_Evas.h>
 149 #include <Ecore_File.h>
 150 #include <Ecore_IMF.h>
 151 #include <Edje.h>
 152
 153 #ifdef ELM_EDBUS
 154 # include <E_DBus.h>
 155 #endif
 156
 157 #ifdef ELM_EFREET
 158 # include <Efreet.h>
 159 # include <Efreet_Mime.h>
 160 # include <Efreet_Trash.h>
 161 #endif
 162
 163 #ifdef ELM_ETHUMB
 164 # include <Ethumb_Client.h>
 165 #endif
 166
 167 #ifdef EAPI
 168 # undef EAPI
 169 #endif
 170
 171 #ifdef _WIN32
 172 # ifdef ELEMENTARY_BUILD
 173 #  ifdef DLL_EXPORT
 174 #   define EAPI __declspec(dllexport)
 175 #  else
 176 #   define EAPI
 177 #  endif /* ! DLL_EXPORT */
 178 # else
 179 #  define EAPI __declspec(dllimport)
 180 # endif /* ! EFL_EVAS_BUILD */
 181 #else
 182 # ifdef __GNUC__
 183 #  if __GNUC__ >= 4
 184 #   define EAPI __attribute__ ((visibility("default")))
 185 #  else
 186 #   define EAPI
 187 #  endif
 188 # else
 189 #  define EAPI
 190 # endif
 191 #endif /* ! _WIN32 */
 192
 193
 194 /* allow usage from c++ */
 195 #ifdef __cplusplus
 196 extern "C" {
 197 #endif
 198
 199 #define ELM_VERSION_MAJOR @VMAJ@
 200 #define ELM_VERSION_MINOR @VMIN@
 201
 202    typedef struct _Elm_Version
 203      {
 204         int major;
 205         int minor;
 206         int micro;
 207         int revision;
 208      } Elm_Version;
 209
 210    EAPI extern Elm_Version *elm_version;
 211
 212 /* handy macros */
 213 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
 214 #define ELM_PI 3.14159265358979323846
 215
 216   /**
 217    * Defines couple of standard Evas_Object layers to be used
 218    * with evas_object_layer_set().
 219    *
 220    * @note whenever extending with new values, try to keep some padding
 221    *       to siblings so there is room for further extensions.
 222    */
 223   typedef enum _Elm_Object_Layer
 224     {
 225        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
 226        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
 227        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
 228        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
 229        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
 230        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
 231     } Elm_Object_Layer;
 232
 233 /**************************************************************************/
 234    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
 235
 236    /* Objects */
 237    /**
 238     * Emitted when policy value changed.
 239     */
 240    EAPI extern int ELM_EVENT_POLICY_CHANGED;
 241    typedef struct _Elm_Event_Policy_Changed
 242      {
 243         unsigned int policy;
 244         int          new_value;
 245         int          old_value;
 246      } Elm_Event_Policy_Changed;
 247
 248    /**
 249     * Policy identifiers.
 250     *
 251     * @see elm_policy_set()
 252     */
 253    typedef enum _Elm_Policy
 254      {
 255         ELM_POLICY_QUIT, /**< when should quit application automatically.
 256                           * @see Elm_Policy_Quit.
 257                           */
 258         ELM_POLICY_LAST
 259      } Elm_Policy;
 260
 261    typedef enum _Elm_Policy_Quit
 262      {
 263         ELM_POLICY_QUIT_NONE = 0, /**< never quit application automatically */
 264         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when last window is closed */
 265      } Elm_Policy_Quit;
 266
 267    typedef enum _Elm_Focus_Direction
 268      {
 269         ELM_FOCUS_PREVIOUS,
 270         ELM_FOCUS_NEXT
 271      } Elm_Focus_Direction;
 272
 273    typedef enum _Elm_Text_Format
 274      {
 275         ELM_TEXT_FORMAT_PLAIN_UTF8,
 276         ELM_TEXT_FORMAT_MARKUP_UTF8
 277      } Elm_Text_Format;
 278
 279    /**
 280     * Line wrapping types.
 281     */
 282    typedef enum _Elm_Wrap_Type
 283      {
 284         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
 285         ELM_WRAP_CHAR, /**< Char wrap - wrap between graphmes */
 286         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
 287         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
 288         ELM_WRAP_LAST
 289      } Elm_Wrap_Type;
 290
 291
 292    /**
 293     * Called back when a widget's tooltip is activated and needs content.
 294     * @param data user-data given to elm_object_tooltip_content_cb_set()
 295     * @param obj owner widget.
 296     */
 297    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
 298
 299    /**
 300     * Called back when a widget's item tooltip is activated and needs content.
 301     * @param data user-data given to elm_object_tooltip_content_cb_set()
 302     * @param obj owner widget.
 303     * @param item context dependent item. As an example, if tooltip was
 304     *        set on Elm_List_Item, then it is of this type.
 305     */
 306    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
 307
 308    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
 309
 310 #ifndef ELM_LIB_QUICKLAUNCH
 311 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);}
 312 #else
 313 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);}
 314 #endif
 315
 316 /**************************************************************************/
 317    /* General calls */
 318    EAPI int          elm_init(int argc, char **argv);
 319    EAPI int          elm_shutdown(void);
 320    EAPI void         elm_run(void);
 321    EAPI void         elm_exit(void);
 322
 323    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
 324    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
 325    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
 326    EAPI void         elm_app_compile_data_dir_set(const char *dir);
 327    EAPI void         elm_app_compile_locale_set(const char *dir);
 328    EAPI const char  *elm_app_prefix_dir_get(void);
 329    EAPI const char  *elm_app_bin_dir_get(void);
 330    EAPI const char  *elm_app_lib_dir_get(void);
 331    EAPI const char  *elm_app_data_dir_get(void);
 332    EAPI const char  *elm_app_locale_dir_get(void);
 333
 334    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
 335    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
 336    EAPI int          elm_quicklaunch_init(int argc, char **argv);
 337    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
 338    EAPI int          elm_quicklaunch_sub_shutdown(void);
 339    EAPI int          elm_quicklaunch_shutdown(void);
 340    EAPI void         elm_quicklaunch_seed(void);
 341    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
 342    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
 343    EAPI void         elm_quicklaunch_cleanup(void);
 344    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
 345    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
 346
 347    EAPI Eina_Bool    elm_need_efreet(void);
 348    EAPI Eina_Bool    elm_need_e_dbus(void);
 349    EAPI Eina_Bool    elm_need_ethumb(void);
 350
 351    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
 352    EAPI int          elm_policy_get(unsigned int policy);
 353
 354    EAPI void         elm_all_flush(void);
 355    EAPI int          elm_cache_flush_interval_get(void);
 356    EAPI void         elm_cache_flush_interval_set(int size);
 357    EAPI void         elm_cache_flush_interval_all_set(int size);
 358    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
 359    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
 360    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
 361    EAPI int          elm_font_cache_get(void);
 362    EAPI void         elm_font_cache_set(int size);
 363    EAPI void         elm_font_cache_all_set(int size);
 364    EAPI int          elm_image_cache_get(void);
 365    EAPI void         elm_image_cache_set(int size);
 366    EAPI void         elm_image_cache_all_set(int size);
 367    EAPI int          elm_edje_file_cache_get(void);
 368    EAPI void         elm_edje_file_cache_set(int size);
 369    EAPI void         elm_edje_file_cache_all_set(int size);
 370    EAPI int          elm_edje_collection_cache_get(void);
 371    EAPI void         elm_edje_collection_cache_set(int size);
 372    EAPI void         elm_edje_collection_cache_all_set(int size);
 373
 374    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
 375    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 376    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 377    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
 378    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 379    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
 380    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
 381    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 382    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
 383    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 384
 385    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 386    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 387    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 388    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 389
 390    EAPI double       elm_scale_get(void);
 391    EAPI void         elm_scale_set(double scale);
 392    EAPI void         elm_scale_all_set(double scale);
 393
 394    EAPI Eina_Bool    elm_mirrored_get(void);
 395    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
 396
 397    EAPI Eina_Bool    elm_config_save(void);
 398    EAPI void         elm_config_reload(void);
 399
 400    EAPI const char  *elm_profile_current_get(void);
 401    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
 402    EAPI void         elm_profile_dir_free(const char *p_dir);
 403    EAPI Eina_List   *elm_profile_list_get(void);
 404    EAPI void         elm_profile_list_free(Eina_List *l);
 405    EAPI void         elm_profile_set(const char *profile);
 406    EAPI void         elm_profile_all_set(const char *profile);
 407
 408    EAPI const char  *elm_engine_current_get(void);
 409    EAPI void         elm_engine_set(const char *engine);
 410
 411   typedef struct _Elm_Text_Class
 412     {
 413        const char *name;
 414        const char *desc;
 415     } Elm_Text_Class;
 416
 417   typedef struct _Elm_Font_Overlay
 418     {
 419        const char     *text_class;
 420        const char     *font;
 421        Evas_Font_Size  size;
 422     } Elm_Font_Overlay;
 423
 424   typedef struct _Elm_Font_Properties
 425     {
 426        const char *name;
 427        Eina_List  *styles;
 428     } Elm_Font_Properties;
 429
 430    EAPI const Eina_List     *elm_text_classes_list_get(void);
 431    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
 432
 433    EAPI const Eina_List     *elm_font_overlay_list_get(void);
 434    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
 435    EAPI void                 elm_font_overlay_unset(const char *text_class);
 436    EAPI void                 elm_font_overlay_apply(void);
 437    EAPI void                 elm_font_overlay_all_apply(void);
 438
 439    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
 440    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
 441    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
 442    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
 443    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
 444    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
 445
 446    EAPI Evas_Coord       elm_finger_size_get(void);
 447    EAPI void             elm_finger_size_set(Evas_Coord size);
 448    EAPI void             elm_finger_size_all_set(Evas_Coord size);
 449
 450    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
 451    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
 452    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
 453    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
 454
 455    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 456    EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
 457    EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
 458    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
 459    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 460
 461    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
 462    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
 463    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 464    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
 465    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
 466    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
 467    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
 468
 469    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
 470    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
 471    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
 472    EAPI double           elm_scroll_bounce_friction_get(void);
 473    EAPI void             elm_scroll_bounce_friction_set(double friction);
 474    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
 475    EAPI double           elm_scroll_page_scroll_friction_get(void);
 476    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
 477    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
 478    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
 479    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
 480    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
 481    EAPI double           elm_scroll_zoom_friction_get(void);
 482    EAPI void             elm_scroll_zoom_friction_set(double friction);
 483    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
 484    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
 485    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
 486    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
 487    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
 488    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
 489    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
 490    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
 491    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
 492    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
 493    EAPI double           elm_scroll_thumbscroll_friction_get(void);
 494    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
 495    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
 496    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
 497    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
 498    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
 499
 500    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
 501    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
 502    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
 503    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
 504    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
 505    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
 506    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 507    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 508
 509    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
 510    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);
 511    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);
 512
 513    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
 514    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
 515
 516    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
 517
 518    EAPI double           elm_longpress_timeout_get(void);
 519    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
 520
 521    /* debug
 522     * don't use it unless you are sure
 523     */
 524    EAPI void             elm_object_tree_dump(const Evas_Object *top);
 525    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
 526
 527
 528    /* theme */
 529    typedef struct _Elm_Theme Elm_Theme;
 530
 531    EAPI Elm_Theme       *elm_theme_new(void);
 532    EAPI void             elm_theme_free(Elm_Theme *th);
 533    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
 534    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
 535    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
 536    EAPI Elm_Theme       *elm_theme_default_get(void);
 537    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
 538    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
 539    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
 540    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
 541    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
 542    EAPI const char      *elm_theme_get(Elm_Theme *th);
 543    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
 544    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
 545    EAPI void             elm_theme_flush(Elm_Theme *th);
 546    EAPI void             elm_theme_full_flush(void);
 547
 548    EAPI void             elm_theme_all_set(const char *theme);
 549
 550    EAPI Eina_List       *elm_theme_name_available_list_new(void);
 551    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
 552
 553    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
 554    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 555
 556    /* win */
 557    typedef enum _Elm_Win_Type
 558      {
 559         ELM_WIN_BASIC,
 560         ELM_WIN_DIALOG_BASIC,
 561         ELM_WIN_DESKTOP,
 562         ELM_WIN_DOCK,
 563         ELM_WIN_TOOLBAR,
 564         ELM_WIN_MENU,
 565         ELM_WIN_UTILITY,
 566         ELM_WIN_SPLASH,
 567         ELM_WIN_DROPDOWN_MENU,
 568         ELM_WIN_POPUP_MENU,
 569         ELM_WIN_TOOLTIP,
 570         ELM_WIN_NOTIFICATION,
 571         ELM_WIN_COMBO,
 572         ELM_WIN_DND,
 573         ELM_WIN_INLINED_IMAGE,
 574      } Elm_Win_Type;
 575
 576    typedef enum _Elm_Win_Keyboard_Mode
 577      {
 578         ELM_WIN_KEYBOARD_UNKNOWN,
 579         ELM_WIN_KEYBOARD_OFF,
 580         ELM_WIN_KEYBOARD_ON,
 581         ELM_WIN_KEYBOARD_ALPHA,
 582         ELM_WIN_KEYBOARD_NUMERIC,
 583         ELM_WIN_KEYBOARD_PIN,
 584         ELM_WIN_KEYBOARD_PHONE_NUMBER,
 585         ELM_WIN_KEYBOARD_HEX,
 586         ELM_WIN_KEYBOARD_TERMINAL,
 587         ELM_WIN_KEYBOARD_PASSWORD,
 588         ELM_WIN_KEYBOARD_IP,
 589         ELM_WIN_KEYBOARD_HOST,
 590         ELM_WIN_KEYBOARD_FILE,
 591         ELM_WIN_KEYBOARD_URL,
 592         ELM_WIN_KEYBOARD_KEYPAD,
 593         ELM_WIN_KEYBOARD_J2ME
 594      } Elm_Win_Keyboard_Mode;
 595
 596    typedef enum _Elm_Illume_Command
 597      {
 598         ELM_ILLUME_COMMAND_FOCUS_BACK,
 599         ELM_ILLUME_COMMAND_FOCUS_FORWARD,
 600         ELM_ILLUME_COMMAND_FOCUS_HOME,
 601         ELM_ILLUME_COMMAND_CLOSE
 602      } Elm_Illume_Command;
 603
 604    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
 605    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
 606    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
 607    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
 608    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 609    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
 610    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 611    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
 612    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
 613    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
 614    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
 615    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 616    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
 617    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 618    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
 619    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 620    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
 621    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 622    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
 623    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 624    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
 625    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 626    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
 627    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 628    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
 629    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 630    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
 631    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 632    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
 633    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
 634    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 635    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
 636    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 637    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
 638    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 639    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
 640    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 641    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
 642    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 643    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
 644    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 645    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
 646    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 647    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip); EINA_ARG_NONNULL(1);
 648    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params); EINA_ARG_NONNULL(1);
 649    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
 650    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
 651    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 652    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
 653    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 654    /*...
 655     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
 656     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
 657     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
 658     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
 659     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
 660     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
 661     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
 662     *
 663     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
 664     * (blank mouse, private mouse obj, defaultmouse)
 665     *
 666     */
 667    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
 668    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 669    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
 670    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 671
 672    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
 673
 674    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
 675    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
 676    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
 677    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 678    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
 679    /* available styles:
 680     * default
 681     * minimal
 682     * minimal_vertical
 683     */
 684    /* X specific calls - won't work on non-x engines (return 0) */
 685    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 686    /* smart callbacks called:
 687     * "delete,request" - the user requested to delete the window
 688     * "focus,in" - window got focus
 689     * "focus,out" - window lost focus
 690     * "moved" - window that holds the canvas was moved
 691     */
 692
 693    /**
 694     * @defgroup Bg Bg
 695     *
 696     * @brief Background object, used for setting a solid color, image or Edje
 697     * group as background to a window or any container object.
 698     *
 699     * The bg object is used for setting a solid background to a window or
 700     * packing into any container object. It works just like an image, but has
 701     * some properties useful to a background, like setting it to tiled,
 702     * centered, scaled or stretched.
 703     *
 704     * Here is some sample code using it:
 705     * @li @ref bg_01_example_page
 706     * @li @ref bg_02_example_page
 707     * @li @ref bg_03_example_page
 708     */
 709
 710    /* bg */
 711    typedef enum _Elm_Bg_Option
 712      {
 713         ELM_BG_OPTION_CENTER,  /**< center the background */
 714         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
 715         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
 716         ELM_BG_OPTION_TILE     /**< tile background at its original size */
 717      } Elm_Bg_Option;
 718
 719    /**
 720     * Add a new background to the parent
 721     *
 722     * @param parent The parent object
 723     * @return The new object or NULL if it cannot be created
 724     *
 725     * @ingroup Bg
 726     */
 727    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
 728
 729    /**
 730     * Set the file (image or edje) used for the background
 731     *
 732     * @param obj The bg object
 733     * @param file The file path
 734     * @param group Optional key (group in Edje) within the file
 735     *
 736     * This sets the image file used in the background object. The image (or edje)
 737     * will be stretched (retaining aspect if its an image file) to completely fill
 738     * the bg object. This may mean some parts are not visible.
 739     *
 740     * @note  Once the image of @p obj is set, a previously set one will be deleted,
 741     * even if @p file is NULL.
 742     *
 743     * @ingroup Bg
 744     */
 745    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
 746
 747    /**
 748     * Get the file (image or edje) used for the background
 749     *
 750     * @param obj The bg object
 751     * @param file The file path
 752     * @param group Optional key (group in Edje) within the file
 753     *
 754     * @ingroup Bg
 755     */
 756    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
 757
 758    /**
 759     * Set the option used for the background image
 760     *
 761     * @param obj The bg object
 762     * @param option The desired background option (TILE, SCALE)
 763     *
 764     * This sets the option used for manipulating the display of the background
 765     * image. The image can be tiled or scaled.
 766     *
 767     * @ingroup Bg
 768     */
 769    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
 770
 771    /**
 772     * Get the option used for the background image
 773     *
 774     * @param obj The bg object
 775     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
 776     *
 777     * @ingroup Bg
 778     */
 779    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 780    /**
 781     * Set the option used for the background color
 782     *
 783     * @param obj The bg object
 784     * @param r
 785     * @param g
 786     * @param b
 787     *
 788     * This sets the color used for the background rectangle. Its range goes
 789     * from 0 to 255.
 790     *
 791     * @ingroup Bg
 792     */
 793    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
 794    /**
 795     * Get the option used for the background color
 796     *
 797     * @param obj The bg object
 798     * @param r
 799     * @param g
 800     * @param b
 801     *
 802     * @ingroup Bg
 803     */
 804    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
 805
 806    /**
 807     * Set the overlay object used for the background object.
 808     *
 809     * @param obj The bg object
 810     * @param overlay The overlay object
 811     *
 812     * This provides a way for elm_bg to have an 'overlay' that will be on top
 813     * of the bg. Once the over object is set, a previously set one will be
 814     * deleted, even if you set the new one to NULL. If you want to keep that
 815     * old content object, use the elm_bg_overlay_unset() function.
 816     *
 817     * @ingroup Bg
 818     */
 819
 820    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
 821
 822    /**
 823     * Get the overlay object used for the background object.
 824     *
 825     * @param obj The bg object
 826     * @return The content that is being used
 827     *
 828     * Return the content object which is set for this widget
 829     *
 830     * @ingroup Bg
 831     */
 832    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 833
 834    /**
 835     * Get the overlay object used for the background object.
 836     *
 837     * @param obj The bg object
 838     * @return The content that was being used
 839     *
 840     * Unparent and return the overlay object which was set for this widget
 841     *
 842     * @ingroup Bg
 843     */
 844    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
 845
 846    /**
 847     * Set the size of the pixmap representation of the image.
 848     *
 849     * This option just makes sense if an image is going to be set in the bg.
 850     *
 851     * @param obj The bg object
 852     * @param w The new width of the image pixmap representation.
 853     * @param h The new height of the image pixmap representation.
 854     *
 855     * This function sets a new size for pixmap representation of the given bg
 856     * image. It allows the image to be loaded already in the specified size,
 857     * reducing the memory usage and load time when loading a big image with load
 858     * size set to a smaller size.
 859     *
 860     * NOTE: this is just a hint, the real size of the pixmap may differ
 861     * depending on the type of image being loaded, being bigger than requested.
 862     *
 863     * @ingroup Bg
 864     */
 865    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
 866    /* smart callbacks called:
 867     */
 868
 869    /* icon */
 870    typedef enum _Elm_Icon_Lookup_Order
 871      {
 872         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
 873         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
 874         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
 875         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
 876      } Elm_Icon_Lookup_Order;
 877
 878    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
 879    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
 880    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
 881    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
 882    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
 883    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 884    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
 885    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 886    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
 887    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 888    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
 889    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
 890    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
 891    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 892    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
 893    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 894    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
 895    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 896    /* smart callbacks called:
 897     * "clicked" - the user clicked the icon
 898     */
 899
 900    /* image */
 901    typedef enum _Elm_Image_Orient
 902      {
 903         ELM_IMAGE_ORIENT_NONE,
 904         ELM_IMAGE_ROTATE_90_CW,
 905         ELM_IMAGE_ROTATE_180_CW,
 906         ELM_IMAGE_ROTATE_90_CCW,
 907         ELM_IMAGE_FLIP_HORIZONTAL,
 908         ELM_IMAGE_FLIP_VERTICAL,
 909         ELM_IMAGE_FLIP_TRANSPOSE,
 910         ELM_IMAGE_FLIP_TRANSVERSE
 911      } Elm_Image_Orient;
 912    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
 913    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
 914    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
 915    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
 916    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 917    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
 918    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
 919    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 920    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
 921    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
 922    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
 923    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 924    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
 925    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 926    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
 927    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 928    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
 929    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 930    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 931    /* smart callbacks called:
 932     * "clicked" - the user clicked the image
 933     */
 934
 935    /* glview */
 936    typedef void (*Elm_GLView_Func)(Evas_Object *obj);
 937
 938    typedef enum _Elm_GLView_Mode
 939      {
 940         ELM_GLVIEW_ALPHA   = 1,
 941         ELM_GLVIEW_DEPTH   = 2,
 942         ELM_GLVIEW_STENCIL = 4
 943      } Elm_GLView_Mode;
 944
 945    /**
 946     * Defines a policy for the glview resizing.
 947     *
 948     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
 949     */
 950    typedef enum _Elm_GLView_Resize_Policy
 951      {
 952         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
 953         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
 954      } Elm_GLView_Resize_Policy;
 955
 956    typedef enum _Elm_GLView_Render_Policy
 957      {
 958         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
 959         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
 960      } Elm_GLView_Render_Policy;
 961
 962
 963    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
 964    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
 965    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
 966    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 967    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
 968    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
 969    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
 970    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
 971    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
 972    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
 973    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
 974    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
 975
 976    /* box */
 977    typedef struct _Elm_Box_Transition Elm_Box_Transition;
 978
 979    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
 980    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
 981    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 982    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
 983    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 984    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
 985    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 986    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
 987    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
 988    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
 989    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
 990    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
 991    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
 992    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
 993    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 994    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
 995    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
 996    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
 997    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
 998
 999    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);
1000    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
1001    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);
1002    EAPI void                elm_box_transition_free(void *data);
1003    /* smart callbacks called:
1004     */
1005
1006    /* button */
1007    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1008    EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
1009    EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1010    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
1011    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1012    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1013    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
1014    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1015    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
1016    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1017    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
1018    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1019    /* available styles:
1020     * default
1021     * anchor
1022     * hoversel_vertical
1023     * hoversel_vertical_entry
1024     */
1025    /* smart callbacks called:
1026     * "clicked" - the user clicked the button
1027     * "repeated" - the user pressed the button without releasing it
1028     * "unpressed" - when the button is unpressed (released)
1029     */
1030
1031    /* fileselector */
1032    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1033    EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
1034    EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1035    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
1036    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1037    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1038    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1039    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1040    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
1041    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
1042    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
1043    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1044    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
1045    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1046    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
1047    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1048    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
1049    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1050    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
1051    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1052    /* available styles:
1053     * default
1054     * anchor
1055     * hoversel_vertical
1056     * hoversel_vertical_entry
1057     */
1058    /* smart callbacks called:
1059     * "file,chosen" - the user has selected a path, whose string pointer comes
1060                       as event info
1061     */
1062
1063    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1064    EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
1065    EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1066    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
1067    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1068    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1069    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1070    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1071    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
1072    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
1073    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
1074    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1075    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
1076    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1077    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
1078    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1079    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
1080    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1081    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
1082    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1083    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
1084    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1085
1086    /* scroller policy */
1087    typedef enum _Elm_Scroller_Policy
1088      {
1089         ELM_SCROLLER_POLICY_AUTO = 0,
1090         ELM_SCROLLER_POLICY_ON,
1091         ELM_SCROLLER_POLICY_OFF,
1092         ELM_SCROLLER_POLICY_LAST
1093      } Elm_Scroller_Policy;
1094
1095    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1096    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
1097    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1098    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1099    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
1100    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
1101    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);
1102    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
1103    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
1104    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);
1105    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
1106    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
1107    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
1108    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
1109    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
1110    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);
1111    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
1112    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
1113    /* smart callbacks called:
1114     * "edge,left" - the left edge of the content has been reached
1115     * "edge,right" - the right edge of the content has been reached
1116     * "edge,top" - the top edge of the content has been reached
1117     * "edge,bottom" - the bottom edge of the content has been reached
1118     * "scroll" - the content has been scrolled (moved)
1119     * "scroll,anim,start" - scrolling animation has started
1120     * "scroll,anim,stop" - scrolling animation has stopped
1121     * "scroll,drag,start" - dragging the contents around has started
1122     * "scroll,drag,stop" - dragging the contents around has stopped
1123     */
1124
1125    /* label */
1126    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1127    EAPI void         elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
1128    EAPI const char  *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1129    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
1130    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1131    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
1132    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1133    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
1134    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1135    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
1136    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);
1137    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
1138    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);
1139    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
1140    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
1141    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
1142    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
1143    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
1144    /* available styles:
1145     * default
1146     * marker
1147     */
1148    /* smart callbacks called:
1149     */
1150
1151    /* toggle */
1152    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1153    EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
1154    EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1155    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
1156    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1157    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1158    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
1159    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
1160    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
1161    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1162    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
1163    /* smart callbacks called:
1164     * "changed" - Whenever the toggle value has been changed.  Is not called
1165     *             until the toggle is released by the cursor (assuming it has been triggered
1166     *             by the cursor in the first place).
1167     */
1168
1169    /* frame */
1170    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1171    EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label); EINA_ARG_NONNULL(1)
1172    EAPI const char  *elm_frame_label_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
1173    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1)
1174    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
1175    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj); EINA_ARG_NONNULL(1)
1176    /* available styles:
1177     * default
1178     * pad_small
1179     * pad_medium
1180     * pad_large
1181     * pad_huge
1182     * outdent_top
1183     * outdent_bottom
1184     */
1185    /* smart callbacks called:
1186     */
1187
1188    /* table */
1189    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1190    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
1191    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1192    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
1193    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1194    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
1195    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
1196    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
1197    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1198    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
1199    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
1200    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
1201
1202    /* gengrid */
1203    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
1204    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
1205    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
1206    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
1207    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
1208    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
1209    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj);
1210
1211    struct _Elm_Gengrid_Item_Class
1212      {
1213         const char             *item_style;
1214         struct _Elm_Gengrid_Item_Class_Func
1215           {
1216              GridItemLabelGetFunc  label_get;
1217              GridItemIconGetFunc   icon_get;
1218              GridItemStateGetFunc  state_get;
1219              GridItemDelFunc       del;
1220           } func;
1221      };
1222
1223    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1224    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
1225    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
1226    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
1227    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
1228
1229    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
1230    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1231    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
1232    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1233    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
1234    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1235    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
1236    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1237    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
1238    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
1239    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
1240    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
1241    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
1242    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
1243    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1244
1245    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1246    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1247
1248    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1249    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1250    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1251    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1252    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1253    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1254    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
1255    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
1256    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
1257    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1258    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1259    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1260    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1261    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1262    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1263
1264    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
1265    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);
1266    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1267    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
1268    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1269    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
1270    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1271    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1272    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
1273    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1274    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
1275    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
1276
1277    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
1278    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1279    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1280
1281    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);
1282    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);
1283    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);
1284    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);
1285    /* smart callbacks called:
1286     *
1287     * selected - User has selected an item.
1288     * unselected - User has unselected an item.
1289     * clicked,double - User has double-clicked or pressed enter on an item.
1290     * realized - An evas object for an item was built.
1291     * unrealized - An evas object for an item was deleted.
1292     * changed - An item has been added, removed, resized or moved,
1293     * or gengrid has been resized or horizontal property has been changed.
1294     * scroll - the content has been scrolled (moved).
1295     * "scroll,drag,start" - dragging the contents around has started.
1296     * "scroll,drat,stop" - dragging the contents around has stopped.
1297     * drag - Gengrid is being dragged.
1298     * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
1299     * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
1300     * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
1301     * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
1302     * "drag,stop" - Gengrid is not being dragged.
1303     */
1304
1305    /* clock */
1306    typedef enum _Elm_Clock_Digedit
1307      {
1308         ELM_CLOCK_NONE         = 0,
1309         ELM_CLOCK_HOUR_DECIMAL = 1 << 0,
1310         ELM_CLOCK_HOUR_UNIT    = 1 << 1,
1311         ELM_CLOCK_MIN_DECIMAL  = 1 << 2,
1312         ELM_CLOCK_MIN_UNIT     = 1 << 3,
1313         ELM_CLOCK_SEC_DECIMAL  = 1 << 4,
1314         ELM_CLOCK_SEC_UNIT     = 1 << 5,
1315         ELM_CLOCK_ALL          = (1 << 6) - 1
1316      } Elm_Clock_Digedit;
1317
1318    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1319    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
1320    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
1321    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
1322    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1323    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
1324    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1325    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
1326    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1327    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
1328    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1329    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
1330    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1331    /* smart callbacks called:
1332     * "changed" - the user changed the time
1333     */
1334
1335    /* layout */
1336    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1337    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
1338    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
1339    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
1340    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
1341    EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
1342    EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
1343    EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
1344    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
1345    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
1346    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
1347    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
1348    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
1349    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
1350    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);
1351    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
1352    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
1353    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1354    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
1355    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
1356    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
1357    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
1358    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
1359    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
1360    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
1361    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);
1362    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
1363 /**
1364  * @def elm_layout_icon_set
1365  * Convienience macro to set the icon object in a layout that follows the
1366  * Elementary naming convention for its parts.
1367  *
1368  * @ingroup Layout
1369  */
1370 #define elm_layout_icon_set(_ly, _obj) \
1371   do { \
1372     const char *sig; \
1373     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
1374     if ((_obj)) sig = "elm,state,icon,visible"; \
1375     else sig = "elm,state,icon,hidden"; \
1376     elm_object_signal_emit((_ly), sig, "elm"); \
1377   } while (0)
1378
1379 /**
1380  * @def elm_layout_icon_get
1381  * Convienience macro to get the icon object from a layout that follows the
1382  * Elementary naming convention for its parts.
1383  *
1384  * @ingroup Layout
1385  */
1386 #define elm_layout_icon_get(_ly) \
1387   elm_layout_content_get((_ly), "elm.swallow.icon")
1388
1389 /**
1390  * @def elm_layout_end_set
1391  * Convienience macro to set the end object in a layout that follows the
1392  * Elementary naming convention for its parts.
1393  *
1394  * @ingroup Layout
1395  */
1396 #define elm_layout_end_set(_ly, _obj) \
1397   do { \
1398     const char *sig; \
1399     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
1400     if ((_obj)) sig = "elm,state,end,visible"; \
1401     else sig = "elm,state,end,hidden"; \
1402     elm_object_signal_emit((_ly), sig, "elm"); \
1403   } while (0)
1404
1405 /**
1406  * @def elm_layout_end_get
1407  * Convienience macro to get the end object in a layout that follows the
1408  * Elementary naming convention for its parts.
1409  *
1410  * @ingroup Layout
1411  */
1412 #define elm_layout_end_get(_ly) \
1413   elm_layout_content_get((_ly), "elm.swallow.end")
1414
1415 /**
1416  * @def elm_layout_label_set
1417  * Convienience macro to set the label in a layout that follows the
1418  * Elementary naming convention for its parts.
1419  *
1420  * @ingroup Layout
1421  */
1422 #define elm_layout_label_set(_ly, _txt) \
1423   elm_layout_text_set((_ly), "elm.text", (_txt))
1424
1425 /**
1426  * @def elm_layout_label_get
1427  * Convienience macro to get the label in a layout that follows the
1428  * Elementary naming convention for its parts.
1429  *
1430  * @ingroup Layout
1431  */
1432 #define elm_layout_label_get(_ly) \
1433   elm_layout_text_get((_ly), "elm.text")
1434
1435    /* smart callbacks called:
1436     */
1437
1438    /* notify */
1439    typedef enum _Elm_Notify_Orient
1440      {
1441         ELM_NOTIFY_ORIENT_TOP,
1442         ELM_NOTIFY_ORIENT_CENTER,
1443         ELM_NOTIFY_ORIENT_BOTTOM,
1444         ELM_NOTIFY_ORIENT_LEFT,
1445         ELM_NOTIFY_ORIENT_RIGHT,
1446         ELM_NOTIFY_ORIENT_TOP_LEFT,
1447         ELM_NOTIFY_ORIENT_TOP_RIGHT,
1448         ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
1449         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
1450         ELM_NOTIFY_ORIENT_LAST
1451      } Elm_Notify_Orient;
1452    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1453    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1454    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1455    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1456    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
1457    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1458    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
1459    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1460    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
1461    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1462    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
1463    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1464    /* smart callbacks called:
1465     * "timeout" - when timeout happens on notify and it's hidden
1466     * "block,clicked" - when it's hidden by a click outside of the notify's view
1467     */
1468
1469    /* hover */
1470    typedef enum _Elm_Hover_Axis
1471      {
1472         ELM_HOVER_AXIS_NONE,
1473         ELM_HOVER_AXIS_HORIZONTAL,
1474         ELM_HOVER_AXIS_VERTICAL,
1475         ELM_HOVER_AXIS_BOTH
1476      } Elm_Hover_Axis;
1477    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1478    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
1479    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1480    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
1481    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1482    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
1483    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
1484    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
1485    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
1486    /* available styles:
1487     * default
1488     * popout
1489     * menu
1490     * hoversel_vertical
1491     */
1492    /* smart callbacks called:
1493     * "clicked" - the user clicked the empty space in the hover to dismiss
1494     * "smart,changed" - a content object placed under the "smart"
1495     *                   policy was replaced to a new slot direction.
1496     */
1497
1498    /* entry */
1499    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
1500    struct _Elm_Entry_Anchor_Info
1501      {
1502         const char *name;
1503         int         button;
1504         Evas_Coord  x, y, w, h;
1505      };
1506    typedef enum _Elm_Icon_Type
1507      {
1508         ELM_ICON_NONE,
1509         ELM_ICON_FILE,
1510         ELM_ICON_STANDARD
1511      } Elm_Icon_Type;
1512    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
1513
1514    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1515    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
1516    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1517    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
1518    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1519    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
1520    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1521    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
1522    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1523    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1524    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
1525    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
1526    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
1527    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1528    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
1529    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
1530    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
1531    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
1532    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
1533    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
1534    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
1535    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
1536    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
1537    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
1538    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
1539    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
1540    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1541    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1542    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1543    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);
1544    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
1545    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1546    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
1547    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
1548    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
1549    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
1550    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);
1551    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1552    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1553    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);
1554    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);
1555    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);
1556    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);
1557    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);
1558    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);
1559    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
1560    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
1561    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
1562    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
1563    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
1564    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
1565    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1566    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
1567    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1568    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
1569    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
1570    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
1571    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
1572    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
1573    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
1574    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
1575    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
1576    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
1577    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
1578    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
1579    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
1580    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
1581
1582    /* pre-made filters for entries */
1583    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
1584    struct _Elm_Entry_Filter_Limit_Size
1585      {
1586         int max_char_count;
1587         int max_byte_count;
1588      };
1589    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
1590    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
1591    struct _Elm_Entry_Filter_Accept_Set
1592      {
1593         const char *accepted;
1594         const char *rejected;
1595      };
1596    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
1597    /* smart callbacks called:
1598     * "changed" - the text content changed
1599     * "selection,start" - the user started selecting text
1600     * "selection,changed" - the user modified the selection size/location
1601     * "selection,cleared" - the user cleared the selection
1602     * "selection,paste" - the user requested a paste of text
1603     * "selection,copy" - the user copied the text
1604     * "selection,cut" - the user cut the text
1605     * "cursor,changed" - the cursor changed position
1606     * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
1607     * "activated" - when the enter key is pressed (useful for single line)
1608     * "press" - when finger/mouse is pressed down
1609     * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
1610     * "clicked,double" - when finger/mouse is double-pressed
1611     * "longpressed" - the entry has been longpressed
1612     * "focused" - the entry has received keyboard focus
1613     * "unfocused" - keyboard focus is gone
1614     */
1615
1616    /* composite widgets - these basically put together basic widgets above
1617     * in convenient packages that do more than basic stuff */
1618
1619    /* anchorview */
1620    /**
1621     * @defgroup Anchorview Anchorview
1622     *
1623     * Anchorview is for displaying text that contains markup with anchors
1624     * like <c>\<a href=1234\>something\</\></c> in it.
1625     *
1626     * Besides being styled differently, the anchorview widget provides the
1627     * necessary functionality so that clicking on these anchors brings up a
1628     * popup with user defined content such as "call", "add to contacts" or
1629     * "open web page". This popup is provided using the @ref Hover widget.
1630     *
1631     * This widget is very similar to @ref Anchorblock, so refer to that
1632     * widget for an example. The only difference Anchorview has is that the
1633     * widget is already provided with scrolling functionality, so if the
1634     * text set to it is too large to fit in the given space, it will scroll,
1635     * whereas the @ref Anchorblock widget will keep growing to ensure all the
1636     * text can be displayed.
1637     *
1638     * This widget emits the following signals:
1639     * @li "anchor,clicked": will be called when an anchor is clicked. The
1640     * @p event_info parameter on the callback will be a pointer of type
1641     * ::Elm_Entry_Anchorview_Info.
1642     *
1643     * See @ref Anchorblock for an example on how to use both of them.
1644     *
1645     * @see Anchorblock
1646     * @see Entry
1647     * @see Hover
1648     *
1649     * @{
1650     */
1651    /**
1652     * @typedef Elm_Entry_Anchorview_Info
1653     *
1654     * The info sent in the callback for "anchor,clicked" signals emitted by
1655     * the Anchorview widget.
1656     */
1657    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
1658    /**
1659     * @struct _Elm_Entry_Anchorview_Info
1660     *
1661     * The info sent in the callback for "anchor,clicked" signals emitted by
1662     * the Anchorview widget.
1663     */
1664    struct _Elm_Entry_Anchorview_Info
1665      {
1666         const char     *name; /**< Name of the anchor, as indicated in its href
1667                                    attribute */
1668         int             button; /**< The mouse button used to click on it */
1669         Evas_Object    *hover; /**< The hover object to use for the popup */
1670         struct {
1671              Evas_Coord    x, y, w, h;
1672         } anchor, /**< Geometry selection of text used as anchor */
1673           hover_parent; /**< Geometry of the object used as parent by the
1674                              hover */
1675         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
1676                                              for content on the left side of
1677                                              the hover. Before calling the
1678                                              callback, the widget will make the
1679                                              necessary calculations to check
1680                                              which sides are fit to be set with
1681                                              content, based on the position the
1682                                              hover is activated and its distance
1683                                              to the edges of its parent object
1684                                              */
1685         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
1686                                               the right side of the hover.
1687                                               See @ref hover_left */
1688         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
1689                                             of the hover. See @ref hover_left */
1690         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
1691                                                below the hover. See @ref
1692                                                hover_left */
1693      };
1694    /**
1695     * Add a new Anchorview object
1696     *
1697     * @param parent The parent object
1698     * @return The new object or NULL if it cannot be created
1699     */
1700    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1701    /**
1702     * Set the text to show in the anchorview
1703     *
1704     * Sets the text of the anchorview to @p text. This text can include markup
1705     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
1706     * text that will be specially styled and react to click events, ended with
1707     * either of \</a\> or \</\>. When clicked, the anchor will emit an
1708     * "anchor,clicked" signal that you can attach a callback to with
1709     * evas_object_smart_callback_add(). The name of the anchor given in the
1710     * event info struct will be the one set in the href attribute, in this
1711     * case, anchorname.
1712     *
1713     * Other markup can be used to style the text in different ways, but it's
1714     * up to the style defined in the theme which tags do what.
1715     */
1716    EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
1717    /**
1718     * Get the markup text set for the anchorview
1719     *
1720     * Retrieves the text set on the anchorview, with markup tags included.
1721     *
1722     * @param obj The anchorview object
1723     * @return The markup text set or @c NULL if nothing was set or an error
1724     * occurred
1725     */
1726    EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1727    /**
1728     * Set the parent of the hover popup
1729     *
1730     * Sets the parent object to use by the hover created by the anchorview
1731     * when an anchor is clicked. See @ref Hover for more details on this.
1732     * If no parent is set, the same anchorview object will be used.
1733     *
1734     * @param obj The anchorview object
1735     * @param parent The object to use as parent for the hover
1736     */
1737    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
1738    /**
1739     * Get the parent of the hover popup
1740     *
1741     * Get the object used as parent for the hover created by the anchorview
1742     * widget. See @ref Hover for more details on this.
1743     *
1744     * @param obj The anchorview object
1745     * @return The object used as parent for the hover, NULL if none is set.
1746     */
1747    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1748    /**
1749     * Set the style that the hover should use
1750     *
1751     * When creating the popup hover, anchorview will request that it's
1752     * themed according to @p style.
1753     *
1754     * @param obj The anchorview object
1755     * @param style The style to use for the underlying hover
1756     *
1757     * @see elm_object_style_set()
1758     */
1759    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1760    /**
1761     * Get the style that the hover should use
1762     *
1763     * Get the style the hover created by anchorview will use.
1764     *
1765     * @param obj The anchorview object
1766     * @return The style to use by the hover. NULL means the default is used.
1767     *
1768     * @see elm_object_style_set()
1769     */
1770    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1771    /**
1772     * Ends the hover popup in the anchorview
1773     *
1774     * When an anchor is clicked, the anchorview widget will create a hover
1775     * object to use as a popup with user provided content. This function
1776     * terminates this popup, returning the anchorview to its normal state.
1777     *
1778     * @param obj The anchorview object
1779     */
1780    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
1781    /**
1782     * Set bouncing behaviour when the scrolled content reaches an edge
1783     *
1784     * Tell the internal scroller object whether it should bounce or not
1785     * when it reaches the respective edges for each axis.
1786     *
1787     * @param obj The anchorview object
1788     * @param h_bounce Whether to bounce or not in the horizontal axis
1789     * @param v_bounce Whether to bounce or not in the vertical axis
1790     *
1791     * @see elm_scroller_bounce_set()
1792     */
1793    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
1794    /**
1795     * Get the set bouncing behaviour of the internal scroller
1796     *
1797     * Get whether the internal scroller should bounce when the edge of each
1798     * axis is reached scrolling.
1799     *
1800     * @param obj The anchorview object
1801     * @param h_bounce Pointer where to store the bounce state of the horizontal
1802     *                 axis
1803     * @param v_bounce Pointer where to store the bounce state of the vertical
1804     *                 axis
1805     *
1806     * @see elm_scroller_bounce_get()
1807     */
1808    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
1809    /**
1810     * Appends a custom item provider to the given anchorview
1811     *
1812     * Appends the given function to the list of items providers. This list is
1813     * called, one function at a time, with the given @p data pointer, the
1814     * anchorview object and, in the @p item parameter, the item name as
1815     * referenced in its href string. Following functions in the list will be
1816     * called in order until one of them returns something different to NULL,
1817     * which should be an Evas_Object which will be used in place of the item
1818     * element.
1819     *
1820     * Items in the markup text take the form \<item relsize=16x16 vsize=full
1821     * href=item/name\>\</item\>
1822     *
1823     * @param obj The anchorview object
1824     * @param func The function to add to the list of providers
1825     * @param data User data that will be passed to the callback function
1826     *
1827     * @see elm_entry_item_provider_append()
1828     */
1829    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);
1830    /**
1831     * Prepend a custom item provider to the given anchorview
1832     *
1833     * Like elm_anchorview_item_provider_append(), but it adds the function
1834     * @p func to the beginning of the list, instead of the end.
1835     *
1836     * @param obj The anchorview object
1837     * @param func The function to add to the list of providers
1838     * @param data User data that will be passed to the callback function
1839     */
1840    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);
1841    /**
1842     * Remove a custom item provider from the list of the given anchorview
1843     *
1844     * Removes the function and data pairing that matches @p func and @p data.
1845     * That is, unless the same function and same user data are given, the
1846     * function will not be removed from the list. This allows us to add the
1847     * same callback several times, with different @p data pointers and be
1848     * able to remove them later without conflicts.
1849     *
1850     * @param obj The anchorview object
1851     * @param func The function to remove from the list
1852     * @param data The data matching the function to remove from the list
1853     */
1854    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);
1855    /**
1856     * @}
1857     */
1858
1859    /* anchorblock */
1860    /**
1861     * @defgroup Anchorblock Anchorblock
1862     *
1863     * Anchorblock is for displaying text that contains markup with anchors
1864     * like <c>\<a href=1234\>something\</\></c> in it.
1865     *
1866     * Besides being styled differently, the anchorblock widget provides the
1867     * necessary functionality so that clicking on these anchors brings up a
1868     * popup with user defined content such as "call", "add to contacts" or
1869     * "open web page". This popup is provided using the @ref Hover widget.
1870     *
1871     * This widget emits the following signals:
1872     * @li "anchor,clicked": will be called when an anchor is clicked. The
1873     * @p event_info parameter on the callback will be a pointer of type
1874     * ::Elm_Entry_Anchorblock_Info.
1875     *
1876     * @see Anchorview
1877     * @see Entry
1878     * @see Hover
1879     *
1880     * Since examples are usually better than plain words, we might as well
1881     * try one. This exampel will show both Anchorblock and @ref Anchorview,
1882     * since both are very similar and it's easier to show them once and side
1883     * by side, so the difference is more clear.
1884     *
1885     * We'll show the relevant snippets of the code here, but the full example
1886     * can be found here... sorry, @ref anchorblock_example_01.c "here".
1887     *
1888     * As for the actual example, it's just a simple window with an anchorblock
1889     * and an anchorview, both containing the same text. After including
1890     * Elementary.h and declaring some functions we'll need, we jump to our
1891     * elm_main (see ELM_MAIN) and create our window.
1892     * @dontinclude anchorblock_example_01.c
1893     * @skip int
1894     * @until const char
1895     * @until ;
1896     *
1897     * With the needed variables declared, we'll create the window and a box to
1898     * hold our widgets, but we don't need to go through that here.
1899     *
1900     * In order to make clear where the anchorblock ends and the anchorview
1901     * begins, they'll be each inside a @ref Frame. After creating the frame,
1902     * the anchorblock follows.
1903     * @skip elm_frame_add
1904     * @until elm_frame_content_set
1905     *
1906     * Nothing out of the ordinary there. What's worth mentioning is the call
1907     * to elm_anchorblock_hover_parent_set(). We are telling our widget that
1908     * when an anchor is clicked, the hover for the popup will cover the entire
1909     * window. This affects the area that will be obscured by the hover and
1910     * where clicking will dismiss it, as well as the calculations it does to
1911     * inform the best locations where to insert the popups content.
1912     * Other than that, the code is pretty standard. We also need to set our
1913     * callback for when an anchor is clicked, since it's our task to populate
1914     * the popup. There's no default for it.
1915     *
1916     * The anchorview is no different, we only change a few things so it looks
1917     * different.
1918     * @until elm_frame_content_set
1919     *
1920     * Then we run, so stuff works and close our main function in the usual way.
1921     * @until ELM_MAIN
1922     *
1923     * Now, a little note. Normally you would use either one of anchorblock or
1924     * anchorview, set your one callback to clicks and do your stuff in there.
1925     * In this example, however, there are a few tricks to make it easier to
1926     * show both widgets in one go (and to save me some typing). So we have
1927     * two callbacks, one per widget, that will call a common function to do
1928     * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
1929     * anchorview too, since both are equal, and passing a callback to use
1930     * for our buttons to end the hover, because each widget has a different
1931     * function for it.
1932     * @until _anchorview_clicked_cb
1933     * @until }
1934     *
1935     * The meat of our popup is in the following function. We check what kind
1936     * of menu we need to show, based on the name set to the anchor in the
1937     * markup text. If there's no type (something went wrong, no valid contact
1938     * in the address list) we are just putting a button that does nothing, but
1939     * it's perfectly reasonable to just end the hover and call it quits.
1940     *
1941     * Our popup will consist of one main button in the middle of our hover,
1942     * and possibly a secondary button and a list of other options. We'll create
1943     * first our main button and check what kind of popup we need afterwards.
1944     * @skip static void
1945     * @skip static void
1946     * @until eina_stringshare_add
1947     * @until }
1948     *
1949     * Each button has two callbacks, one is our hack to close the hover
1950     * properly based on which widget it belongs to, the other a simple
1951     * printf that will show the action with the anchors own data. This is
1952     * not how you would usually do it. Instead, the common case is to have
1953     * one callback for the button that will know which function to call to end
1954     * things, but since we are doing it this way it's worth noting that
1955     * smart callbacks will be called in reverse in respect to the order they
1956     * were added, and since our @c btn_end_cb will close the hover, and thus
1957     * delete our buttons, the other callback wouldn't be called if we had
1958     * added it before.
1959     *
1960     * After our telephone popup, there are a few others that are practically
1961     * the same, so they won't be shown here.
1962     *
1963     * Once we are done with that, it's time to place our actions into our
1964     * hover. Main button goes in the middle without much questioning, and then
1965     * we see if we have a secondary button and a box of extra options.
1966     * Because I said so, secondary button goes on either side and box of
1967     * options either on top or below the main one, but to choose which
1968     * exactly, we use the hints our callback info has, which saves us from
1969     * having to do the math and see which side has more space available, with
1970     * a little special case where we delete our extra stuff if there's nowhere
1971     * to place it.
1972     * @skip url:
1973     * @skip }
1974     * @skip evas_object_smart
1975     * @until evas_object_del(box)
1976     * @until }
1977     * @until }
1978     */
1979    /**
1980     * @example anchorblock_example_01.c
1981     */
1982    /**
1983     * @addtogroup Anchorblock
1984     * @{
1985     */
1986    /**
1987     * @typedef Elm_Entry_Anchorblock_Info
1988     *
1989     * The info sent in the callback for "anchor,clicked" signals emitted by
1990     * the Anchorblock widget.
1991     */
1992    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
1993    /**
1994     * @struct _Elm_Entry_Anchorblock_Info
1995     *
1996     * The info sent in the callback for "anchor,clicked" signals emitted by
1997     * the Anchorblock widget.
1998     */
1999    struct _Elm_Entry_Anchorblock_Info
2000      {
2001         const char     *name; /**< Name of the anchor, as indicated in its href
2002                                    attribute */
2003         int             button; /**< The mouse button used to click on it */
2004         Evas_Object    *hover; /**< The hover object to use for the popup */
2005         struct {
2006              Evas_Coord    x, y, w, h;
2007         } anchor, /**< Geometry selection of text used as anchor */
2008           hover_parent; /**< Geometry of the object used as parent by the
2009                              hover */
2010         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
2011                                              for content on the left side of
2012                                              the hover. Before calling the
2013                                              callback, the widget will make the
2014                                              necessary calculations to check
2015                                              which sides are fit to be set with
2016                                              content, based on the position the
2017                                              hover is activated and its distance
2018                                              to the edges of its parent object
2019                                              */
2020         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
2021                                               the right side of the hover.
2022                                               See @ref hover_left */
2023         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
2024                                             of the hover. See @ref hover_left */
2025         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
2026                                                below the hover. See @ref
2027                                                hover_left */
2028      };
2029    /**
2030     * Add a new Anchorblock object
2031     *
2032     * @param parent The parent object
2033     * @return The new object or NULL if it cannot be created
2034     */
2035    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2036    /**
2037     * Set the text to show in the anchorblock
2038     *
2039     * Sets the text of the anchorblock to @p text. This text can include markup
2040     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
2041     * of text that will be specially styled and react to click events, ended
2042     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
2043     * "anchor,clicked" signal that you can attach a callback to with
2044     * evas_object_smart_callback_add(). The name of the anchor given in the
2045     * event info struct will be the one set in the href attribute, in this
2046     * case, anchorname.
2047     *
2048     * Other markup can be used to style the text in different ways, but it's
2049     * up to the style defined in the theme which tags do what.
2050     */
2051    EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
2052    /**
2053     * Get the markup text set for the anchorblock
2054     *
2055     * Retrieves the text set on the anchorblock, with markup tags included.
2056     *
2057     * @param obj The anchorblock object
2058     * @return The markup text set or @c NULL if nothing was set or an error
2059     * occurred
2060     */
2061    EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2062    /**
2063     * Set the parent of the hover popup
2064     *
2065     * Sets the parent object to use by the hover created by the anchorblock
2066     * when an anchor is clicked. See @ref Hover for more details on this.
2067     *
2068     * @param obj The anchorblock object
2069     * @param parent The object to use as parent for the hover
2070     */
2071    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
2072    /**
2073     * Get the parent of the hover popup
2074     *
2075     * Get the object used as parent for the hover created by the anchorblock
2076     * widget. See @ref Hover for more details on this.
2077     * If no parent is set, the same anchorblock object will be used.
2078     *
2079     * @param obj The anchorblock object
2080     * @return The object used as parent for the hover, NULL if none is set.
2081     */
2082    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2083    /**
2084     * Set the style that the hover should use
2085     *
2086     * When creating the popup hover, anchorblock will request that it's
2087     * themed according to @p style.
2088     *
2089     * @param obj The anchorblock object
2090     * @param style The style to use for the underlying hover
2091     *
2092     * @see elm_object_style_set()
2093     */
2094    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2095    /**
2096     * Get the style that the hover should use
2097     *
2098     * Get the style the hover created by anchorblock will use.
2099     *
2100     * @param obj The anchorblock object
2101     * @return The style to use by the hover. NULL means the default is used.
2102     *
2103     * @see elm_object_style_set()
2104     */
2105    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2106    /**
2107     * Ends the hover popup in the anchorblock
2108     *
2109     * When an anchor is clicked, the anchorblock widget will create a hover
2110     * object to use as a popup with user provided content. This function
2111     * terminates this popup, returning the anchorblock to its normal state.
2112     *
2113     * @param obj The anchorblock object
2114     */
2115    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
2116    /**
2117     * Appends a custom item provider to the given anchorblock
2118     *
2119     * Appends the given function to the list of items providers. This list is
2120     * called, one function at a time, with the given @p data pointer, the
2121     * anchorblock object and, in the @p item parameter, the item name as
2122     * referenced in its href string. Following functions in the list will be
2123     * called in order until one of them returns something different to NULL,
2124     * which should be an Evas_Object which will be used in place of the item
2125     * element.
2126     *
2127     * Items in the markup text take the form \<item relsize=16x16 vsize=full
2128     * href=item/name\>\</item\>
2129     *
2130     * @param obj The anchorblock object
2131     * @param func The function to add to the list of providers
2132     * @param data User data that will be passed to the callback function
2133     *
2134     * @see elm_entry_item_provider_append()
2135     */
2136    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);
2137    /**
2138     * Prepend a custom item provider to the given anchorblock
2139     *
2140     * Like elm_anchorblock_item_provider_append(), but it adds the function
2141     * @p func to the beginning of the list, instead of the end.
2142     *
2143     * @param obj The anchorblock object
2144     * @param func The function to add to the list of providers
2145     * @param data User data that will be passed to the callback function
2146     */
2147    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);
2148    /**
2149     * Remove a custom item provider from the list of the given anchorblock
2150     *
2151     * Removes the function and data pairing that matches @p func and @p data.
2152     * That is, unless the same function and same user data are given, the
2153     * function will not be removed from the list. This allows us to add the
2154     * same callback several times, with different @p data pointers and be
2155     * able to remove them later without conflicts.
2156     *
2157     * @param obj The anchorblock object
2158     * @param func The function to remove from the list
2159     * @param data The data matching the function to remove from the list
2160     */
2161    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);
2162    /**
2163     * @}
2164     */
2165
2166    /* bubble */
2167    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2168    EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2169    EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2170    EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
2171    EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2172
2173    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2174    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2175    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2176    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2177    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2178    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2179    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
2180    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2181    /* smart callbacks called:
2182     * "clicked" - the user clicked the bubble
2183     */
2184
2185    /* photo */
2186    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2187    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
2188    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2189    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
2190    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2191    /* smart callbacks called:
2192     * "clicked" - the user clicked the icon
2193     * "drag,start" - Someone started dragging the image out of the object
2194     * "drag,end" - Dragged item was dropped (somewhere)
2195     */
2196
2197    /* thumb */
2198    typedef enum _Elm_Thumb_Animation_Setting
2199      {
2200         ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
2201         ELM_THUMB_ANIMATION_LOOP,      /* Keep playing animation until stop is requested */
2202         ELM_THUMB_ANIMATION_STOP,
2203         ELM_THUMB_ANIMATION_LAST
2204      } Elm_Thumb_Animation_Setting;
2205
2206    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2207    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
2208    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
2209    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
2210    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
2211    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
2212    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2213    EAPI void                        *elm_thumb_ethumb_client_get(void);
2214    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
2215    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
2216    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2217    /* available styles:
2218     * default
2219     * noframe
2220     */
2221    /* smart callbacks called:
2222     * "clicked" - This is called when a user has clicked the thumb without dragging around.
2223     * "clicked,double" - This is called when a user has double-clicked the thumb.
2224     * "press" - This is called when a user has pressed down the thumb.
2225     * "generate,start" - The thumbnail generation started.
2226     * "generate,stop" - The generation process stopped.
2227     * "generate,error" - The generation failed.
2228     * "load,error" - The thumbnail image loading failed.
2229     */
2230
2231    /* hoversel */
2232    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2233    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2234    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2235    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
2236    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2237    EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2238    EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2239    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2240    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2241    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2242    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
2243    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
2244    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2245    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2246    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2247    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);
2248    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
2249    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
2250    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
2251    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
2252    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);
2253    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);
2254    /* smart callbacks called:
2255     * "clicked" - the user clicked the hoversel button and popped up the sel
2256     * "selected" - an item in the hoversel list is selected
2257     * "dismissed" - the hover is dismissed
2258     */
2259
2260    /* toolbar */
2261    typedef enum _Elm_Toolbar_Shrink_Mode
2262      {
2263         ELM_TOOLBAR_SHRINK_NONE,   /**< set toolbar minimun size to fit all the items */
2264         ELM_TOOLBAR_SHRINK_HIDE,   /**< hide excess items */
2265         ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
2266         ELM_TOOLBAR_SHRINK_MENU    /**< inserts a button to pop up a menu with excess items */
2267      } Elm_Toolbar_Shrink_Mode;
2268
2269    typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
2270    typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
2271
2272    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2273    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
2274    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2275    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
2276    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2277    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
2278    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2279    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);
2280    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);
2281    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);
2282    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);
2283    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2284    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2285    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2286    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2287    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2288    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
2289    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2290    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2291    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2292    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
2293    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2294    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
2295    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2296    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2297    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
2298    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2299    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
2300    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2301    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
2302    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2303    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
2304    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
2305    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2306    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
2307    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2308    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2309    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2310    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2311    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2312    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
2313    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2314    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
2315    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2316    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
2317    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2318    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);
2319    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
2320    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
2321    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
2322    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
2323    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
2324    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
2325    EAPI void                    elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
2326    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);
2327    EAPI void                    elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2328    EAPI void                    elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
2329    EAPI const char             *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2330    EAPI void                    elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
2331    EAPI const char             *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2332    EAPI void                    elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2333    EAPI void                    elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
2334    EAPI const char             *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2335    EAPI void                    elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
2336    EAPI Eina_Bool               elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
2337    /* smart callbacks called:
2338     * "clicked" - when the user clicks on a toolbar item and becomes selected
2339     */
2340    /* available styles:
2341     * default
2342     * transparent (no background or shadow, just show the provided content)
2343     */
2344
2345    /* tooltip */
2346    EAPI double       elm_tooltip_delay_get(void);
2347    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
2348    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
2349    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
2350    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
2351    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);
2352    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2353    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2354    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2355    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
2356    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2357    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2358    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2359    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2360    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
2361    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2362
2363    /* cursors */
2364    EAPI int          elm_cursor_engine_only_get(void);
2365    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
2366
2367    /* menu */
2368    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
2369    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2370    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
2371    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2372    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
2373    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
2374    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2375    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
2376    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);
2377    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
2378    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
2379    EAPI void               elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
2380    EAPI const char        *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
2381    EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
2382    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
2383    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
2384    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
2385    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
2386    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
2387    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
2388    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
2389    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
2390    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
2391    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
2392    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
2393    EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
2394    EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
2395    EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
2396    EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
2397    EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
2398
2399    /* smart callbacks called:
2400     * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
2401     */
2402
2403    /* list */
2404    typedef enum _Elm_List_Mode
2405      {
2406         ELM_LIST_COMPRESS = 0,
2407         ELM_LIST_SCROLL,
2408         ELM_LIST_LIMIT,
2409         ELM_LIST_EXPAND,
2410         ELM_LIST_LAST
2411      } Elm_List_Mode;
2412    typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
2413    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2414    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);
2415    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);
2416    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);
2417    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);
2418    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);
2419    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2420    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
2421    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
2422    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2423    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
2424    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2425    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2426    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2427    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
2428    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2429    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2430    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2431    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2432    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
2433    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
2434    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
2435    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
2436    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
2437    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
2438    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
2439    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
2440    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
2441    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
2442    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
2443    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
2444    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
2445    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
2446    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
2447    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
2448    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
2449    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
2450    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
2451    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);
2452    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
2453    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
2454    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
2455    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
2456    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
2457    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
2458    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
2459    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
2460    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
2461    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
2462    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
2463    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
2464    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2465    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2466    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
2467    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);
2468    /* smart callbacks called:
2469     * "clicked,double" - when the user double-clicked an item
2470     * "selected" - when the user selected an item
2471     * "unselected" - when the user selected an item
2472     * "longpressed" - an item in the hoversel list is long-pressed
2473     * "scroll,edge,top" - the list is scrolled until the top edge
2474     * "scroll,edge,bottom" - the list is scrolled until the bottom edge
2475     * "scroll,edge,left" - the list is scrolled until the left edge
2476     * "scroll,edge,right" - the list is scrolled until the right edge
2477     */
2478
2479    /* slider */
2480    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2481    EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2482    EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2483    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2484    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2485    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2486    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
2487    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2488    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2489    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
2490    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2491    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
2492    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2493    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
2494    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2495    EAPI void               elm_slider_indicator_format_function_set(Evas_Object *obj, const char *(*func)(double val)) EINA_ARG_NONNULL(1);
2496    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2497    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2498    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
2499    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
2500    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
2501    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2502    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
2503    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2504    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
2505    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2506    /* smart callbacks called:
2507     * "changed" - Whenever the slider value is changed by the user.
2508     * "slider,drag,start" - dragging the slider indicator around has started
2509     * "slider,drag,stop" - dragging the slider indicator around has stopped
2510     * "delay,changed" - A short time after the value is changed by the user.
2511     *                   This will be called only when the user stops dragging for a very short
2512     *                   period or when they release their finger/mouse, so it avoids possibly
2513     *                   expensive reactions to the value change.
2514     */
2515
2516    /**
2517     * @addtogroup Actionslider Actionslider
2518     *
2519     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
2520     * properties. The indicator is the element the user drags to choose a label.
2521     * When the position is set with magnet, when released the indicator will be
2522     * moved to it if it's nearest the magnetized position.
2523     *
2524     * @note By default all positions are set as enabled.
2525     *
2526     * Signals that you can add callbacks for are:
2527     *
2528     * "selected" - when user selects an enabled position (the label is passed
2529     *              as event info)".
2530     * @n
2531     * "pos_changed" - when the indicator reaches any of the positions("left",
2532     *                 "right" or "center").
2533     *
2534     * See an example of actionslider usage @ref actionslider_example_page "here"
2535     * @{
2536     */
2537    typedef enum _Elm_Actionslider_Pos
2538      {
2539         ELM_ACTIONSLIDER_NONE = 0,
2540         ELM_ACTIONSLIDER_LEFT = 1 << 0,
2541         ELM_ACTIONSLIDER_CENTER = 1 << 1,
2542         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
2543         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
2544      } Elm_Actionslider_Pos;
2545
2546    /**
2547     * Add a new actionslider to the parent.
2548     *
2549     * @param parent The parent object
2550     * @return The new actionslider object or NULL if it cannot be created
2551     */
2552    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2553    /**
2554     * Set actionslider labels.
2555     *
2556     * @param obj The actionslider object
2557     * @param left_label The label to be set on the left.
2558     * @param center_label The label to be set on the center.
2559     * @param right_label The label to be set on the right.
2560     */
2561    EAPI void                  elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
2562    /**
2563     * Get actionslider labels.
2564     *
2565     * @param obj The actionslider object
2566     * @param left_label A char** to place the left_label of @p obj into.
2567     * @param center_label A char** to place the center_label of @p obj into.
2568     * @param right_label A char** to place the right_label of @p obj into.
2569     */
2570    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);
2571    /**
2572     * Get actionslider selected label.
2573     *
2574     * @param obj The actionslider object
2575     * @return The selected label
2576     */
2577    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2578    /**
2579     * Set actionslider indicator position.
2580     *
2581     * @param obj The actionslider object.
2582     * @param pos The position of the indicator.
2583     */
2584    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
2585    /**
2586     * Get actionslider indicator position.
2587     *
2588     * @param obj The actionslider object.
2589     * @return The position of the indicator.
2590     */
2591    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2592    /**
2593     * Set actionslider magnet position. To make multiple positions magnets @c or
2594     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
2595     *
2596     * @param obj The actionslider object.
2597     * @param pos Bit mask indicating the magnet positions.
2598     */
2599    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
2600    /**
2601     * Get actionslider magnet position.
2602     *
2603     * @param obj The actionslider object.
2604     * @return The positions with magnet property.
2605     */
2606    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2607    /**
2608     * Set actionslider enabled position. To set multiple positions as enabled @c or
2609     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
2610     *
2611     * @note All the positions are enabled by default.
2612     *
2613     * @param obj The actionslider object.
2614     * @param pos Bit mask indicating the enabled positions.
2615     */
2616    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
2617    /**
2618     * Get actionslider enabled position.
2619     *
2620     * @param obj The actionslider object.
2621     * @return The enabled positions.
2622     */
2623    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2624    /**
2625     * Set the label used on the indicator.
2626     *
2627     * @param obj The actionslider object
2628     * @param label The label to be set on the indicator.
2629     */
2630    EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2631    /**
2632     * Get the label used on the indicator object.
2633     *
2634     * @param obj The actionslider object
2635     * @return The indicator label
2636     */
2637    EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2638    /**
2639     * @}
2640     */
2641
2642    /* genlist */
2643    typedef enum _Elm_Genlist_Item_Flags
2644      {
2645         ELM_GENLIST_ITEM_NONE = 0,
2646         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
2647         ELM_GENLIST_ITEM_GROUP = (1 << 1)
2648      } Elm_Genlist_Item_Flags;
2649    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
2650    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
2651    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
2652    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
2653    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
2654    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
2655    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj);
2656    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
2657
2658    struct _Elm_Genlist_Item_Class
2659      {
2660         const char                *item_style;
2661         struct
2662           {
2663              GenlistItemLabelGetFunc  label_get;
2664              GenlistItemIconGetFunc   icon_get;
2665              GenlistItemStateGetFunc  state_get;
2666              GenlistItemDelFunc       del;
2667              GenlistItemMovedFunc     moved;
2668           } func;
2669         const char                *mode_item_style;
2670      };
2671
2672    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2673    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2674    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
2675    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2676    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
2677    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2678    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
2679    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2680    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
2681    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2682    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
2683    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2684    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
2685    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2686    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2687    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2688    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2689    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2690    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
2691    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2692    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
2693    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2694    /* operations to add items */
2695    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);
2696    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);
2697    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);
2698    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);
2699 EAPI Elm_Genlist_Item *elm_genlist_item_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func,const void *func_data);
2700    /* operations to retrieve existing items */
2701    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2702    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2703    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2704    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);
2705    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2706    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2707    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
2708    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);
2709    /* available item styles:
2710     * default
2711     * default_style - The text part is a textblock
2712     * double_label
2713     * icon_top_text_bottom
2714     */
2715    /* Genlist Item operation */
2716    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2717    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2718    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2719    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
2720    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2721    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
2722    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2723    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
2724    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2725    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
2726    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
2727    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2728    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
2729    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
2730    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2731    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2732    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2733    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2734    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
2735    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
2736    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2737    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2738    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
2739    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
2740    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
2741    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2742    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
2743    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
2744    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);
2745    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2746    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
2747    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2748    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
2749    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2750    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2751    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
2752    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2753    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
2754    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
2755    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
2756    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
2757    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2758    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2759    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
2760    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2761    /** Signals that you can add callbacks for are:
2762     * "clicked,double" - This is called when a user has double-clicked an item.
2763     *                    The event_info parameter is the genlist item that was
2764     *                    double-clicked.
2765     * "selected" - This is called when a user has made an item selected. The
2766     *              event_info parameter is the genlist item that was selected.
2767     * "unselected" - This is called when a user has made an item unselected. The
2768     *                 event_info parameter is the genlist item that was
2769     *                 unselected.
2770     * "expanded" - This is called when elm_genlist_item_expanded_set() is called
2771     *              and the item is now meant to be expanded. The event_info
2772     *              parameter is the genlist item that was indicated to expand.
2773     *              It is the job of this callback to then fill in the child
2774     *              items.
2775     * "contracted" - This is called when elm_genlist_item_expanded_set() is
2776     *                called and the item is now meant to be contracted. The
2777     *                event_info parameter is the genlist item that was indicated
2778     *                to contract. It is the job of this callback to then delete
2779     *                the child items.
2780     * "expand,request" - This is called when a user has indicated they want to
2781     *                    expand a tree branch item. The callback should decide
2782     *                    if the item can expand (has any children) and then call
2783     *                    elm_genlist_item_expanded_set() appropriately to set
2784     *                    the state. The event_info parameter is the genlist item
2785     *                    that was indicated to expand.
2786     * "contract,request" - This is called when a user has indicated they want to
2787     *                      contract a tree branch item. The callback should
2788     *                      decide if the item can contract (has any children)
2789     *                      and then call elm_genlist_item_expanded_set()
2790     *                      appropriately to set the state. The event_info
2791     *                      parameter is the genlist item that was indicated to
2792     *                      contract.
2793     * "realized" - This is called when the item in the list is created as a real
2794     *              evas object. event_info parameter is the genlist item that
2795     *              was created. The object may be deleted at any time, so it is
2796     *              up to the caller to not use the object pointer from
2797     *              elm_genlist_item_object_get() in a way where it may point to
2798     *              freed objects.
2799     * "unrealized" - This is called just before an item is unrealized. After
2800     *                this call icon objects provided will be deleted and the
2801     *                item object itself delete or be put into a floating cache.
2802     * "drag,start,up" - This is called when the item in the list has been
2803     *                   dragged (not scrolled) up.
2804     * "drag,start,down" - This is called when the item in the list has been
2805     *                     dragged (not scrolled) down.
2806     * "drag,start,left" - This is called when the item in the list has been
2807     *                     dragged (not scrolled) left.
2808     * "drag,start,right" - This is called when the item in the list has been
2809     *                      dragged (not scrolled) right.
2810     * "drag,stop" - This is called when the item in the list has stopped being
2811     *               dragged.
2812     * "drag" - This is called when the item in the list is being dragged.
2813     * "longpressed" - This is called when the item is pressed for a certain
2814     *                 amount of time. By default it's 1 second.
2815     * "scroll,edge,top" - This is called when the genlist is scrolled until the
2816     *                     top edge.
2817     * "scroll,edge,bottom" - This is called when the genlist is scrolled until
2818     *                        the bottom edge.
2819     * "scroll,edge,left" - This is called when the genlist is scrolled until the
2820     *                      left edge.
2821     * "scroll,edge,right" - This is called when the genlist is scrolled until
2822     *                       the right edge.
2823     * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
2824     *                       left.
2825     * "multi,swipe,right" - This is called when the genlist is multi-touch
2826     *                       swiped right.
2827     * "multi,swipe,up" - This is called when the genlist is multi-touch swiped
2828     *                    up.
2829     * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
2830     *                      down.
2831     * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
2832     *                     out.
2833     * "multi,pinch,in" - This is called when the genlist is multi-touch pinched
2834     *                    in.
2835     * "swipe" - This is called when the genlist is swiped.
2836     */
2837
2838    /* check */
2839    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2840    EAPI void         elm_check_label_set(Evas_Object *obj, const char *label); EINA_ARG_NONNULL(1)
2841    EAPI const char  *elm_check_label_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
2842    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon); EINA_ARG_NONNULL(1)
2843    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
2844    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj); EINA_ARG_NONNULL(1)
2845    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state); EINA_ARG_NONNULL(1)
2846    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
2847    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep); EINA_ARG_NONNULL(1)
2848    /* smart callbacks called:
2849     * "changed" - This is called whenever the user changes the state of one of the check object.
2850     */
2851
2852    /* radio */
2853    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2854    EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2855    EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2856    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2857    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2858    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2859    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
2860    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
2861    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2862    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
2863    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2864    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
2865    /* smart callbacks called:
2866     * "changed" - when the radio status is changed
2867     */
2868
2869    /* pager */
2870    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2871    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2872    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2873    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2874    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2875    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2876    /* available item styles:
2877     * default
2878     * fade
2879     * fade_translucide
2880     * fade_invisible
2881     */
2882    /* smart callbacks called:
2883     * "hide,finished" - when the previous page is hided
2884     */
2885
2886    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
2887    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
2888    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
2889    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
2890    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
2891
2892    struct _Elm_Slideshow_Item_Class
2893      {
2894         struct _Elm_Slideshow_Item_Class_Func
2895           {
2896              SlideshowItemGetFunc get;
2897              SlideshowItemDelFunc del;
2898           } func;
2899      };
2900
2901    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2902    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
2903    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);
2904    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
2905    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
2906    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
2907    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2908    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
2909    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2910    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
2911    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2912    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
2913    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2914    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2915    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2916    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
2917    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
2918    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2919    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
2920    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
2921    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2922    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
2923    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2924    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
2925    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2926    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
2927    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2928    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2929    /* smart callbacks called:
2930     * "changed" - when the slideshow switch to another item
2931     */
2932
2933    /* file selector */
2934    typedef enum _Elm_Fileselector_Mode
2935      {
2936         ELM_FILESELECTOR_LIST = 0,
2937         ELM_FILESELECTOR_GRID,
2938         ELM_FILESELECTOR_LAST
2939      } Elm_Fileselector_Mode;
2940
2941    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2942    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
2943    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2944    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
2945    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2946    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
2947    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2948    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2949    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
2950    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2951    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2952    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2953    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2954    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
2955    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2956    /* smart callbacks called:
2957     * "selected" - the user click on a file
2958     * "directory,open" - the list is populate with a new content. event_info is a directory.
2959     * "done" - the user click on the ok or cancel buttons
2960     */
2961
2962    /* progressbar */
2963    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2964    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
2965    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2966    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
2967    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
2968    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2969    EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2970    EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2971    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2972    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2973    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2974    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
2975    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2976    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
2977    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2978    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2979    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2980    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
2981    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2982    /* smart callbacks called:
2983     */
2984    /* available item styles:
2985     * default
2986     * wheel (simple style, no text, no progression, only pulse is available)
2987     */
2988
2989    /* separator */
2990    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2991    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2992    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2993    /* smart callbacks called:
2994     */
2995
2996    /* spinner */
2997    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2998    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
2999    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3000    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
3001    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
3002    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
3003    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3004    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
3005    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3006    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
3007    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3008    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
3009    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3010    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
3011    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
3012    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3013    /* smart callbacks called:
3014     * "changed" - when the spinner value changes
3015     * "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).
3016     */
3017    /* available item styles:
3018     * default
3019     * vertical (two up/down buttons at the right side and text left aligned)
3020     */
3021
3022    /* index */
3023    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
3024
3025    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3026    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
3027    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3028    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
3029    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3030    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
3031    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
3032    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
3033    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
3034    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
3035    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);
3036    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
3037    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
3038    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3039    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
3040    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
3041    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
3042    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
3043    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
3044    /* smart callbacks called:
3045     * "changed" - when the selected index item changes
3046     * "delay,changed" - when the selected index item changes, but after some small idle period
3047     * "selected" - when the user releases a finger and selects an item
3048     * "level,up" - when the user moves a finger from the first level to the second level
3049     * "level,down" - when the user moves a finger from the second level to the first level
3050     */
3051
3052    /* photocam */
3053    typedef enum _Elm_Photocam_Zoom_Mode
3054      {
3055         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
3056         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
3057         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
3058         ELM_PHOTOCAM_ZOOM_MODE_LAST
3059      } Elm_Photocam_Zoom_Mode;
3060
3061    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3062    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
3063    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3064    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
3065    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3066    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
3067    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3068    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3069    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
3070    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3071    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3072    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
3073    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3074    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3075    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3076    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3077    /* smart callbacks called:
3078     * "clicked" - when image clicked
3079     * "press" - when mouse/finger held down initially on image
3080     * "longpressed" - when mouse/finger held for long time on image
3081     * "clicked,double" - when mouse/finger double-clicked
3082     * "load" - when photo load begins
3083     * "loaded" - when photo load done
3084     * "load,detail" - when detailed image load begins
3085     * "loaded,detail" - when detailed image load done
3086     * "zoom,start" - when zooming started
3087     * "zoom,stop" - when zooming stopped
3088     * "zoom,change" - when auto zoom mode changed zoom level
3089     * "scroll - the content has been scrolled (moved)
3090     * "scroll,anim,start" - scrolling animation has started
3091     * "scroll,anim,stop" - scrolling animation has stopped
3092     * "scroll,drag,start" - dragging the contents around has started
3093     * "scroll,drag,stop" - dragging the contents around has stopped
3094     */
3095
3096    /* map */
3097    typedef enum _Elm_Map_Zoom_Mode
3098      {
3099         ELM_MAP_ZOOM_MODE_MANUAL,
3100         ELM_MAP_ZOOM_MODE_AUTO_FIT,
3101         ELM_MAP_ZOOM_MODE_AUTO_FILL,
3102         ELM_MAP_ZOOM_MODE_LAST
3103      } Elm_Map_Zoom_Mode;
3104
3105    typedef enum _Elm_Map_Route_Sources
3106      {
3107         ELM_MAP_ROUTE_SOURCE_YOURS,
3108         ELM_MAP_ROUTE_SOURCE_MONAV,
3109         ELM_MAP_ROUTE_SOURCE_ORS,
3110         ELM_MAP_ROUTE_SOURCE_LAST
3111      } Elm_Map_Route_Sources;
3112
3113    typedef enum _Elm_Map_Name_Sources
3114      {
3115         ELM_MAP_NAME_SOURCE_NOMINATIM,
3116         ELM_MAP_NAME_SOURCE_LAST
3117      } Elm_Map_Name_Sources;
3118
3119    typedef enum _Elm_Map_Route_Type
3120      {
3121         ELM_MAP_ROUTE_TYPE_MOTOCAR,
3122         ELM_MAP_ROUTE_TYPE_BICYCLE,
3123         ELM_MAP_ROUTE_TYPE_FOOT,
3124         ELM_MAP_ROUTE_TYPE_LAST
3125      } Elm_Map_Route_Type;
3126
3127    typedef enum _Elm_Map_Route_Method
3128      {
3129         ELM_MAP_ROUTE_METHOD_FASTEST,
3130         ELM_MAP_ROUTE_METHOD_SHORTEST,
3131         ELM_MAP_ROUTE_METHOD_LAST
3132      } Elm_Map_Route_Method;
3133
3134    typedef enum _Elm_Map_Name_Method
3135      {
3136         ELM_MAP_NAME_METHOD_SEARCH,
3137         ELM_MAP_NAME_METHOD_REVERSE,
3138         ELM_MAP_NAME_METHOD_LAST
3139      } Elm_Map_Name_Method;
3140
3141    typedef struct _Elm_Map_Marker          Elm_Map_Marker;
3142    typedef struct _Elm_Map_Marker_Class    Elm_Map_Marker_Class;
3143    typedef struct _Elm_Map_Group_Class     Elm_Map_Group_Class;
3144    typedef struct _Elm_Map_Route           Elm_Map_Route;
3145    typedef struct _Elm_Map_Name            Elm_Map_Name;
3146    typedef struct _Elm_Map_Track           Elm_Map_Track;
3147
3148    typedef Evas_Object *(*ElmMapMarkerGetFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
3149    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
3150    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
3151    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data);
3152
3153    typedef char        *(*ElmMapModuleSourceFunc) (void);
3154    typedef int          (*ElmMapModuleZoomMinFunc) (void);
3155    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
3156    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
3157    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
3158    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
3159    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
3160    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
3161    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
3162
3163    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3164    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
3165    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3166    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
3167    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3168    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
3169    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
3170    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
3171    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
3172    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3173    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
3174    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3175    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
3176    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);
3177    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);
3178    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
3179    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
3180    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);
3181    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);
3182    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
3183    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
3184    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
3185    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
3186    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
3187    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
3188    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
3189    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
3190    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
3191    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
3192    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
3193    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
3194    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
3195    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
3196    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
3197    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
3198    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
3199    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
3200    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
3201    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
3202    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
3203    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3204    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
3205    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3206    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
3207    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3208    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
3209    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3210    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
3211    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3212    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
3213    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3214    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);
3215    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
3216    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
3217    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
3218    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
3219    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
3220    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
3221    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
3222    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
3223    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
3224    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
3225    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);
3226    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3227    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3228    EAPI Elm_Map_Track        *elm_map_track_add(Evas_Object *obj, const char *gpx_file) EINA_ARG_NONNULL(1);
3229    EAPI void                  elm_map_track_remove(Elm_Map_Track *track) EINA_ARG_NONNULL(1);
3230    EAPI void                  elm_map_track_color_set(Elm_Map_Track *track, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
3231    EAPI void                  elm_map_track_color_get(const Elm_Map_Track *track, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
3232
3233    /* smart callbacks called:
3234     * "clicked" - when image clicked
3235     * "press" - when mouse/finger held down initially on image
3236     * "longpressed" - when mouse/finger held for long time on image
3237     * "clicked,double" - when mouse/finger double-clicked
3238     * "load,details" - when detailed image load begins
3239     * "loaded,details" - when detailed image load done
3240     * "zoom,start" - when zooming started
3241     * "zoom,stop" - when zooming stopped
3242     * "zoom,change" - when auto zoom mode changed zoom level
3243     * "scroll - the content has been scrolled (moved)
3244     * "scroll,anim,start" - scrolling animation has started
3245     * "scroll,anim,stop" - scrolling animation has stopped
3246     * "scroll,drag,start" - dragging the contents around has started
3247     * "scroll,drag,stop" - dragging the contents around has stopped
3248     */
3249
3250    /* panel */
3251    typedef enum _Elm_Panel_Orient
3252      {
3253         ELM_PANEL_ORIENT_TOP,
3254         ELM_PANEL_ORIENT_BOTTOM,
3255         ELM_PANEL_ORIENT_LEFT,
3256         ELM_PANEL_ORIENT_RIGHT,
3257      } Elm_Panel_Orient;
3258
3259    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3260    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
3261    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3262    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3263    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3264    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3265    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
3266    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3267    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
3268
3269    /* panes */
3270    /**
3271     * TODO
3272     *
3273     * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
3274     * Add events (move, start ...)
3275     */
3276    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3277    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3278    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3279    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3280    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3281    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3282    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3283    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3284    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
3285    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3286    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3287
3288    /* flip */
3289    typedef enum _Elm_Flip_Mode
3290      {
3291         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
3292         ELM_FLIP_ROTATE_X_CENTER_AXIS,
3293         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
3294         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
3295         ELM_FLIP_CUBE_LEFT,
3296         ELM_FLIP_CUBE_RIGHT,
3297         ELM_FLIP_CUBE_UP,
3298         ELM_FLIP_CUBE_DOWN,
3299         ELM_FLIP_PAGE_LEFT,
3300         ELM_FLIP_PAGE_RIGHT,
3301         ELM_FLIP_PAGE_UP,
3302         ELM_FLIP_PAGE_DOWN
3303      } Elm_Flip_Mode;
3304    typedef enum _Elm_Flip_Interaction
3305      {
3306         ELM_FLIP_INTERACTION_NONE,
3307         ELM_FLIP_INTERACTION_ROTATE,
3308         ELM_FLIP_INTERACTION_CUBE,
3309         ELM_FLIP_INTERACTION_PAGE
3310      } Elm_Flip_Interaction;
3311    typedef enum _Elm_Flip_Direction
3312      {
3313         ELM_FLIP_DIRECTION_UP,
3314         ELM_FLIP_DIRECTION_DOWN,
3315         ELM_FLIP_DIRECTION_LEFT,
3316         ELM_FLIP_DIRECTION_RIGHT
3317      } Elm_Flip_Direction;
3318
3319    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3320    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3321    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3322    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3323    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3324    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3325    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3326    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3327    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
3328    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
3329    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
3330    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
3331    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
3332    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
3333    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
3334    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
3335    /* smart callbacks called:
3336     * "animate,begin" - when a flip animation was started
3337     * "animate,done" - when a flip animation is finished
3338     */
3339
3340    /* scrolledentry */
3341    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3342    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
3343    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3344    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
3345    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3346    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3347    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3348    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3349    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3350    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3351    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3352    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3353    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
3354    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3355    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
3356    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3357    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
3358    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
3359    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
3360    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
3361    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3362    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3363    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3364    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3365    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
3366    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3367    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3368    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3369    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3370    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
3371    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3372    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
3373    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
3374    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
3375    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3376    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);
3377    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3378    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3379    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);
3380    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3381    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);
3382    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
3383    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3384    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3385    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
3386    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
3387    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3388    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3389    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
3390    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);
3391    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);
3392    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);
3393    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);
3394    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);
3395    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);
3396    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
3397    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
3398    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
3399    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
3400    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3401    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
3402    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3403
3404    /* conformant */
3405    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3406    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3407    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3408    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3409    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3410
3411    /* mapbuf */
3412    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3413    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3414    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3415    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3416    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
3417    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3418    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3419    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3420    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3421    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3422
3423    /* flipselector */
3424    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item;
3425
3426    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3427    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
3428    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
3429    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, void (*func)(void *data, Evas_Object *obj, void *event_info), void *data) EINA_ARG_NONNULL(1);
3430    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, void (*func)(void *data, Evas_Object *obj, void *event_info), void *data) EINA_ARG_NONNULL(1);
3431    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3432    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3433    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3434    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3435    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3436    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
3437    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
3438    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
3439    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
3440    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
3441    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
3442    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
3443    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3444    /* smart callbacks called:
3445     * "selected" - when flipselector selected item is changed
3446     * "overflowed" - when flipselector item is changed to first item
3447     *                from last item
3448     * "underflowed" - when flipselector item is changed to last item
3449     *                 from first item.
3450     */
3451    /* available styles:
3452     * default
3453     */
3454
3455    /**
3456     * @addtogroup Animator Animator
3457     * @ingroup Elementary
3458     *
3459     * @brief Functions to ease creation of animations.
3460     *
3461     * elm_animator is designed to provide an easy way to create animations.
3462     * Creating an animation with elm_animator is as simple as setting a
3463     * duration, an operating callback and telling it to run the animation.
3464     * However that is not the full extent of elm_animator's ability, animations
3465     * can be paused and resumed, reversed and the animation need not be linear.
3466     *
3467     * To run an animation you must specify at least a duration and operation
3468     * callback, not setting any other properties will create a linear animation
3469     * that runs once and is not reversed.
3470     *
3471     * @ref elm_animator_example_page_01 "This" example should make all of that
3472     * very clear.
3473     *
3474     * @warning elm_animator is @b not a widget.
3475     * @{
3476     */
3477    /**
3478     * @brief Type of curve desired for animation.
3479     *
3480     * The speed in which an animation happens doesn't have to be linear, some
3481     * animations will look better if they're accelerating or decelerating, so
3482     * elm_animator provides four options in this regard:
3483     * @image html elm_animator_curve_style.png
3484     * @image latex elm_animator_curve_style.eps width=\textwidth
3485     * As can be seen in the image the speed of the animation will be:
3486     * @li ELM_ANIMATOR_CURVE_LINEAR constant
3487     * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
3488     * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
3489     * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
3490     */
3491    typedef enum
3492      {
3493         ELM_ANIMATOR_CURVE_LINEAR,
3494         ELM_ANIMATOR_CURVE_IN_OUT,
3495         ELM_ANIMATOR_CURVE_IN,
3496         ELM_ANIMATOR_CURVE_OUT
3497      } Elm_Animator_Curve_Style;
3498    typedef struct _Elm_Animator Elm_Animator;
3499   /**
3500    * Called back per loop of an elementary animators cycle
3501    * @param data user-data given to elm_animator_operation_callback_set()
3502    * @param animator the animator being run
3503    * @param double the position in the animation
3504    */
3505    typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
3506   /**
3507    * Called back when an elementary animator finishes
3508    * @param data user-data given to elm_animator_completion_callback_set()
3509    */
3510    typedef void (*Elm_Animator_Completion_Cb) (void *data);
3511
3512    /**
3513     * @brief Create a new animator.
3514     *
3515     * @param[in] parent Parent object
3516     *
3517     * The @a parent argument can be set to NULL for no parent. If a parent is set
3518     * there is no need to call elm_animator_del(), when the parent is deleted it
3519     * will delete the animator.
3520     */
3521    EINA_DEPRECATED EAPI Elm_Animator*            elm_animator_add(Evas_Object *parent);
3522    /**
3523     * Deletes the animator freeing any resources it used. If the animator was
3524     * created with a NULL parent this must be called, otherwise it will be
3525     * automatically called when the parent is deleted.
3526     *
3527     * @param[in] animator Animator object
3528     */
3529    EINA_DEPRECATED EAPI void                     elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
3530    /**
3531     * Set the duration of the animation.
3532     *
3533     * @param[in] animator Animator object
3534     * @param[in] duration Duration in second
3535     */
3536    EINA_DEPRECATED EAPI void                     elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
3537    /**
3538     * @brief Set the callback function for animator operation.
3539     *
3540     * @param[in] animator Animator object
3541     * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
3542     * @param[in] data Callback function user argument
3543     *
3544     * The @p func callback will be called with a frame value in range [0, 1] which
3545     * indicates how far along the animation should be. It is the job of @p func to
3546     * actually change the state of any object(or objects) that are being animated.
3547     */
3548    EINA_DEPRECATED EAPI void                     elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
3549    /**
3550     * Set the callback function for the when the animation ends.
3551     *
3552     * @param[in]  animator Animator object
3553     * @param[in]  func   Callback function pointe
3554     * @param[in]  data Callback function user argument
3555     *
3556     * @warning @a func will not be executed if elm_animator_stop() is called.
3557     */
3558    EINA_DEPRECATED EAPI void                     elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
3559    /**
3560     * @brief Stop animator.
3561     *
3562     * @param[in] animator Animator object
3563     *
3564     * If called before elm_animator_animate() it does nothing. If there is an
3565     * animation in progress the animation will be stopped(the operation callback
3566     * will not be executed again) and it can't be restarted using
3567     * elm_animator_resume().
3568     */
3569    EINA_DEPRECATED EAPI void                     elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
3570    /**
3571     * Set the animator repeat count.
3572     *
3573     * @param[in]  animator Animator object
3574     * @param[in]  repeat_cnt Repeat count
3575     */
3576    EINA_DEPRECATED EAPI void                     elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
3577    /**
3578     * @brief Start animation.
3579     *
3580     * @param[in] animator Animator object
3581     *
3582     * This function starts the animation if the nescessary properties(duration
3583     * and operation callback) have been set. Once started the animation will
3584     * run until complete or elm_animator_stop() is called.
3585     */
3586    EINA_DEPRECATED EAPI void                     elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
3587    /**
3588     * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
3589     *
3590     * @param[in] animator Animator object
3591     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
3592     */
3593    EINA_DEPRECATED EAPI void                     elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
3594    /**
3595     * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
3596     *
3597     * @param[in] animator Animator object
3598     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
3599     */
3600    EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator); EINA_ARG_NONNULL(1);
3601    /**
3602     * @brief Sets wether the animation should be automatically reversed.
3603     *
3604     * @param[in] animator Animator object
3605     * @param[in] reverse Reverse or not
3606     *
3607     * This controls wether the animation will be run on reverse imediately after
3608     * running forward. When this is set together with repetition the animation
3609     * will run in reverse once for each time it ran forward.@n
3610     * Runnin an animation in reverse is accomplished by calling the operation
3611     * callback with a frame value starting at 1 and diminshing until 0.
3612     */
3613    EINA_DEPRECATED EAPI void                     elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
3614    /**
3615     * Gets wether the animation will automatically reversed
3616     *
3617     * @param[in] animator Animator object
3618     */
3619    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
3620    /**
3621     * Gets the status for the animator operation. The status of the animator @b
3622     * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
3623     * only informs if the animation was started and has not ended(either normally
3624     * or through elm_animator_stop()).
3625     *
3626     * @param[in] animator Animator object
3627     */
3628    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
3629    /**
3630     * Gets how many times the animation will be repeated
3631     *
3632     * @param[in] animator Animator object
3633     */
3634    EINA_DEPRECATED EAPI unsigned int             elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
3635    /**
3636     * Pause the animator.
3637     *
3638     * @param[in]  animator Animator object
3639     *
3640     * This causes the animation to be temporarily stopped(the operation callback
3641     * will not be called). If the animation is not yet running this is a no-op.
3642     * Once an animation has been paused with this function it can be resumed
3643     * using elm_animator_resume().
3644     */
3645    EINA_DEPRECATED EAPI void                     elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
3646    /**
3647     * @brief Resumes the animator.
3648     *
3649     * @param[in]  animator Animator object
3650     *
3651     * Resumes an animation that was paused using elm_animator_pause(), after
3652     * calling this function calls to the operation callback will happen
3653     * normally. If an animation is stopped by means of elm_animator_stop it
3654     * @b can't be restarted with this function.@n
3655     *
3656     * @warning When an animation is resumed it doesn't start from where it was paused, it
3657     * will go to where it would have been if it had not been paused. If an
3658     * animation with a duration of 3 seconds is paused after 1 second for 1 second
3659     * it will resume as if it had ben animating for 2 seconds, the operating
3660     * callback will be called with a frame value of aproximately 2/3.
3661     */
3662    EINA_DEPRECATED EAPI void                     elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
3663    /**
3664     * @}
3665     */
3666
3667    /* calendar */
3668    typedef enum
3669      {
3670         ELM_CALENDAR_UNIQUE,
3671         ELM_CALENDAR_DAILY,
3672         ELM_CALENDAR_WEEKLY,
3673         ELM_CALENDAR_MONTHLY,
3674         ELM_CALENDAR_ANNUALLY
3675      } Elm_Calendar_Mark_Repeat;
3676    typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
3677
3678    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3679    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3680    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
3681    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3682    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
3683    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
3684    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
3685    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3686    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
3687    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
3688    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
3689    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
3690    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);
3691    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
3692    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3693    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3694    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
3695    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
3696    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
3697    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
3698    /* smart callbacks called:
3699     * changed - emitted when the user select a day or change the displayed
3700     * month.
3701     */
3702
3703    /* diskselector */
3704    typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
3705
3706    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3707    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3708    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
3709    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3710    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
3711    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3712    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
3713    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3714    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3715    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);
3716    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
3717    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3718    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3719    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);
3720    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
3721    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
3722    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
3723    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
3724    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
3725    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
3726    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
3727    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3728    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3729    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
3730    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3731    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3732    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
3733    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
3734    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
3735    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);
3736    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
3737    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
3738    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
3739    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3740    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
3741    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
3742    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
3743    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
3744    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3745    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
3746    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
3747    /* smart callbacks called:
3748     * "selected" - when item is selected (scroller stops)
3749     */
3750
3751    /* colorselector */
3752    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3753    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
3754    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
3755    /* smart callbacks called:
3756     * "changed" - when the color value changes
3757     */
3758
3759    /* Contextual Popup */
3760    typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
3761
3762    typedef enum _Elm_Ctxpopup_Direction
3763      {
3764         ELM_CTXPOPUP_DIRECTION_DOWN,
3765         ELM_CTXPOPUP_DIRECTION_RIGHT,
3766         ELM_CTXPOPUP_DIRECTION_LEFT,
3767         ELM_CTXPOPUP_DIRECTION_UP,
3768      } Elm_Ctxpopup_Direction;
3769
3770    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3771    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
3772    EAPI void          elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
3773    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
3774    EAPI void          elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
3775    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
3776    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3777    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3778    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3779    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3780    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);
3781    EAPI void          elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
3782    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3783    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
3784    EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
3785    EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3786    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);
3787    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);
3788    /* smart callbacks called:
3789     * "dismissed" - the ctxpopup was dismissed
3790     */
3791
3792    /* transit */
3793    /**
3794     *
3795     * @defgroup Transit Transit
3796     * @ingroup Elementary
3797     *
3798     * Transit is designed to apply various animated transition effects to @c
3799     * Evas_Object, such like translation, rotation, etc. For using these
3800     * effects, create an @ref Elm_Transit and add the desired transition effects.
3801     *
3802     * Once the effects are added into transit, they will be automatically
3803     * managed (their callback will be called until the duration is ended, and
3804     * they will be deleted on completion).
3805     *
3806     * Example:
3807     * @code
3808     * Elm_Transit *trans = elm_transit_add();
3809     * elm_transit_object_add(trans, obj);
3810     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
3811     * elm_transit_duration_set(transit, 1);
3812     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
3813     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
3814     * elm_transit_repeat_times_set(transit, 3);
3815     * @endcode
3816     *
3817     * Some transition effects are used to change the properties of objects. They
3818     * are:
3819     * @li @ref elm_transit_effect_translation_add
3820     * @li @ref elm_transit_effect_color_add
3821     * @li @ref elm_transit_effect_rotation_add
3822     * @li @ref elm_transit_effect_wipe_add
3823     * @li @ref elm_transit_effect_zoom_add
3824     * @li @ref elm_transit_effect_resizing_add
3825     *
3826     * Other transition effects are used to make one object disappear and another
3827     * object appear on its old place. These effects are:
3828     *
3829     * @li @ref elm_transit_effect_flip_add
3830     * @li @ref elm_transit_effect_resizable_flip_add
3831     * @li @ref elm_transit_effect_fade_add
3832     * @li @ref elm_transit_effect_blend_add
3833     *
3834     * It's also possible to make a transition chain with @ref
3835     * elm_transit_chain_transit_add.
3836     *
3837     * @warning We strongly recomend to use elm_transit just when edje can not do
3838     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
3839     * animations can be manipulated inside the theme.
3840     *
3841     * List of examples:
3842     * @li @ref transit_example_01_explained
3843     * @li @ref transit_example_02_explained
3844     * @li @ref transit_example_03_c
3845     * @li @ref transit_example_04_c
3846     *
3847     * @{
3848     */
3849
3850    /**
3851     * @enum Elm_Transit_Tween_Mode
3852     *
3853     * The type of acceleration used in the transition.
3854     */
3855    typedef enum
3856      {
3857         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
3858         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
3859                                              over time, then decrease again
3860                                              and stop slowly */
3861         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
3862                                              speed over time */
3863         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
3864                                             over time */
3865      } Elm_Transit_Tween_Mode;
3866
3867    /**
3868     * @enum Elm_Transit_Effect_Flip_Axis
3869     *
3870     * The axis where flip effect should be applied.
3871     */
3872    typedef enum
3873      {
3874         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
3875         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
3876      } Elm_Transit_Effect_Flip_Axis;
3877    /**
3878     * @enum Elm_Transit_Effect_Wipe_Dir
3879     *
3880     * The direction where the wipe effect should occur.
3881     */
3882    typedef enum
3883      {
3884         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
3885         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
3886         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
3887         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
3888      } Elm_Transit_Effect_Wipe_Dir;
3889    /** @enum Elm_Transit_Effect_Wipe_Type
3890     *
3891     * Whether the wipe effect should show or hide the object.
3892     */
3893    typedef enum
3894      {
3895         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
3896                                              animation */
3897         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
3898                                             animation */
3899      } Elm_Transit_Effect_Wipe_Type;
3900
3901    /**
3902     * @typedef Elm_Transit
3903     *
3904     * The Transit created with elm_transit_add(). This type has the information
3905     * about the objects which the transition will be applied, and the
3906     * transition effects that will be used. It also contains info about
3907     * duration, number of repetitions, auto-reverse, etc.
3908     */
3909    typedef struct _Elm_Transit Elm_Transit;
3910    typedef void Elm_Transit_Effect;
3911    /**
3912     * @typedef Elm_Transit_Effect_Transition_Cb
3913     *
3914     * Transition callback called for this effect on each transition iteration.
3915     */
3916    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
3917    /**
3918     * Elm_Transit_Effect_End_Cb
3919     *
3920     * Transition callback called for this effect when the transition is over.
3921     */
3922    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
3923
3924    /**
3925     * Add new transit.
3926     *
3927     * @note Is not necessary to delete the transit object, it will be deleted at
3928     * the end of its operation.
3929     * @note The transit will start playing when the program enter in the main loop, is not
3930     * necessary to give a start to the transit.
3931     *
3932     * @return The transit object.
3933     *
3934     * @ingroup Transit
3935     */
3936    EAPI Elm_Transit                *elm_transit_add(void);
3937
3938    /**
3939     * Stops the animation and delete the @p transit object.
3940     *
3941     * Call this function if you wants to stop the animation before the duration
3942     * time. Make sure the @p transit object is still alive with
3943     * elm_transit_del_cb_set() function.
3944     * All added effects will be deleted, calling its repective data_free_cb
3945     * functions. The function setted by elm_transit_del_cb_set() will be called.
3946     *
3947     * @see elm_transit_del_cb_set()
3948     *
3949     * @param transit The transit object to be deleted.
3950     *
3951     * @ingroup Transit
3952     * @warning Just call this function if you are sure the transit is alive.
3953     */
3954    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
3955
3956    /**
3957     * Add a new effect to the transit.
3958     *
3959     * @note The cb function and the data are the key to the effect. If you try to
3960     * add an already added effect, nothing is done.
3961     * @note After the first addition of an effect in @p transit, if its
3962     * effect list become empty again, the @p transit will be killed by
3963     * elm_transit_del(transit) function.
3964     *
3965     * Exemple:
3966     * @code
3967     * Elm_Transit *transit = elm_transit_add();
3968     * elm_transit_effect_add(transit,
3969     *                        elm_transit_effect_blend_op,
3970     *                        elm_transit_effect_blend_context_new(),
3971     *                        elm_transit_effect_blend_context_free);
3972     * @endcode
3973     *
3974     * @param transit The transit object.
3975     * @param transition_cb The operation function. It is called when the
3976     * animation begins, it is the function that actually performs the animation.
3977     * It is called with the @p data, @p transit and the time progression of the
3978     * animation (a double value between 0.0 and 1.0).
3979     * @param effect The context data of the effect.
3980     * @param end_cb The function to free the context data, it will be called
3981     * at the end of the effect, it must finalize the animation and free the
3982     * @p data.
3983     *
3984     * @ingroup Transit
3985     * @warning The transit free the context data at the and of the transition with
3986     * the data_free_cb function, do not use the context data in another transit.
3987     */
3988    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);
3989
3990    /**
3991     * Delete an added effect.
3992     *
3993     * This function will remove the effect from the @p transit, calling the
3994     * data_free_cb to free the @p data.
3995     *
3996     * @see elm_transit_effect_add()
3997     *
3998     * @note If the effect is not found, nothing is done.
3999     * @note If the effect list become empty, this function will call
4000     * elm_transit_del(transit), that is, it will kill the @p transit.
4001     *
4002     * @param transit The transit object.
4003     * @param transition_cb The operation function.
4004     * @param effect The context data of the effect.
4005     *
4006     * @ingroup Transit
4007     */
4008    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);
4009
4010    /**
4011     * Add new object to apply the effects.
4012     *
4013     * @note After the first addition of an object in @p transit, if its
4014     * object list become empty again, the @p transit will be killed by
4015     * elm_transit_del(transit) function.
4016     * @note If the @p obj belongs to another transit, the @p obj will be
4017     * removed from it and it will only belong to the @p transit. If the old
4018     * transit stays without objects, it will die.
4019     * @note When you add an object into the @p transit, its state from
4020     * evas_object_pass_events_get(obj) is saved, and it is applied when the
4021     * transit ends, if you change this state whith evas_object_pass_events_set()
4022     * after add the object, this state will change again when @p transit stops to
4023     * run.
4024     *
4025     * @param transit The transit object.
4026     * @param obj Object to be animated.
4027     *
4028     * @ingroup Transit
4029     * @warning It is not allowed to add a new object after transit begins to go.
4030     */
4031    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
4032
4033    /**
4034     * Removes an added object from the transit.
4035     *
4036     * @note If the @p obj is not in the @p transit, nothing is done.
4037     * @note If the list become empty, this function will call
4038     * elm_transit_del(transit), that is, it will kill the @p transit.
4039     *
4040     * @param transit The transit object.
4041     * @param obj Object to be removed from @p transit.
4042     *
4043     * @ingroup Transit
4044     * @warning It is not allowed to remove objects after transit begins to go.
4045     */
4046    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
4047
4048    /**
4049     * Get the objects of the transit.
4050     *
4051     * @param transit The transit object.
4052     * @return a Eina_List with the objects from the transit.
4053     *
4054     * @ingroup Transit
4055     */
4056    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
4057
4058    /**
4059     * Enable/disable keeping up the objects states.
4060     * If it is not kept, the objects states will be reset when transition ends.
4061     *
4062     * @note @p transit can not be NULL.
4063     * @note One state includes geometry, color, map data.
4064     *
4065     * @param transit The transit object.
4066     * @param state_keep Keeping or Non Keeping.
4067     *
4068     * @ingroup Transit
4069     */
4070    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
4071
4072    /**
4073     * Get a value whether the objects states will be reset or not.
4074     *
4075     * @note @p transit can not be NULL
4076     *
4077     * @see elm_transit_objects_final_state_keep_set()
4078     *
4079     * @param transit The transit object.
4080     * @return EINA_TRUE means the states of the objects will be reset.
4081     * If @p transit is NULL, EINA_FALSE is returned
4082     *
4083     * @ingroup Transit
4084     */
4085    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
4086
4087    /**
4088     * Set the event enabled when transit is operating.
4089     *
4090     * If @p enabled is EINA_TRUE, the objects of the transit will receives
4091     * events from mouse and keyboard during the animation.
4092     * @note When you add an object with elm_transit_object_add(), its state from
4093     * evas_object_pass_events_get(obj) is saved, and it is applied when the
4094     * transit ends, if you change this state with evas_object_pass_events_set()
4095     * after adding the object, this state will change again when @p transit stops
4096     * to run.
4097     *
4098     * @param transit The transit object.
4099     * @param enabled Events are received when enabled is @c EINA_TRUE, and
4100     * ignored otherwise.
4101     *
4102     * @ingroup Transit
4103     */
4104    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4105
4106    /**
4107     * Get the value of event enabled status.
4108     *
4109     * @see elm_transit_event_enabled_set()
4110     *
4111     * @param transit The Transit object
4112     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
4113     * EINA_FALSE is returned
4114     *
4115     * @ingroup Transit
4116     */
4117    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
4118
4119    /**
4120     * Set the user-callback function when the transit is deleted.
4121     *
4122     * @note Using this function twice will overwrite the first function setted.
4123     * @note the @p transit object will be deleted after call @p cb function.
4124     *
4125     * @param transit The transit object.
4126     * @param cb Callback function pointer. This function will be called before
4127     * the deletion of the transit.
4128     * @param data Callback funtion user data. It is the @p op parameter.
4129     *
4130     * @ingroup Transit
4131     */
4132    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, void (*cb)(void *data, Elm_Transit* transit), void *data) EINA_ARG_NONNULL(1);
4133
4134    /**
4135     * Set reverse effect automatically.
4136     *
4137     * If auto reverse is setted, after running the effects with the progress
4138     * parameter from 0 to 1, it will call the effecs again with the progress
4139     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
4140     * where the duration was setted with the function elm_transit_add and
4141     * the repeat with the function elm_transit_repeat_times_set().
4142     *
4143     * @param transit The transit object.
4144     * @param reverse EINA_TRUE means the auto_reverse is on.
4145     *
4146     * @ingroup Transit
4147     */
4148    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
4149
4150    /**
4151     * Get if the auto reverse is on.
4152     *
4153     * @see elm_transit_auto_reverse_set()
4154     *
4155     * @param transit The transit object.
4156     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
4157     * EINA_FALSE is returned
4158     *
4159     * @ingroup Transit
4160     */
4161    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
4162
4163    /**
4164     * Set the transit repeat count. Effect will be repeated by repeat count.
4165     *
4166     * This function sets the number of repetition the transit will run after
4167     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
4168     * If the @p repeat is a negative number, it will repeat infinite times.
4169     *
4170     * @note If this function is called during the transit execution, the transit
4171     * will run @p repeat times, ignoring the times it already performed.
4172     *
4173     * @param transit The transit object
4174     * @param repeat Repeat count
4175     *
4176     * @ingroup Transit
4177     */
4178    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
4179
4180    /**
4181     * Get the transit repeat count.
4182     *
4183     * @see elm_transit_repeat_times_set()
4184     *
4185     * @param transit The Transit object.
4186     * @return The repeat count. If @p transit is NULL
4187     * 0 is returned
4188     *
4189     * @ingroup Transit
4190     */
4191    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
4192
4193    /**
4194     * Set the transit animation acceleration type.
4195     *
4196     * This function sets the tween mode of the transit that can be:
4197     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
4198     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
4199     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
4200     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
4201     *
4202     * @param transit The transit object.
4203     * @param tween_mode The tween type.
4204     *
4205     * @ingroup Transit
4206     */
4207    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
4208
4209    /**
4210     * Get the transit animation acceleration type.
4211     *
4212     * @note @p transit can not be NULL
4213     *
4214     * @param transit The transit object.
4215     * @return The tween type. If @p transit is NULL
4216     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
4217     *
4218     * @ingroup Transit
4219     */
4220    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
4221
4222    /**
4223     * Set the transit animation time
4224     *
4225     * @note @p transit can not be NULL
4226     *
4227     * @param transit The transit object.
4228     * @param duration The animation time.
4229     *
4230     * @ingroup Transit
4231     */
4232    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
4233
4234    /**
4235     * Get the transit animation time
4236     *
4237     * @note @p transit can not be NULL
4238     *
4239     * @param transit The transit object.
4240     *
4241     * @return The transit animation time.
4242     *
4243     * @ingroup Transit
4244     */
4245    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
4246
4247    /**
4248     * Starts the transition.
4249     * Once this API is called, the transit begins to measure the time.
4250     *
4251     * @note @p transit can not be NULL
4252     *
4253     * @param transit The transit object.
4254     *
4255     * @ingroup Transit
4256     */
4257    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
4258
4259    /**
4260     * Pause/Resume the transition.
4261     *
4262     * If you call elm_transit_go again, the transit will be started from the
4263     * beginning, and will be unpaused.
4264     *
4265     * @note @p transit can not be NULL
4266     *
4267     * @param transit The transit object.
4268     * @param paused Whether the transition should be paused or not.
4269     *
4270     * @ingroup Transit
4271     */
4272    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
4273
4274    /**
4275     * Get the value of paused status.
4276     *
4277     * @see elm_transit_paused_set()
4278     *
4279     * @note @p transit can not be NULL
4280     *
4281     * @param transit The transit object.
4282     * @return EINA_TRUE means transition is paused. If @p transit is NULL
4283     * EINA_FALSE is returned
4284     *
4285     * @ingroup Transit
4286     */
4287    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
4288
4289    /**
4290     * Get the time progression of the animation (a double value between 0.0 and 1.0).
4291     *
4292     * The value returned is a fraction (current time / total time). It
4293     * represents the progression position relative to the total.
4294     *
4295     * @note @p transit can not be NULL
4296     *
4297     * @param transit The transit object.
4298     *
4299     * @return The time progression value. If @p transit is NULL
4300     * 0 is returned
4301     *
4302     * @ingroup Transit
4303     */
4304    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
4305
4306    /**
4307     * Makes the chain relationship between two transits.
4308     *
4309     * @note @p transit can not be NULL. Transit would have multiple chain transits.
4310     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
4311     *
4312     * @param transit The transit object.
4313     * @param chain_transit The chain transit object. This transit will be operated
4314     *        after transit is done.
4315     *
4316     * This function adds @p chain_transit transition to a chain after the @p
4317     * transit, and will be started as soon as @p transit ends. See @ref
4318     * transit_example_02_explained for a full example.
4319     *
4320     * @ingroup Transit
4321     */
4322    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
4323
4324    /**
4325     * Get the current chain transit list.
4326     *
4327     * @note @p transit can not be NULL.
4328     *
4329     * @param transit The transit object.
4330     * @return chain transit list.
4331     *
4332     * @ingroup Transit
4333     */
4334    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
4335
4336    /**
4337     * Add the Resizing Effect to Elm_Transit.
4338     *
4339     * @note This API is one of the facades. It creates resizing effect context
4340     * and add it's required APIs to elm_transit_effect_add.
4341     *
4342     * @see elm_transit_effect_add()
4343     *
4344     * @param transit Transit object.
4345     * @param from_w Object width size when effect begins.
4346     * @param from_h Object height size when effect begins.
4347     * @param to_w Object width size when effect ends.
4348     * @param to_h Object height size when effect ends.
4349     * @return Resizing effect context data.
4350     *
4351     * @ingroup Transit
4352     */
4353    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);
4354
4355    /**
4356     * Add the Translation Effect to Elm_Transit.
4357     *
4358     * @note This API is one of the facades. It creates translation effect context
4359     * and add it's required APIs to elm_transit_effect_add.
4360     *
4361     * @see elm_transit_effect_add()
4362     *
4363     * @param transit Transit object.
4364     * @param from_dx X Position variation when effect begins.
4365     * @param from_dy Y Position variation when effect begins.
4366     * @param to_dx X Position variation when effect ends.
4367     * @param to_dy Y Position variation when effect ends.
4368     * @return Translation effect context data.
4369     *
4370     * @ingroup Transit
4371     * @warning It is highly recommended just create a transit with this effect when
4372     * the window that the objects of the transit belongs has already been created.
4373     * This is because this effect needs the geometry information about the objects,
4374     * and if the window was not created yet, it can get a wrong information.
4375     */
4376    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);
4377
4378    /**
4379     * Add the Zoom Effect to Elm_Transit.
4380     *
4381     * @note This API is one of the facades. It creates zoom effect context
4382     * and add it's required APIs to elm_transit_effect_add.
4383     *
4384     * @see elm_transit_effect_add()
4385     *
4386     * @param transit Transit object.
4387     * @param from_rate Scale rate when effect begins (1 is current rate).
4388     * @param to_rate Scale rate when effect ends.
4389     * @return Zoom effect context data.
4390     *
4391     * @ingroup Transit
4392     * @warning It is highly recommended just create a transit with this effect when
4393     * the window that the objects of the transit belongs has already been created.
4394     * This is because this effect needs the geometry information about the objects,
4395     * and if the window was not created yet, it can get a wrong information.
4396     */
4397    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
4398
4399    /**
4400     * Add the Flip Effect to Elm_Transit.
4401     *
4402     * @note This API is one of the facades. It creates flip effect context
4403     * and add it's required APIs to elm_transit_effect_add.
4404     * @note This effect is applied to each pair of objects in the order they are listed
4405     * in the transit list of objects. The first object in the pair will be the
4406     * "front" object and the second will be the "back" object.
4407     *
4408     * @see elm_transit_effect_add()
4409     *
4410     * @param transit Transit object.
4411     * @param axis Flipping Axis(X or Y).
4412     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
4413     * @return Flip effect context data.
4414     *
4415     * @ingroup Transit
4416     * @warning It is highly recommended just create a transit with this effect when
4417     * the window that the objects of the transit belongs has already been created.
4418     * This is because this effect needs the geometry information about the objects,
4419     * and if the window was not created yet, it can get a wrong information.
4420     */
4421    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
4422
4423    /**
4424     * Add the Resizable Flip Effect to Elm_Transit.
4425     *
4426     * @note This API is one of the facades. It creates resizable flip effect context
4427     * and add it's required APIs to elm_transit_effect_add.
4428     * @note This effect is applied to each pair of objects in the order they are listed
4429     * in the transit list of objects. The first object in the pair will be the
4430     * "front" object and the second will be the "back" object.
4431     *
4432     * @see elm_transit_effect_add()
4433     *
4434     * @param transit Transit object.
4435     * @param axis Flipping Axis(X or Y).
4436     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
4437     * @return Resizable flip effect context data.
4438     *
4439     * @ingroup Transit
4440     * @warning It is highly recommended just create a transit with this effect when
4441     * the window that the objects of the transit belongs has already been created.
4442     * This is because this effect needs the geometry information about the objects,
4443     * and if the window was not created yet, it can get a wrong information.
4444     */
4445    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
4446
4447    /**
4448     * Add the Wipe Effect to Elm_Transit.
4449     *
4450     * @note This API is one of the facades. It creates wipe effect context
4451     * and add it's required APIs to elm_transit_effect_add.
4452     *
4453     * @see elm_transit_effect_add()
4454     *
4455     * @param transit Transit object.
4456     * @param type Wipe type. Hide or show.
4457     * @param dir Wipe Direction.
4458     * @return Wipe effect context data.
4459     *
4460     * @ingroup Transit
4461     * @warning It is highly recommended just create a transit with this effect when
4462     * the window that the objects of the transit belongs has already been created.
4463     * This is because this effect needs the geometry information about the objects,
4464     * and if the window was not created yet, it can get a wrong information.
4465     */
4466    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
4467
4468    /**
4469     * Add the Color Effect to Elm_Transit.
4470     *
4471     * @note This API is one of the facades. It creates color effect context
4472     * and add it's required APIs to elm_transit_effect_add.
4473     *
4474     * @see elm_transit_effect_add()
4475     *
4476     * @param transit        Transit object.
4477     * @param  from_r        RGB R when effect begins.
4478     * @param  from_g        RGB G when effect begins.
4479     * @param  from_b        RGB B when effect begins.
4480     * @param  from_a        RGB A when effect begins.
4481     * @param  to_r          RGB R when effect ends.
4482     * @param  to_g          RGB G when effect ends.
4483     * @param  to_b          RGB B when effect ends.
4484     * @param  to_a          RGB A when effect ends.
4485     * @return               Color effect context data.
4486     *
4487     * @ingroup Transit
4488     */
4489    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);
4490
4491    /**
4492     * Add the Fade Effect to Elm_Transit.
4493     *
4494     * @note This API is one of the facades. It creates fade effect context
4495     * and add it's required APIs to elm_transit_effect_add.
4496     * @note This effect is applied to each pair of objects in the order they are listed
4497     * in the transit list of objects. The first object in the pair will be the
4498     * "before" object and the second will be the "after" object.
4499     *
4500     * @see elm_transit_effect_add()
4501     *
4502     * @param transit Transit object.
4503     * @return Fade effect context data.
4504     *
4505     * @ingroup Transit
4506     * @warning It is highly recommended just create a transit with this effect when
4507     * the window that the objects of the transit belongs has already been created.
4508     * This is because this effect needs the color information about the objects,
4509     * and if the window was not created yet, it can get a wrong information.
4510     */
4511    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
4512
4513    /**
4514     * Add the Blend Effect to Elm_Transit.
4515     *
4516     * @note This API is one of the facades. It creates blend effect context
4517     * and add it's required APIs to elm_transit_effect_add.
4518     * @note This effect is applied to each pair of objects in the order they are listed
4519     * in the transit list of objects. The first object in the pair will be the
4520     * "before" object and the second will be the "after" object.
4521     *
4522     * @see elm_transit_effect_add()
4523     *
4524     * @param transit Transit object.
4525     * @return Blend effect context data.
4526     *
4527     * @ingroup Transit
4528     * @warning It is highly recommended just create a transit with this effect when
4529     * the window that the objects of the transit belongs has already been created.
4530     * This is because this effect needs the color information about the objects,
4531     * and if the window was not created yet, it can get a wrong information.
4532     */
4533    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
4534
4535    /**
4536     * Add the Rotation Effect to Elm_Transit.
4537     *
4538     * @note This API is one of the facades. It creates rotation effect context
4539     * and add it's required APIs to elm_transit_effect_add.
4540     *
4541     * @see elm_transit_effect_add()
4542     *
4543     * @param transit Transit object.
4544     * @param from_degree Degree when effect begins.
4545     * @param to_degree Degree when effect is ends.
4546     * @return Rotation effect context data.
4547     *
4548     * @ingroup Transit
4549     * @warning It is highly recommended just create a transit with this effect when
4550     * the window that the objects of the transit belongs has already been created.
4551     * This is because this effect needs the geometry information about the objects,
4552     * and if the window was not created yet, it can get a wrong information.
4553     */
4554    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
4555
4556    /**
4557     * Add the ImageAnimation Effect to Elm_Transit.
4558     *
4559     * @note This API is one of the facades. It creates image animation effect context
4560     * and add it's required APIs to elm_transit_effect_add.
4561     * The @p images parameter is a list images paths. This list and
4562     * its contents will be deleted at the end of the effect by
4563     * elm_transit_effect_image_animation_context_free() function.
4564     *
4565     * Example:
4566     * @code
4567     * char buf[PATH_MAX];
4568     * Eina_List *images = NULL;
4569     * Elm_Transit *transi = elm_transit_add();
4570     *
4571     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
4572     * images = eina_list_append(images, eina_stringshare_add(buf));
4573     *
4574     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
4575     * images = eina_list_append(images, eina_stringshare_add(buf));
4576     * elm_transit_effect_image_animation_add(transi, images);
4577     *
4578     * @endcode
4579     *
4580     * @see elm_transit_effect_add()
4581     *
4582     * @param transit Transit object.
4583     * @param images Eina_List of images file paths. This list and
4584     * its contents will be deleted at the end of the effect by
4585     * elm_transit_effect_image_animation_context_free() function.
4586     * @return Image Animation effect context data.
4587     *
4588     * @ingroup Transit
4589     */
4590    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
4591    /**
4592     * @}
4593     */
4594
4595   typedef struct _Elm_Store                      Elm_Store;
4596   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
4597   typedef struct _Elm_Store_Item                 Elm_Store_Item;
4598   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
4599   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
4600   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
4601   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
4602   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
4603   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
4604   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
4605   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
4606
4607   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
4608   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
4609   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
4610   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
4611
4612   typedef enum
4613     {
4614        ELM_STORE_ITEM_MAPPING_NONE = 0,
4615        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
4616        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
4617        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
4618        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
4619        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
4620        // can add more here as needed by common apps
4621        ELM_STORE_ITEM_MAPPING_LAST
4622     } Elm_Store_Item_Mapping_Type;
4623
4624   struct _Elm_Store_Item_Mapping_Icon
4625     {
4626        // FIXME: allow edje file icons
4627        int                   w, h;
4628        Elm_Icon_Lookup_Order lookup_order;
4629        Eina_Bool             standard_name : 1;
4630        Eina_Bool             no_scale : 1;
4631        Eina_Bool             smooth : 1;
4632        Eina_Bool             scale_up : 1;
4633        Eina_Bool             scale_down : 1;
4634     };
4635
4636   struct _Elm_Store_Item_Mapping_Empty
4637     {
4638        Eina_Bool             dummy;
4639     };
4640
4641   struct _Elm_Store_Item_Mapping_Photo
4642     {
4643        int                   size;
4644     };
4645
4646   struct _Elm_Store_Item_Mapping_Custom
4647     {
4648        Elm_Store_Item_Mapping_Cb func;
4649     };
4650
4651   struct _Elm_Store_Item_Mapping
4652     {
4653        Elm_Store_Item_Mapping_Type     type;
4654        const char                     *part;
4655        int                             offset;
4656        union
4657          {
4658             Elm_Store_Item_Mapping_Empty  empty;
4659             Elm_Store_Item_Mapping_Icon   icon;
4660             Elm_Store_Item_Mapping_Photo  photo;
4661             Elm_Store_Item_Mapping_Custom custom;
4662             // add more types here
4663          } details;
4664     };
4665
4666   struct _Elm_Store_Item_Info
4667     {
4668       Elm_Genlist_Item_Class       *item_class;
4669       const Elm_Store_Item_Mapping *mapping;
4670       void                         *data;
4671       char                         *sort_id;
4672     };
4673
4674   struct _Elm_Store_Item_Info_Filesystem
4675     {
4676       Elm_Store_Item_Info  base;
4677       char                *path;
4678     };
4679
4680 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
4681 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
4682
4683   EAPI void                    elm_store_free(Elm_Store *st);
4684
4685   EAPI Elm_Store              *elm_store_filesystem_new(void);
4686   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
4687   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
4688   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
4689
4690   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
4691
4692   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
4693   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
4694   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
4695   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
4696   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
4697   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
4698
4699   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
4700   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
4701   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
4702   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
4703   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
4704   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
4705   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
4706
4707    /* SegmentControl */
4708    typedef struct _Elm_Segment_Item Elm_Segment_Item;
4709    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4710    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
4711    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);
4712    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
4713    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
4714    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4715    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
4716    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
4717    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
4718    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
4719    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
4720    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
4721    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
4722    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4723    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
4724    /* smart callbacks called:
4725     * "changed" -when the user clicks on a segment item which is not previously
4726     *            selected and get selected. The event_info parameter is the
4727     *            segment item index.
4728     */
4729
4730    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
4731    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
4732    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
4733    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
4734    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
4735    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
4736    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
4737    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
4738
4739 #ifdef __cplusplus
4740 }
4741 #endif
4742
4743 #endif