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