/**
@mainpage Elementary
@image html elementary.png
-@version @PACKAGE_VERSION@
+@version 0.7.0
+@date 2008-2011
+
+@section intro What is Elementary?
+
+This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
+applications (yet). Small simple ones with simple needs.
+
+It is meant to make the programmers work almost brainless but give them lots
+of flexibility.
+
+@li @ref Start - Go here to quickly get started with writing Apps
+
+@section organization Organization
+
+One can divide Elemementary into three main groups:
+@li @ref infralist - These are modules that deal with Elementary as a whole.
+@li @ref widgetslist - These are the widgets you'll compose your UI out of.
+@li @ref containerslist - These are the containers in which the widgets will be
+ layouted.
+
+@section license License
+
+LGPL v2 (see COPYING in the base of Elementary's source). This applies to
+all files in the source tree.
+
+@section ack Acknowledgements
+There is a lot that goes into making a widget set, and they don't happen out of
+nothing. It's like trying to make everyone everywhere happy, regardless of age,
+gender, race or nationality - and that is really tough. So thanks to people and
+organisations behind this, as listed in the @ref authors page.
+*/
+
+
+/**
+ * @defgroup Start Getting Started
+ *
+ * To write an Elementary app, you can get started with the following:
+ *
+@code
+#include <Elementary.h>
+EAPI_MAIN int
+elm_main(int argc, char **argv)
+{
+ // create window(s) here and do any application init
+ elm_run(); // run main loop
+ elm_shutdown(); // after mainloop finishes running, shutdown
+ return 0; // exit 0 for exit code
+}
+ELM_MAIN()
+@endcode
+ *
+ * To use autotools (which helps in many ways in the long run, like being able
+ * to immediately create releases of your software directly from your tree
+ * and ensure everything needed to build it is there) you will need a
+ * configure.ac, Makefile.am and autogen.sh file.
+ *
+ * configure.ac:
+ *
+@verbatim
+AC_INIT(myapp, 0.0.0, myname@mydomain.com)
+AC_PREREQ(2.52)
+AC_CONFIG_SRCDIR(configure.ac)
+AM_CONFIG_HEADER(config.h)
+AC_PROG_CC
+AM_INIT_AUTOMAKE(1.6 dist-bzip2)
+PKG_CHECK_MODULES([ELEMENTARY], elementary)
+AC_OUTPUT(Makefile)
+@endverbatim
+ *
+ * Makefile.am:
+ *
+@verbatim
+AUTOMAKE_OPTIONS = 1.4 foreign
+MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
+
+INCLUDES = -I$(top_srcdir)
+
+bin_PROGRAMS = myapp
+
+myapp_SOURCES = main.c
+myapp_LDADD = @ELEMENTARY_LIBS@
+myapp_CFLAGS = @ELEMENTARY_CFLAGS@
+@endverbatim
+ *
+ * autogen.sh:
+ *
+@verbatim
+#!/bin/sh
+echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
+echo "Running autoheader..." ; autoheader || exit 1
+echo "Running autoconf..." ; autoconf || exit 1
+echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
+./configure "$@"
+@endverbatim
+ *
+ * To generate all the things needed to bootstrap just run:
+ *
+@verbatim
+./autogen.sh
+@endverbatim
+ *
+ * This will generate Makefile.in's, the confgure script and everything else.
+ * After this it works like all normal autotools projects:
+@verbatim
+./configure
+make
+sudo make install
+@endverbatim
+ *
+ * Note sudo was assumed to get root permissions, as this would install in
+ * /usr/local which is system-owned. Use any way you like to gain root, or
+ * specify a different prefix with configure:
+ *
+@verbatim
+./confiugre --prefix=$HOME/mysoftware
+@endverbatim
+ *
+ * Also remember that autotools buys you some useful commands like:
+@verbatim
+make uninstall
+@endverbatim
+ *
+ * This uninstalls the software after it was installed with "make install".
+ * It is very useful to clear up what you built if you wish to clean the
+ * system.
+ *
+@verbatim
+make distcheck
+@endverbatim
+ *
+ * This firstly checks if your build tree is "clean" and ready for
+ * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
+ * ready to upload and distribute to the world, that contains the generated
+ * Makefile.in's and configure script. The users do not need to run
+ * autogen.sh - just configure and on. They don't need autotools installed.
+ * This tarball also builds cleanly, has all the sources it needs to build
+ * included (that is sources for your application, not libraries it depends
+ * on like Elementary). It builds cleanly in a buildroot and does not
+ * contain any files that are temporarily generated like binaries and other
+ * build-generated files, so the tarball is clean, and no need to worry
+ * about cleaning up your tree before packaging.
+ *
+@verbatim
+make clean
+@endverbatim
+ *
+ * This cleans up all build files (binaries, objects etc.) from the tree.
+ *
+@verbatim
+make distclean
+@endverbatim
+ *
+ * This cleans out all files from the build and from configure's output too.
+ *
+@verbatim
+make maintainer-clean
+@endverbatim
+ *
+ * This deletes all the files autogen.sh will produce so the tree is clean
+ * to be put into a revision-control system (like CVS, SVN or GIT for example).
+ *
+ * There is a more advanced way of making use of the quicklaunch infrastructure
+ * in Elementary (which will not be covered here due to its more advanced
+ * nature).
+ *
+ * Now let's actually create an interactive "Hello World" gui that you can
+ * click the ok button to exit. It's more code because this now does something
+ * much more significant, but it's still very simple:
+ *
+@code
+#include <Elementary.h>
+
+static void
+on_done(void *data, Evas_Object *obj, void *event_info)
+{
+ // quit the mainloop (elm_run function will return)
+ elm_exit();
+}
+
+EAPI_MAIN int
+elm_main(int argc, char **argv)
+{
+ Evas_Object *win, *bg, *box, *lab, *btn;
+
+ // new window - do the usual and give it a name, title and delete handler
+ win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
+ elm_win_title_set(win, "Hello");
+ // when the user clicks "close" on a window there is a request to delete
+ evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
+
+ // add a standard bg
+ bg = elm_bg_add(win);
+ // add object as a resize object for the window (controls window minimum
+ // size as well as gets resized if window is resized)
+ elm_win_resize_object_add(win, bg);
+ evas_object_show(bg);
+
+ // add a box object - default is vertical. a box holds children in a row,
+ // either horizontally or vertically. nothing more.
+ box = elm_box_add(win);
+ // make the box hotizontal
+ elm_box_horizontal_set(box, EINA_TRUE);
+ // add object as a resize object for the window (controls window minimum
+ // size as well as gets resized if window is resized)
+ elm_win_resize_object_add(win, box);
+ evas_object_show(box);
+
+ // add a label widget, set the text and put it in the pad frame
+ lab = elm_label_add(win);
+ // set default text of the label
+ elm_object_text_set(lab, "Hello out there world!");
+ // pack the label at the end of the box
+ elm_box_pack_end(box, lab);
+ evas_object_show(lab);
+
+ // add an ok button
+ btn = elm_button_add(win);
+ // set default text of button to "OK"
+ elm_object_text_set(btn, "OK");
+ // pack the button at the end of the box
+ elm_box_pack_end(box, btn);
+ evas_object_show(btn);
+ // call on_done when button is clicked
+ evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
+
+ // now we are done, show the window
+ evas_object_show(win);
+
+ // run the mainloop and process events and callbacks
+ elm_run();
+ return 0;
+}
+ELM_MAIN()
+@endcode
+ *
+ */
+
+/**
+@page authors Authors
@author Carsten Haitzler <raster@@rasterman.com>
@author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
@author Cedric Bail <cedric.bail@@free.fr>
@author Shinwoo Kim <kimcinoo@@gmail.com>
@author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
@author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
-@date 2008-2011
-
-@section intro What is Elementary?
-
-This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
-applications (yet). Small simple ones with simple needs.
-
-It is meant to make the programmers work almost brainless but give them lots
-of flexibility.
-
-License: LGPL v2 (see COPYING in the base of Elementary's source). This
-applies to all files in the source here.
-
-Acknowledgements: There is a lot that goes into making a widget set, and
-they don't happen out of nothing. It's like trying to make everyone
-everywhere happy, regardless of age, gender, race or nationality - and
-that is really tough. So thanks to people and organisations behind this,
-aslisted in the Authors section above.
-
-@verbatim
-Pants
-@endverbatim
-*/
+@author Sung W. Park <sungwoo@gmail.com>
+@author Thierry el Borgi <thierry@substantiel.fr>
+@author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
+@author Chanwook Jung <joey.jung@samsung.com>
+@author Hyoyoung Chang <hyoyoung.chang@samsung.com>
+@author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
+@author Kim Yunhan <spbear@gmail.com>
+
+Please contact <enlightenment-devel@lists.sourceforge.net> to get in
+contact with the developers and maintainers.
+ */
#ifndef ELEMENTARY_H
#define ELEMENTARY_H
@ELM_EDBUS_DEF@ ELM_EDBUS
@ELM_EFREET_DEF@ ELM_EFREET
@ELM_ETHUMB_DEF@ ELM_ETHUMB
+@ELM_WEB_DEF@ ELM_WEB
@ELM_EMAP_DEF@ ELM_EMAP
@ELM_DEBUG_DEF@ ELM_DEBUG
@ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
# endif
#endif /* ! _WIN32 */
+#ifdef _WIN32
+# define EAPI_MAIN
+#else
+# define EAPI_MAIN EAPI
+#endif
/* allow usage from c++ */
#ifdef __cplusplus
*/
typedef enum _Elm_Policy
{
- ELM_POLICY_QUIT, /**< under which circunstances the application
+ ELM_POLICY_QUIT, /**< under which circumstances the application
* should quit automatically. @see
* Elm_Policy_Quit.
*/
ELM_WRAP_LAST
} Elm_Wrap_Type;
+ typedef enum
+ {
+ ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
+ ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
+ ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
+ ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
+ ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
+ ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
+ ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
+ ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
+ ELM_INPUT_PANEL_LAYOUT_INVALID
+ } Elm_Input_Panel_Layout;
+
/**
* @typedef Elm_Object_Item
* An Elementary Object item handle.
* @ingroup General
*/
- typedef struct _Elm_Widget_Item Elm_Object_Item;
+ typedef struct _Elm_Object_Item Elm_Object_Item;
+
/**
* Called back when a widget's tooltip is activated and needs content.
*/
typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
- typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
+ typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
#ifndef ELM_LIB_QUICKLAUNCH
#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 */
* @return The init counter value.
*
* This function initializes Elementary and increments a counter of
- * the number of calls to it. It returs the new counter's value.
+ * the number of calls to it. It returns the new counter's value.
*
* @warning This call is exported only for use by the @c ELM_MAIN()
* macro. There is no need to use this if you use this macro (which
EAPI Eina_Bool elm_need_efreet(void);
EAPI Eina_Bool elm_need_e_dbus(void);
+
+ /**
+ * This must be called before any other function that handle with
+ * elm_thumb objects or ethumb_client instances.
+ *
+ * @ingroup Thumb
+ */
EAPI Eina_Bool elm_need_ethumb(void);
/**
+ * This must be called before any other function that handle with
+ * elm_web objects or ewk_view instances.
+ *
+ * @ingroup Web
+ */
+ EAPI Eina_Bool elm_need_web(void);
+
+ /**
* Set a new policy's value (for a given policy group/identifier).
*
* @param policy policy identifier, as in @ref Elm_Policy.
* Set a label of an object
*
* @param obj The Elementary object
- * @param item The label id to set (NULL for the default label)
+ * @param part The text part name to set (NULL for the default label)
* @param label The new text of the label
*
* @note Elementary objects may have many labels (e.g. Action Slider)
*
* @ingroup General
*/
- EAPI void elm_object_text_part_set(Evas_Object *obj, const char *item, const char *label);
+ EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
#define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
* Get a label of an object
*
* @param obj The Elementary object
- * @param item The label id to get (NULL for the default label)
+ * @param part The text part name to get (NULL for the default label)
* @return text of the label or NULL for any error
*
* @note Elementary objects may have many labels (e.g. Action Slider)
*
* @ingroup General
*/
- EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *item);
+ EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
#define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
* Set a content of an object
*
* @param obj The Elementary object
- * @param item The content id to set (NULL for the default content)
+ * @param part The content part name to set (NULL for the default content)
* @param content The new content of the object
*
* @note Elementary objects may have many contents
*
* @ingroup General
*/
- EAPI void elm_object_content_part_set(Evas_Object *obj, const char *item, Evas_Object *content);
+ EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
#define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
* Get a content of an object
*
* @param obj The Elementary object
- * @param item The content id to get (NULL for the default content)
+ * @param item The content part name to get (NULL for the default content)
* @return content of the object or NULL for any error
*
* @note Elementary objects may have many contents
*
* @ingroup General
*/
- EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *item);
+ EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
#define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
* Unset a content of an object
*
* @param obj The Elementary object
- * @param item The content id to unset (NULL for the default content)
+ * @param item The content part name to unset (NULL for the default content)
*
* @note Elementary objects may have many contents
*
* @ingroup General
*/
- EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *item);
+ EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
#define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
* Set a content of an object item
*
* @param it The Elementary object item
- * @param part The content part name to unset (NULL for the default content)
+ * @param part The content part name to set (NULL for the default content)
* @param content The new content of the object item
*
* @note Elementary object items may have many contents
*
* @ingroup General
*/
- EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
+ EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
-#define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
+#define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
/**
* Unset a content of an object item
*/
EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
-#define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
+#define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
/**
* Set a label of an objec itemt
*/
EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
-#define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
+ /**
+ * Set the text to read out when in accessibility mode
+ *
+ * @param obj The object which is to be described
+ * @param txt The text that describes the widget to people with poor or no vision
+ *
+ * @ingroup General
+ */
+ EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
/**
- * @}
+ * Set the text to read out when in accessibility mode
+ *
+ * @param it The object item which is to be described
+ * @param txt The text that describes the widget to people with poor or no vision
+ *
+ * @ingroup General
*/
+ EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
- EAPI void elm_all_flush(void);
- EAPI int elm_cache_flush_interval_get(void);
- EAPI void elm_cache_flush_interval_set(int size);
- EAPI void elm_cache_flush_interval_all_set(int size);
- EAPI Eina_Bool elm_cache_flush_enabled_get(void);
- EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
- EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
- EAPI int elm_font_cache_get(void);
- EAPI void elm_font_cache_set(int size);
- EAPI void elm_font_cache_all_set(int size);
- EAPI int elm_image_cache_get(void);
- EAPI void elm_image_cache_set(int size);
- EAPI void elm_image_cache_all_set(int size);
- EAPI int elm_edje_file_cache_get(void);
- EAPI void elm_edje_file_cache_set(int size);
- EAPI void elm_edje_file_cache_all_set(int size);
- EAPI int elm_edje_collection_cache_get(void);
- EAPI void elm_edje_collection_cache_set(int size);
- EAPI void elm_edje_collection_cache_all_set(int size);
+
+#define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
/**
- * @defgroup Scaling Selective Widget Scaling
+ * Get the data associated with an object item
+ * @param it The object item
+ * @return The data associated with @p it
*
- * Different widgets can be scaled independently. These functions
- * allow you to manipulate this scaling on a per-widget basis. The
- * object and all its children get their scaling factors multiplied
- * by the scale factor set. This is multiplicative, in that if a
- * child also has a scale size set it is in turn multiplied by its
- * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
- * double size, @c 0.5 is half, etc.
+ * @ingroup General
+ */
+ EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
+
+ /**
+ * Set the data associated with an object item
+ * @param it The object item
+ * @param data The data to be associated with @p it
*
- * @ref general_functions_example_page "This" example contemplates
- * some of these functions.
+ * @ingroup General
*/
+ EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
/**
- * Set the scaling factor for a given Elementary object
+ * Send a signal to the edje object of the widget item.
*
- * @param obj The Elementary to operate on
- * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
- * no scaling)
+ * This function sends a signal to the edje object of the obj item. An
+ * edje program can respond to a signal by specifying matching
+ * 'signal' and 'source' fields.
*
- * @ingroup Scaling
+ * @param it The Elementary object item
+ * @param emission The signal's name.
+ * @param source The signal's source.
+ * @ingroup General
*/
- EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
/**
- * Get the scaling factor for a given Elementary object
+ * @}
+ */
+
+ /**
+ * @defgroup Caches Caches
*
- * @param obj The object
- * @return The scaling factor set by elm_object_scale_set()
+ * These are functions which let one fine-tune some cache values for
+ * Elementary applications, thus allowing for performance adjustments.
*
- * @ingroup Scaling
+ * @{
*/
- EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
+
/**
- * Set the style to use by a widget
+ * @brief Flush all caches.
*
- * Sets the style name that will define the appearance of a widget. Styles
- * vary from widget to widget and may also be defined by other themes
- * by means of extensions and overlays.
+ * Frees all data that was in cache and is not currently being used to reduce
+ * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
+ * to calling all of the following functions:
+ * @li edje_file_cache_flush()
+ * @li edje_collection_cache_flush()
+ * @li eet_clearcache()
+ * @li evas_image_cache_flush()
+ * @li evas_font_cache_flush()
+ * @li evas_render_dump()
+ * @note Evas caches are flushed for every canvas associated with a window.
*
- * @param obj The Elementary widget to style
- * @param style The style name to use
+ * @ingroup Caches
+ */
+ EAPI void elm_all_flush(void);
+
+ /**
+ * Get the configured cache flush interval time
*
- * @see elm_theme_extension_add()
- * @see elm_theme_overlay_add()
+ * This gets the globally configured cache flush interval time, in
+ * ticks
+ *
+ * @return The cache flush interval time
+ * @ingroup Caches
*
- * @ingroup Theme
+ * @see elm_all_flush()
*/
- EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
+ EAPI int elm_cache_flush_interval_get(void);
+
/**
- * Get the style used by the widget
- *
- * This gets the style being used for that widget. Note that the string
- * pointer is only valid as longas the object is valid and the style doesn't
- * change.
+ * Set the configured cache flush interval time
*
- * @param obj The Elementary widget to query for its style
- * @return The style name used
+ * This sets the globally configured cache flush interval time, in ticks
*
- * @see elm_object_style_set()
+ * @param size The cache flush interval time
+ * @ingroup Caches
*
- * @ingroup Theme
+ * @see elm_all_flush()
*/
- EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_cache_flush_interval_set(int size);
/**
- * @defgroup Styles Styles
+ * Set the configured cache flush interval time for all applications on the
+ * display
*
- * Widgets can have different styles of look. These generic API's
- * set styles of widgets, if they support them (and if the theme(s)
- * do).
+ * This sets the globally configured cache flush interval time -- in ticks
+ * -- for all applications on the display.
*
- * @ref general_functions_example_page "This" example contemplates
- * some of these functions.
+ * @param size The cache flush interval time
+ * @ingroup Caches
*/
+ EAPI void elm_cache_flush_interval_all_set(int size);
/**
- * Set the disabled state of an Elementary object.
- *
- * @param obj The Elementary object to operate on
- * @param disabled The state to put in in: @c EINA_TRUE for
- * disabled, @c EINA_FALSE for enabled
+ * Get the configured cache flush enabled state
*
- * Elementary objects can be @b disabled, in which state they won't
- * receive input and, in general, will be themed differently from
- * their normal state, usually greyed out. Useful for contexts
- * where you don't want your users to interact with some of the
- * parts of you interface.
+ * This gets the globally configured cache flush state - if it is enabled
+ * or not. When cache flushing is enabled, elementary will regularly
+ * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
+ * memory and allow usage to re-seed caches and data in memory where it
+ * can do so. An idle application will thus minimise its memory usage as
+ * data will be freed from memory and not be re-loaded as it is idle and
+ * not rendering or doing anything graphically right now.
*
- * This sets the state for the widget, either disabling it or
- * enabling it back.
+ * @return The cache flush state
+ * @ingroup Caches
*
- * @ingroup Styles
+ * @see elm_all_flush()
*/
- EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_cache_flush_enabled_get(void);
/**
- * Get the disabled state of an Elementary object.
+ * Set the configured cache flush enabled state
*
- * @param obj The Elementary object to operate on
- * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
- * if it's enabled (or on errors)
+ * This sets the globally configured cache flush enabled state
*
- * This gets the state of the widget, which might be enabled or disabled.
+ * @param size The cache flush enabled state
+ * @ingroup Caches
*
- * @ingroup Styles
+ * @see elm_all_flush()
*/
- EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
/**
- * @defgroup WidgetNavigation Widget Tree Navigation.
+ * Set the configured cache flush enabled state for all applications on the
+ * display
*
- * How to check if an Evas Object is an Elementary widget? How to
- * get the first elementary widget that is parent of the given
- * object? These are all covered in widget tree navigation.
+ * This sets the globally configured cache flush enabled state for all
+ * applications on the display.
*
- * @ref general_functions_example_page "This" example contemplates
- * some of these functions.
+ * @param size The cache flush enabled state
+ * @ingroup Caches
*/
-
- EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
/**
- * Get the first parent of the given object that is an Elementary
- * widget.
+ * Get the configured font cache size
*
- * @param obj the Elementary object to query parent from.
- * @return the parent object that is an Elementary widget, or @c
- * NULL, if it was not found.
+ * This gets the globally configured font cache size, in bytes
*
- * Use this to query for an object's parent widget.
+ * @return The font cache size
+ * @ingroup Caches
+ */
+ EAPI int elm_font_cache_get(void);
+
+ /**
+ * Set the configured font cache size
*
- * @note Most of Elementary users wouldn't be mixing non-Elementary
- * smart objects in the objects tree of an application, as this is
- * an advanced usage of Elementary with Evas. So, except for the
- * application's window, which is the root of that tree, all other
- * objects would have valid Elementary widget parents.
+ * This sets the globally configured font cache size, in bytes
*
- * @ingroup WidgetNavigation
+ * @param size The font cache size
+ * @ingroup Caches
*/
- EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- EAPI double elm_scale_get(void);
- EAPI void elm_scale_set(double scale);
- EAPI void elm_scale_all_set(double scale);
-
- EAPI Eina_Bool elm_mirrored_get(void);
- EAPI void elm_mirrored_set(Eina_Bool mirrored);
-
- EAPI Eina_Bool elm_config_save(void);
- EAPI void elm_config_reload(void);
-
- EAPI const char *elm_profile_current_get(void);
- EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
- EAPI void elm_profile_dir_free(const char *p_dir);
- EAPI Eina_List *elm_profile_list_get(void);
- EAPI void elm_profile_list_free(Eina_List *l);
- EAPI void elm_profile_set(const char *profile);
- EAPI void elm_profile_all_set(const char *profile);
-
- EAPI const char *elm_engine_current_get(void);
- EAPI void elm_engine_set(const char *engine);
-
- typedef struct _Elm_Text_Class
- {
- const char *name;
- const char *desc;
- } Elm_Text_Class;
-
- typedef struct _Elm_Font_Overlay
- {
- const char *text_class;
- const char *font;
- Evas_Font_Size size;
- } Elm_Font_Overlay;
-
- typedef struct _Elm_Font_Properties
- {
- const char *name;
- Eina_List *styles;
- } Elm_Font_Properties;
-
- EAPI const Eina_List *elm_text_classes_list_get(void);
- EAPI void elm_text_classes_list_free(const Eina_List *list);
-
- EAPI const Eina_List *elm_font_overlay_list_get(void);
- EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
- EAPI void elm_font_overlay_unset(const char *text_class);
- EAPI void elm_font_overlay_apply(void);
- EAPI void elm_font_overlay_all_apply(void);
-
- EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
- EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
- EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
- EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
- EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
- EAPI void elm_font_available_hash_del(Eina_Hash *hash);
+ EAPI void elm_font_cache_set(int size);
/**
- * @defgroup Fingers Fingers
- *
- * Elementary is designed to be finger-friendly for touchscreens,
- * and so in addition to scaling for display resolution, it can
- * also scale based on finger "resolution" (or size). You can then
- * customize the granularity of the areas meant to receive clicks
- * on touchscreens.
+ * Set the configured font cache size for all applications on the
+ * display
*
- * Different profiles may have pre-set values for finger sizes.
+ * This sets the globally configured font cache size -- in bytes
+ * -- for all applications on the display.
*
- * @ref general_functions_example_page "This" example contemplates
- * some of these functions.
+ * @param size The font cache size
+ * @ingroup Caches
*/
+ EAPI void elm_font_cache_all_set(int size);
/**
- * Get the configured "finger size"
- *
- * @return The finger size
+ * Get the configured image cache size
*
- * This gets the globally configured finger size, <b>in pixels</b>
+ * This gets the globally configured image cache size, in bytes
*
- * @ingroup Fingers
+ * @return The image cache size
+ * @ingroup Caches
*/
- EAPI Evas_Coord elm_finger_size_get(void);
- EAPI void elm_finger_size_set(Evas_Coord size);
- EAPI void elm_finger_size_all_set(Evas_Coord size);
+ EAPI int elm_image_cache_get(void);
/**
- * @defgroup Focus Focus
- *
- * An Elementary application has, at all times, one (and only one)
- * @b focused object. This is what determines where the input
- * events go to within the application's window. Also, focused
- * objects can be decorated differently, in order to signal to the
- * user where the input is, at a given moment.
+ * Set the configured image cache size
*
- * Elementary applications also have the concept of <b>focus
- * chain</b>: one can cycle through all the windows' focusable
- * objects by input (tab key) or programmatically. The default
- * focus chain for an application is the one define by the order in
- * which the widgets where added in code. One will cycle through
- * top level widgets, and, for each one containg sub-objects, cycle
- * through them all, before returning to the level
- * above. Elementary also allows one to set @b custom focus chains
- * for their applications.
+ * This sets the globally configured image cache size, in bytes
*
- * Besides the focused decoration a widget may exhibit, when it
- * gets focus, Elementary has a @b global focus highlight object
- * that can be enabled for a window. If one chooses to do so, this
- * extra highlight effect will surround the current focused object,
- * too.
+ * @param size The image cache size
+ * @ingroup Caches
+ */
+ EAPI void elm_image_cache_set(int size);
+
+ /**
+ * Set the configured image cache size for all applications on the
+ * display
*
- * @note Some Elementary widgets are @b unfocusable, after
- * creation, by their very nature: they are not meant to be
- * interacted with input events, but are there just for visual
- * purposes.
+ * This sets the globally configured image cache size -- in bytes
+ * -- for all applications on the display.
*
- * @ref general_functions_example_page "This" example contemplates
- * some of these functions.
+ * @param size The image cache size
+ * @ingroup Caches
*/
-
- EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
- EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
- EAPI Eina_Bool elm_focus_highlight_animate_get(void);
- EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
+ EAPI void elm_image_cache_all_set(int size);
/**
- * Get the whether an Elementary object has the focus or not.
- *
- * @param obj The Elementary object to get the information from
- * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
- * not (and on errors).
+ * Get the configured edje file cache size.
*
- * @see elm_object_focus()
+ * This gets the globally configured edje file cache size, in number
+ * of files.
*
- * @ingroup Focus
+ * @return The edje file cache size
+ * @ingroup Caches
*/
- EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI int elm_edje_file_cache_get(void);
/**
- * Set/unset focus to a given Elementary object.
+ * Set the configured edje file cache size
*
- * @param obj The Elementary object to operate on.
- * @param enable @c EINA_TRUE Set focus to a given object,
- * @c EINA_FALSE Unset focus to a given object.
+ * This sets the globally configured edje file cache size, in number
+ * of files.
*
- * @note When you set focus to this object, if it can handle focus, will
- * take the focus away from the one who had it previously and will, for
- * now on, be the one receiving input events. Unsetting focus will remove
- * the focus from @p obj, passing it back to the previous element in the
- * focus chain list.
+ * @param size The edje file cache size
+ * @ingroup Caches
+ */
+ EAPI void elm_edje_file_cache_set(int size);
+
+ /**
+ * Set the configured edje file cache size for all applications on the
+ * display
*
- * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
+ * This sets the globally configured edje file cache size -- in number
+ * of files -- for all applications on the display.
*
- * @ingroup Focus
+ * @param size The edje file cache size
+ * @ingroup Caches
*/
- EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
+ EAPI void elm_edje_file_cache_all_set(int size);
/**
- * Make a given Elementary object the focused one.
+ * Get the configured edje collections (groups) cache size.
*
- * @param obj The Elementary object to make focused.
+ * This gets the globally configured edje collections cache size, in
+ * number of collections.
*
- * @note This object, if it can handle focus, will take the focus
- * away from the one who had it previously and will, for now on, be
- * the one receiving input events.
+ * @return The edje collections cache size
+ * @ingroup Caches
+ */
+ EAPI int elm_edje_collection_cache_get(void);
+
+ /**
+ * Set the configured edje collections (groups) cache size
*
- * @see elm_object_focus_get()
- * @deprecated use elm_object_focus_set() instead.
+ * This sets the globally configured edje collections cache size, in
+ * number of collections.
*
- * @ingroup Focus
+ * @param size The edje collections cache size
+ * @ingroup Caches
*/
- EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_edje_collection_cache_set(int size);
/**
- * Remove the focus from an Elementary object
+ * Set the configured edje collections (groups) cache size for all
+ * applications on the display
*
- * @param obj The Elementary to take focus from
+ * This sets the globally configured edje collections cache size -- in
+ * number of collections -- for all applications on the display.
*
- * This removes the focus from @p obj, passing it back to the
- * previous element in the focus chain list.
+ * @param size The edje collections cache size
+ * @ingroup Caches
+ */
+ EAPI void elm_edje_collection_cache_all_set(int size);
+
+ /**
+ * @}
+ */
+
+ /**
+ * @defgroup Scaling Widget Scaling
*
- * @see elm_object_focus() and elm_object_focus_custom_chain_get()
- * @deprecated use elm_object_focus_set() instead.
+ * Different widgets can be scaled independently. These functions
+ * allow you to manipulate this scaling on a per-widget basis. The
+ * object and all its children get their scaling factors multiplied
+ * by the scale factor set. This is multiplicative, in that if a
+ * child also has a scale size set it is in turn multiplied by its
+ * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
+ * double size, @c 0.5 is half, etc.
*
- * @ingroup Focus
+ * @ref general_functions_example_page "This" example contemplates
+ * some of these functions.
*/
- EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the ability for an Element object to be focused
- *
- * @param obj The Elementary object to operate on
- * @param enable @c EINA_TRUE if the object can be focused, @c
- * EINA_FALSE if not (and on errors)
+ * Get the global scaling factor
*
- * This sets whether the object @p obj is able to take focus or
- * not. Unfocusable objects do nothing when programmatically
- * focused, being the nearest focusable parent object the one
- * really getting focus. Also, when they receive mouse input, they
- * will get the event, but not take away the focus from where it
- * was previously.
+ * This gets the globally configured scaling factor that is applied to all
+ * objects.
*
- * @ingroup Focus
+ * @return The scaling factor
+ * @ingroup Scaling
*/
- EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
+ EAPI double elm_scale_get(void);
/**
- * Get whether an Elementary object is focusable or not
- *
- * @param obj The Elementary object to operate on
- * @return @c EINA_TRUE if the object is allowed to be focused, @c
- * EINA_FALSE if not (and on errors)
+ * Set the global scaling factor
*
- * @note Objects which are meant to be interacted with by input
- * events are created able to be focused, by default. All the
- * others are not.
+ * This sets the globally configured scaling factor that is applied to all
+ * objects.
*
- * @ingroup Focus
+ * @param scale The scaling factor to set
+ * @ingroup Scaling
*/
- EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_scale_set(double scale);
- EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
- EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
- EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
- EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
- EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
+ /**
+ * Set the global scaling factor for all applications on the display
+ *
+ * This sets the globally configured scaling factor that is applied to all
+ * objects for all applications.
+ * @param scale The scaling factor to set
+ * @ingroup Scaling
+ */
+ EAPI void elm_scale_all_set(double scale);
/**
- * Make the elementary object and its children to be unfocusable (or focusable).
+ * Set the scaling factor for a given Elementary object
*
- * @param obj The Elementary object to operate on
- * @param tree_unfocusable @c EINA_TRUE for unfocusable,
- * @c EINA_FALSE for focusable.
+ * @param obj The Elementary to operate on
+ * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
+ * no scaling)
*
- * This sets whether the object @p obj and its children objects
- * are able to take focus or not. If the tree is set as unfocusable,
- * newest focused object which is not in this tree will get focus.
- * This API can be helpful for an object to be deleted.
- * When an object will be deleted soon, it and its children may not
- * want to get focus (by focus reverting or by other focus controls).
- * Then, just use this API before deleting.
+ * @ingroup Scaling
+ */
+ EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the scaling factor for a given Elementary object
*
- * @see elm_object_tree_unfocusable_get()
+ * @param obj The object
+ * @return The scaling factor set by elm_object_scale_set()
*
- * @ingroup Focus
+ * @ingroup Scaling
*/
- EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
+ EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get whether an Elementary object and its children are unfocusable or not.
+ * @defgroup Password_last_show Password last input show
*
- * @param obj The Elementary object to get the information from
- * @return @c EINA_TRUE, if the tree is unfocussable,
- * @c EINA_FALSE if not (and on errors).
- *
- * @see elm_object_tree_unfocusable_set()
+ * Last show feature of password mode enables user to view
+ * the last input entered for few seconds before masking it.
+ * These functions allow to set this feature in password mode
+ * of entry widget and also allow to manipulate the duration
+ * for which the input has to be visible.
*
- * @ingroup Focus
+ * @{
*/
- EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
-
- EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
- EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
- EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
- EAPI double elm_scroll_bounce_friction_get(void);
- EAPI void elm_scroll_bounce_friction_set(double friction);
- EAPI void elm_scroll_bounce_friction_all_set(double friction);
- EAPI double elm_scroll_page_scroll_friction_get(void);
- EAPI void elm_scroll_page_scroll_friction_set(double friction);
- EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
- EAPI double elm_scroll_bring_in_scroll_friction_get(void);
- EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
- EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
- EAPI double elm_scroll_zoom_friction_get(void);
- EAPI void elm_scroll_zoom_friction_set(double friction);
- EAPI void elm_scroll_zoom_friction_all_set(double friction);
- EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
- EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
- EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
- EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
- EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
- EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
- EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
- EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
- EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
- EAPI double elm_scroll_thumbscroll_friction_get(void);
- EAPI void elm_scroll_thumbscroll_friction_set(double friction);
- EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
- EAPI double elm_scroll_thumbscroll_border_friction_get(void);
- EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
- EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
-
- EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
- EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
- EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
- EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
-
- EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
- EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
/**
- * Adjust size of an element for finger usage.
- *
- * @param times_w How many fingers should fit horizontally
- * @param w Pointer to the width size to adjust
- * @param times_h How many fingers should fit vertically
- * @param h Pointer to the height size to adjust
- *
- * This takes width and height sizes (in pixels) as input and a
- * size multiple (which is how many fingers you want to place
- * within the area, being "finger" the size set by
- * elm_finger_size_set()), and adjusts the size to be large enough
- * to accommodate the resulting size -- if it doesn't already
- * accommodate it. On return the @p w and @p h sizes pointed to by
- * these parameters will be modified, on those conditions.
+ * Get show last setting of password mode.
*
- * @note This is kind of a low level Elementary call, most useful
- * on size evaluation times for widgets. An external user wouldn't
- * be calling, most of the time.
+ * This gets the show last input setting of password mode which might be
+ * enabled or disabled.
*
- * @ingroup Fingers
- */
- EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
-
- EAPI double elm_longpress_timeout_get(void);
- EAPI void elm_longpress_timeout_set(double longpress_timeout);
-
- /* debug
- * don't use it unless you are sure
+ * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
+ * if it's disabled.
+ * @ingroup Password_last_show
*/
- EAPI void elm_object_tree_dump(const Evas_Object *top);
- EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
+ EAPI Eina_Bool elm_password_show_last_get(void);
-
- /* theme */
/**
- * @defgroup Theme Theme
- *
- * Elementary uses Edje to theme its widgets, naturally. But for the most
- * part this is hidden behind a simpler interface that lets the user set
- * extensions and choose the style of widgets in a much easier way.
- *
- * Instead of thinking in terms of paths to Edje files and their groups
- * each time you want to change the appearance of a widget, Elementary
- * works so you can add any theme file with extensions or replace the
- * main theme at one point in the application, and then just set the style
- * of widgets with elm_object_style_set() and related functions. Elementary
- * will then look in its list of themes for a matching group and apply it,
- * and when the theme changes midway through the application, all widgets
- * will be updated accordingly.
- *
- * There are three concepts you need to know to understand how Elementary
- * theming works: default theme, extensions and overlays.
- *
- * Default theme, obviously enough, is the one that provides the default
- * look of all widgets. End users can change the theme used by Elementary
- * by setting the @c ELM_THEME environment variable before running an
- * application, or globally for all programs using the @c elementary_config
- * utility. Applications can change the default theme using elm_theme_set(),
- * but this can go against the user wishes, so it's not an adviced practice.
- *
- * Ideally, applications should find everything they need in the already
- * provided theme, but there may be occasions when that's not enough and
- * custom styles are required to correctly express the idea. For this
- * cases, Elementary has extensions.
+ * Set show last setting in password mode.
*
- * Extensions allow the application developer to write styles of its own
- * to apply to some widgets. This requires knowledge of how each widget
- * is themed, as extensions will always replace the entire group used by
- * the widget, so important signals and parts need to be there for the
- * object to behave properly (see documentation of Edje for details).
- * Once the theme for the extension is done, the application needs to add
- * it to the list of themes Elementary will look into, using
- * elm_theme_extension_add(), and set the style of the desired widgets as
- * he would normally with elm_object_style_set().
- *
- * Overlays, on the other hand, can replace the look of all widgets by
- * overriding the default style. Like extensions, it's up to the application
- * developer to write the theme for the widgets it wants, the difference
- * being that when looking for the theme, Elementary will check first the
- * list of overlays, then the set theme and lastly the list of extensions,
- * so with overlays it's possible to replace the default view and every
- * widget will be affected. This is very much alike to setting the whole
- * theme for the application and will probably clash with the end user
- * options, not to mention the risk of ending up with not matching styles
- * across the program. Unless there's a very special reason to use them,
- * overlays should be avoided for the resons exposed before.
+ * This enables or disables show last setting of password mode.
*
- * All these theme lists are handled by ::Elm_Theme instances. Elementary
- * keeps one default internally and every function that receives one of
- * these can be called with NULL to refer to this default (except for
- * elm_theme_free()). It's possible to create a new instance of a
- * ::Elm_Theme to set other theme for a specific widget (and all of its
- * children), but this is as discouraged, if not even more so, than using
- * overlays. Don't use this unless you really know what you are doing.
+ * @param password_show_last If EINA_TRUE enable's last input show in password mode.
+ * @see elm_password_show_last_timeout_set()
+ * @ingroup Password_last_show
+ */
+ EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
+
+ /**
+ * Get's the timeout value in last show password mode.
*
- * But to be less negative about things, you can look at the following
- * examples:
- * @li @ref theme_example_01 "Using extensions"
- * @li @ref theme_example_02 "Using overlays"
+ * This gets the time out value for which the last input entered in password
+ * mode will be visible.
*
- * @{
+ * @return The timeout value of last show password mode.
+ * @ingroup Password_last_show
*/
+ EAPI double elm_password_show_last_timeout_get(void);
+
/**
- * @typedef Elm_Theme
+ * Set's the timeout value in last show password mode.
*
- * Opaque handler for the list of themes Elementary looks for when
- * rendering widgets.
+ * This sets the time out value for which the last input entered in password
+ * mode will be visible.
*
- * Stay out of this unless you really know what you are doing. For most
- * cases, sticking to the default is all a developer needs.
+ * @param password_show_last_timeout The timeout value.
+ * @see elm_password_show_last_set()
+ * @ingroup Password_last_show
*/
- typedef struct _Elm_Theme Elm_Theme;
+ EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
/**
- * Create a new specific theme
- *
- * This creates an empty specific theme that only uses the default theme. A
- * specific theme has its own private set of extensions and overlays too
- * (which are empty by default). Specific themes do not fall back to themes
- * of parent objects. They are not intended for this use. Use styles, overlays
- * and extensions when needed, but avoid specific themes unless there is no
- * other way (example: you want to have a preview of a new theme you are
- * selecting in a "theme selector" window. The preview is inside a scroller
- * and should display what the theme you selected will look like, but not
- * actually apply it yet. The child of the scroller will have a specific
- * theme set to show this preview before the user decides to apply it to all
- * applications).
+ * @}
*/
- EAPI Elm_Theme *elm_theme_new(void);
+
/**
- * Free a specific theme
+ * @defgroup UI-Mirroring Selective Widget mirroring
*
- * @param th The theme to free
+ * These functions allow you to set ui-mirroring on specific
+ * widgets or the whole interface. Widgets can be in one of two
+ * modes, automatic and manual. Automatic means they'll be changed
+ * according to the system mirroring mode and manual means only
+ * explicit changes will matter. You are not supposed to change
+ * mirroring state of a widget set to automatic, will mostly work,
+ * but the behavior is not really defined.
*
- * This frees a theme created with elm_theme_new().
+ * @{
*/
- EAPI void elm_theme_free(Elm_Theme *th);
+
+ EAPI Eina_Bool elm_mirrored_get(void);
+ EAPI void elm_mirrored_set(Eina_Bool mirrored);
+
/**
- * Copy the theme fom the source to the destination theme
- *
- * @param th The source theme to copy from
- * @param thdst The destination theme to copy data to
+ * Get the system mirrored mode. This determines the default mirrored mode
+ * of widgets.
*
- * This makes a one-time static copy of all the theme config, extensions
- * and overlays from @p th to @p thdst. If @p th references a theme, then
- * @p thdst is also set to reference it, with all the theme settings,
- * overlays and extensions that @p th had.
+ * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
*/
- EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
+ EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Tell the source theme to reference the ref theme
+ * Set the system mirrored mode. This determines the default mirrored mode
+ * of widgets.
*
- * @param th The theme that will do the referencing
- * @param thref The theme that is the reference source
- *
- * This clears @p th to be empty and then sets it to refer to @p thref
- * so @p th acts as an override to @p thref, but where its overrides
- * don't apply, it will fall through to @pthref for configuration.
+ * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
*/
- EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
+ EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
+
/**
- * Return the theme referred to
+ * Returns the widget's mirrored mode setting.
*
- * @param th The theme to get the reference from
- * @return The referenced theme handle
+ * @param obj The widget.
+ * @return mirrored mode setting of the object.
*
- * This gets the theme set as the reference theme by elm_theme_ref_set().
- * If no theme is set as a reference, NULL is returned.
+ **/
+ EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Sets the widget's mirrored mode setting.
+ * When widget in automatic mode, it follows the system mirrored mode set by
+ * elm_mirrored_set().
+ * @param obj The widget.
+ * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
*/
- EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
+ EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
+
/**
- * Return the default theme
- *
- * @return The default theme handle
- *
- * This returns the internal default theme setup handle that all widgets
- * use implicitly unless a specific theme is set. This is also often use
- * as a shorthand of NULL.
+ * @}
*/
- EAPI Elm_Theme *elm_theme_default_get(void);
+
/**
- * Prepends a theme overlay to the list of overlays
+ * Set the style to use by a widget
*
- * @param th The theme to add to, or if NULL, the default theme
- * @param item The Edje file path to be used
+ * Sets the style name that will define the appearance of a widget. Styles
+ * vary from widget to widget and may also be defined by other themes
+ * by means of extensions and overlays.
*
- * Use this if your application needs to provide some custom overlay theme
- * (An Edje file that replaces some default styles of widgets) where adding
- * new styles, or changing system theme configuration is not possible. Do
- * NOT use this instead of a proper system theme configuration. Use proper
- * configuration files, profiles, environment variables etc. to set a theme
- * so that the theme can be altered by simple confiugration by a user. Using
- * this call to achieve that effect is abusing the API and will create lots
- * of trouble.
+ * @param obj The Elementary widget to style
+ * @param style The style name to use
*
* @see elm_theme_extension_add()
- */
- EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
- /**
- * Delete a theme overlay from the list of overlays
- *
- * @param th The theme to delete from, or if NULL, the default theme
- * @param item The name of the theme overlay
- *
+ * @see elm_theme_extension_del()
* @see elm_theme_overlay_add()
+ * @see elm_theme_overlay_del()
+ *
+ * @ingroup Styles
*/
- EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
+ EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
/**
- * Appends a theme extension to the list of extensions.
- *
- * @param th The theme to add to, or if NULL, the default theme
- * @param item The Edje file path to be used
+ * Get the style used by the widget
*
- * This is intended when an application needs more styles of widgets or new
- * widget themes that the default does not provide (or may not provide). The
- * application has "extended" usage by coming up with new custom style names
- * for widgets for specific uses, but as these are not "standard", they are
- * not guaranteed to be provided by a default theme. This means the
- * application is required to provide these extra elements itself in specific
- * Edje files. This call adds one of those Edje files to the theme search
- * path to be search after the default theme. The use of this call is
- * encouraged when default styles do not meet the needs of the application.
- * Use this call instead of elm_theme_overlay_add() for almost all cases.
+ * This gets the style being used for that widget. Note that the string
+ * pointer is only valid as longas the object is valid and the style doesn't
+ * change.
+ *
+ * @param obj The Elementary widget to query for its style
+ * @return The style name used
*
* @see elm_object_style_set()
+ *
+ * @ingroup Styles
*/
- EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
+ EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Deletes a theme extension from the list of extensions.
+ * @defgroup Styles Styles
*
- * @param th The theme to delete from, or if NULL, the default theme
- * @param item The name of the theme extension
+ * Widgets can have different styles of look. These generic API's
+ * set styles of widgets, if they support them (and if the theme(s)
+ * do).
*
- * @see elm_theme_extension_add()
+ * @ref general_functions_example_page "This" example contemplates
+ * some of these functions.
*/
- EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
+
/**
- * Set the theme search order for the given theme
+ * Set the disabled state of an Elementary object.
*
- * @param th The theme to set the search order, or if NULL, the default theme
- * @param theme Theme search string
+ * @param obj The Elementary object to operate on
+ * @param disabled The state to put in in: @c EINA_TRUE for
+ * disabled, @c EINA_FALSE for enabled
*
- * This sets the search string for the theme in path-notation from first
- * theme to search, to last, delimited by the : character. Example:
+ * Elementary objects can be @b disabled, in which state they won't
+ * receive input and, in general, will be themed differently from
+ * their normal state, usually greyed out. Useful for contexts
+ * where you don't want your users to interact with some of the
+ * parts of you interface.
*
- * "shiny:/path/to/file.edj:default"
+ * This sets the state for the widget, either disabling it or
+ * enabling it back.
*
- * See the ELM_THEME environment variable for more information.
+ * @ingroup Styles
+ */
+ EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the disabled state of an Elementary object.
*
- * @see elm_theme_get()
- * @see elm_theme_list_get()
+ * @param obj The Elementary object to operate on
+ * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
+ * if it's enabled (or on errors)
+ *
+ * This gets the state of the widget, which might be enabled or disabled.
+ *
+ * @ingroup Styles
*/
- EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
+ EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Return the theme search order
+ * @defgroup WidgetNavigation Widget Tree Navigation.
*
- * @param th The theme to get the search order, or if NULL, the default theme
- * @return The internal search order path
+ * How to check if an Evas Object is an Elementary widget? How to
+ * get the first elementary widget that is parent of the given
+ * object? These are all covered in widget tree navigation.
*
- * This function returns a colon separated string of theme elements as
- * returned by elm_theme_list_get().
+ * @ref general_functions_example_page "This" example contemplates
+ * some of these functions.
+ */
+
+ /**
+ * Check if the given Evas Object is an Elementary widget.
*
- * @see elm_theme_set()
- * @see elm_theme_list_get()
+ * @param obj the object to query.
+ * @return @c EINA_TRUE if it is an elementary widget variant,
+ * @c EINA_FALSE otherwise
+ * @ingroup WidgetNavigation
*/
- EAPI const char *elm_theme_get(Elm_Theme *th);
+ EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Return a list of theme elements to be used in a theme.
+ * Get the first parent of the given object that is an Elementary
+ * widget.
*
- * @param th Theme to get the list of theme elements from.
- * @return The internal list of theme elements
+ * @param obj the Elementary object to query parent from.
+ * @return the parent object that is an Elementary widget, or @c
+ * NULL, if it was not found.
*
- * This returns the internal list of theme elements (will only be valid as
- * long as the theme is not modified by elm_theme_set() or theme is not
- * freed by elm_theme_free(). This is a list of strings which must not be
- * altered as they are also internal. If @p th is NULL, then the default
- * theme element list is returned.
+ * Use this to query for an object's parent widget.
*
- * A theme element can consist of a full or relative path to a .edj file,
- * or a name, without extension, for a theme to be searched in the known
- * theme paths for Elemementary.
+ * @note Most of Elementary users wouldn't be mixing non-Elementary
+ * smart objects in the objects tree of an application, as this is
+ * an advanced usage of Elementary with Evas. So, except for the
+ * application's window, which is the root of that tree, all other
+ * objects would have valid Elementary widget parents.
*
- * @see elm_theme_set()
- * @see elm_theme_get()
+ * @ingroup WidgetNavigation
*/
- EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
+ EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Return the full patrh for a theme element
- *
- * @param f The theme element name
- * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
- * @return The full path to the file found.
+ * Get the top level parent of an Elementary widget.
*
- * This returns a string you should free with free() on success, NULL on
- * failure. This will search for the given theme element, and if it is a
- * full or relative path element or a simple searchable name. The returned
- * path is the full path to the file, if searched, and the file exists, or it
- * is simply the full path given in the element or a resolved path if
- * relative to home. The @p in_search_path boolean pointed to is set to
- * EINA_TRUE if the file was a searchable file andis in the search path,
- * and EINA_FALSE otherwise.
+ * @param obj The object to query.
+ * @return The top level Elementary widget, or @c NULL if parent cannot be
+ * found.
+ * @ingroup WidgetNavigation
*/
- EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
+ EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Flush the current theme.
+ * Get the string that represents this Elementary widget.
*
- * @param th Theme to flush
+ * @note Elementary is weird and exposes itself as a single
+ * Evas_Object_Smart_Class of type "elm_widget", so
+ * evas_object_type_get() always return that, making debug and
+ * language bindings hard. This function tries to mitigate this
+ * problem, but the solution is to change Elementary to use
+ * proper inheritance.
*
- * This flushes caches that let elementary know where to find theme elements
- * in the given theme. If @p th is NULL, then the default theme is flushed.
- * Call this function if source theme data has changed in such a way as to
- * make any caches Elementary kept invalid.
+ * @param obj the object to query.
+ * @return Elementary widget name, or @c NULL if not a valid widget.
+ * @ingroup WidgetNavigation
*/
- EAPI void elm_theme_flush(Elm_Theme *th);
+ EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * This flushes all themes (default and specific ones).
+ * @defgroup Config Elementary Config
*
- * This will flush all themes in the current application context, by calling
- * elm_theme_flush() on each of them.
+ * Elementary configuration is formed by a set options bounded to a
+ * given @ref Profile profile, like @ref Theme theme, @ref Fingers
+ * "finger size", etc. These are functions with which one syncronizes
+ * changes made to those values to the configuration storing files, de
+ * facto. You most probably don't want to use the functions in this
+ * group unlees you're writing an elementary configuration manager.
+ *
+ * @{
*/
- EAPI void elm_theme_full_flush(void);
+
/**
- * Set the theme for all elementary using applications on the current display
+ * Save back Elementary's configuration, so that it will persist on
+ * future sessions.
+ *
+ * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
+ * @ingroup Config
+ *
+ * This function will take effect -- thus, do I/O -- immediately. Use
+ * it when you want to apply all configuration changes at once. The
+ * current configuration set will get saved onto the current profile
+ * configuration file.
*
- * @param theme The name of the theme to use. Format same as the ELM_THEME
- * environment variable.
*/
- EAPI void elm_theme_all_set(const char *theme);
+ EAPI Eina_Bool elm_config_save(void);
+
/**
- * Return a list of theme elements in the theme search path
+ * Reload Elementary's configuration, bounded to current selected
+ * profile.
*
- * @return A list of strings that are the theme element names.
+ * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
+ * @ingroup Config
+ *
+ * Useful when you want to force reloading of configuration values for
+ * a profile. If one removes user custom configuration directories,
+ * for example, it will force a reload with system values insted.
*
- * This lists all available theme files in the standard Elementary search path
- * for theme elements, and returns them in alphabetical order as theme
- * element names in a list of strings. Free this with
- * elm_theme_name_available_list_free() when you are done with the list.
*/
- EAPI Eina_List *elm_theme_name_available_list_new(void);
+ EAPI void elm_config_reload(void);
+
/**
- * Free the list returned by elm_theme_name_available_list_new()
- *
- * This frees the list of themes returned by
- * elm_theme_name_available_list_new(). Once freed the list should no longer
- * be used. a new list mys be created.
+ * @}
*/
- EAPI void elm_theme_name_available_list_free(Eina_List *list);
+
/**
- * Set a specific theme to be used for this object and its children
+ * @defgroup Profile Elementary Profile
*
- * @param obj The object to set the theme on
- * @param th The theme to set
+ * Profiles are pre-set options that affect the whole look-and-feel of
+ * Elementary-based applications. There are, for example, profiles
+ * aimed at desktop computer applications and others aimed at mobile,
+ * touchscreen-based ones. You most probably don't want to use the
+ * functions in this group unlees you're writing an elementary
+ * configuration manager.
*
- * This sets a specific theme that will be used for the given object and any
- * child objects it has. If @p th is NULL then the theme to be used is
- * cleared and the object will inherit its theme from its parent (which
- * ultimately will use the default theme if no specific themes are set).
+ * @{
+ */
+
+ /**
+ * Get Elementary's profile in use.
*
- * Use special themes with great care as this will annoy users and make
- * configuration difficult. Avoid any custom themes at all if it can be
- * helped.
+ * This gets the global profile that is applied to all Elementary
+ * applications.
+ *
+ * @return The profile's name
+ * @ingroup Profile
*/
- EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_profile_current_get(void);
+
/**
- * Get the specific theme to be used
+ * Get an Elementary's profile directory path in the filesystem. One
+ * may want to fetch a system profile's dir or an user one (fetched
+ * inside $HOME).
*
- * @param obj The object to get the specific theme from
- * @return The specifc theme set.
+ * @param profile The profile's name
+ * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
+ * or a system one (@c EINA_FALSE)
+ * @return The profile's directory path.
+ * @ingroup Profile
*
- * This will return a specific theme set, or NULL if no specific theme is
- * set on that object. It will not return inherited themes from parents, only
- * the specific theme set for that specific object. See elm_object_theme_set()
- * for more information.
+ * @note You must free it with elm_profile_dir_free().
*/
- EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
+
/**
- * @}
+ * Free an Elementary's profile directory path, as returned by
+ * elm_profile_dir_get().
+ *
+ * @param p_dir The profile's path
+ * @ingroup Profile
+ *
*/
+ EAPI void elm_profile_dir_free(const char *p_dir);
- /* win */
- /** @defgroup Win Win
+ /**
+ * Get Elementary's list of available profiles.
*
- * @image html img/widget/win/preview-00.png
- * @image latex img/widget/win/preview-00.eps
+ * @return The profiles list. List node data are the profile name
+ * strings.
+ * @ingroup Profile
*
- * The window class of Elementary. Contains functions to manipulate
- * windows. The Evas engine used to render the window contents is specified
- * in the system or user elementary config files (whichever is found last),
- * and can be overridden with the ELM_ENGINE environment variable for
- * testing. Engines that may be supported (depending on Evas and Ecore-Evas
- * compilation setup and modules actually installed at runtime) are (listed
- * in order of best supported and most likely to be complete and work to
- * lowest quality).
+ * @note One must free this list, after usage, with the function
+ * elm_profile_list_free().
+ */
+ EAPI Eina_List *elm_profile_list_get(void);
+
+ /**
+ * Free Elementary's list of available profiles.
*
- * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
- * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
- * rendering in X11)
- * @li "shot:..." (Virtual screenshot renderer - renders to output file and
- * exits)
- * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
- * rendering)
- * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
- * buffer)
- * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
- * rendering using SDL as the buffer)
- * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
- * GDI with software)
- * @li "dfb", "directfb" (Rendering to a DirectFB window)
- * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
- * grayscale using dedicated 8bit software engine in X11)
- * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
- * X11 using 16bit software engine)
- * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
- * (Windows CE rendering via GDI with 16bit software renderer)
- * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
- * buffer with 16bit software renderer)
+ * @param l The profiles list, as returned by elm_profile_list_get().
+ * @ingroup Profile
*
- * All engines use a simple string to select the engine to render, EXCEPT
- * the "shot" engine. This actually encodes the output of the virtual
- * screenshot and how long to delay in the engine string. The engine string
- * is encoded in the following way:
+ */
+ EAPI void elm_profile_list_free(Eina_List *l);
+
+ /**
+ * Set Elementary's profile.
*
- * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
+ * This sets the global profile that is applied to Elementary
+ * applications. Just the process the call comes from will be
+ * affected.
*
- * Where options are separated by a ":" char if more than one option is
- * given, with delay, if provided being the first option and file the last
- * (order is important). The delay specifies how long to wait after the
- * window is shown before doing the virtual "in memory" rendering and then
- * save the output to the file specified by the file option (and then exit).
- * If no delay is given, the default is 0.5 seconds. If no file is given the
- * default output file is "out.png". Repeat option is for continous
- * capturing screenshots. Repeat range is from 1 to 999 and filename is
- * fixed to "out001.png" Some examples of using the shot engine:
+ * @param profile The profile's name
+ * @ingroup Profile
*
- * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
- * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
- * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
- * ELM_ENGINE="shot:delay=2.0" elementary_test
- * ELM_ENGINE="shot:" elementary_test
+ */
+ EAPI void elm_profile_set(const char *profile);
+
+ /**
+ * Set Elementary's profile.
*
- * Signals that you can add callbacks for are:
+ * This sets the global profile that is applied to all Elementary
+ * applications. All running Elementary windows will be affected.
*
- * @li "delete,request": the user requested to close the window. See
- * elm_win_autodel_set().
- * @li "focus,in": window got focus
- * @li "focus,out": window lost focus
- * @li "moved": window that holds the canvas was moved
+ * @param profile The profile's name
+ * @ingroup Profile
*
- * Examples:
- * @li @ref win_example_01
+ */
+ EAPI void elm_profile_all_set(const char *profile);
+
+ /**
+ * @}
+ */
+
+ /**
+ * @defgroup Engine Elementary Engine
+ *
+ * These are functions setting and querying which rendering engine
+ * Elementary will use for drawing its windows' pixels.
+ *
+ * The following are the available engines:
+ * @li "software_x11"
+ * @li "fb"
+ * @li "directfb"
+ * @li "software_16_x11"
+ * @li "software_8_x11"
+ * @li "xrender_x11"
+ * @li "opengl_x11"
+ * @li "software_gdi"
+ * @li "software_16_wince_gdi"
+ * @li "sdl"
+ * @li "software_16_sdl"
+ * @li "opengl_sdl"
+ * @li "buffer"
*
* @{
*/
+
/**
- * Defines the types of window that can be created
+ * @brief Get Elementary's rendering engine in use.
*
- * These are hints set on the window so that a running Window Manager knows
- * how the window should be handled and/or what kind of decorations it
- * should have.
+ * @return The rendering engine's name
+ * @note there's no need to free the returned string, here.
*
- * Currently, only the X11 backed engines use them.
+ * This gets the global rendering engine that is applied to all Elementary
+ * applications.
+ *
+ * @see elm_engine_set()
*/
- typedef enum _Elm_Win_Type
- {
- ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
- window. Almost every window will be created with this
- type. */
- ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
- ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
- window holding desktop icons. */
- ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
- be kept on top of any other window by the Window
- Manager. */
- ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
- similar. */
- ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
- ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
- pallete. */
- ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
- ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
- entry in a menubar is clicked. Typically used
- with elm_win_override_set(). This hint exists
- for completion only, as the EFL way of
- implementing a menu would not normally use a
- separate window for its contents. */
- ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
- triggered by right-clicking an object. */
- ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
- explanatory text that typically appear after the
- mouse cursor hovers over an object for a while.
- Typically used with elm_win_override_set() and also
- not very commonly used in the EFL. */
- ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
- battery life or a new E-Mail received. */
- ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
- usually used in the EFL. */
- ELM_WIN_DND, /**< Used to indicate the window is a representation of an
- object being dragged across different windows, or even
- applications. Typically used with
- elm_win_override_set(). */
- ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
- buffer. No actual window is created for this
- type, instead the window and all of its
- contents will be rendered to an image buffer.
- This allows to have children window inside a
- parent one just like any other object would
- be, and do other things like applying @c
- Evas_Map effects to it. This is the only type
- of window that requires the @c parent
- parameter of elm_win_add() to be a valid @c
- Evas_Object. */
- } Elm_Win_Type;
+ EAPI const char *elm_engine_current_get(void);
/**
- * The differents layouts that can be requested for the virtual keyboard.
+ * @brief Set Elementary's rendering engine for use.
*
- * When the application window is being managed by Illume, it may request
- * any of the following layouts for the virtual keyboard.
+ * @param engine The rendering engine's name
+ *
+ * This sets global rendering engine that is applied to all Elementary
+ * applications. Note that it will take effect only to Elementary windows
+ * created after this is called.
+ *
+ * @see elm_win_add()
*/
- typedef enum _Elm_Win_Keyboard_Mode
- {
- ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
- ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
- ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
- ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
- ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
- ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
- ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
- ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
- ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
- ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
- ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
- ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
- ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
- ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
- ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
- ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
- } Elm_Win_Keyboard_Mode;
+ EAPI void elm_engine_set(const char *engine);
/**
- * Available commands that can be sent to the Illume manager.
+ * @}
+ */
+
+ /**
+ * @defgroup Fonts Elementary Fonts
*
- * When running under an Illume session, a window may send commands to the
- * Illume manager to perform different actions.
+ * These are functions dealing with font rendering, selection and the
+ * like for Elementary applications. One might fetch which system
+ * fonts are there to use and set custom fonts for individual classes
+ * of UI items containing text (text classes).
+ *
+ * @{
*/
- typedef enum _Elm_Illume_Command
- {
- ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
- window */
- ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
- in the list */
- ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
- screen */
- ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
- } Elm_Illume_Command;
+
+ typedef struct _Elm_Text_Class
+ {
+ const char *name;
+ const char *desc;
+ } Elm_Text_Class;
+
+ typedef struct _Elm_Font_Overlay
+ {
+ const char *text_class;
+ const char *font;
+ Evas_Font_Size size;
+ } Elm_Font_Overlay;
+
+ typedef struct _Elm_Font_Properties
+ {
+ const char *name;
+ Eina_List *styles;
+ } Elm_Font_Properties;
/**
- * Adds a window object. If this is the first window created, pass NULL as
- * @p parent.
+ * Get Elementary's list of supported text classes.
*
- * @param parent Parent object to add the window to, or NULL
- * @param name The name of the window
- * @param type The window type, one of #Elm_Win_Type.
+ * @return The text classes list, with @c Elm_Text_Class blobs as data.
+ * @ingroup Fonts
*
- * The @p parent paramter can be @c NULL for every window @p type except
- * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
- * which the image object will be created.
+ * Release the list with elm_text_classes_list_free().
+ */
+ EAPI const Eina_List *elm_text_classes_list_get(void);
+
+ /**
+ * Free Elementary's list of supported text classes.
*
- * @return The created object, or NULL on failure
+ * @ingroup Fonts
+ *
+ * @see elm_text_classes_list_get().
*/
- EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
+ EAPI void elm_text_classes_list_free(const Eina_List *list);
+
/**
- * Add @p subobj as a resize object of window @p obj.
+ * Get Elementary's list of font overlays, set with
+ * elm_font_overlay_set().
*
+ * @return The font overlays list, with @c Elm_Font_Overlay blobs as
+ * data.
*
- * Setting an object as a resize object of the window means that the
- * @p subobj child's size and position will be controlled by the window
- * directly. That is, the object will be resized to match the window size
- * and should never be moved or resized manually by the developer.
+ * @ingroup Fonts
*
- * In addition, resize objects of the window control what the minimum size
- * of it will be, as well as whether it can or not be resized by the user.
+ * For each text class, one can set a <b>font overlay</b> for it,
+ * overriding the default font properties for that class coming from
+ * the theme in use. There is no need to free this list.
*
- * For the end user to be able to resize a window by dragging the handles
- * or borders provided by the Window Manager, or using any other similar
- * mechanism, all of the resize objects in the window should have their
- * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
+ * @see elm_font_overlay_set() and elm_font_overlay_unset().
+ */
+ EAPI const Eina_List *elm_font_overlay_list_get(void);
+
+ /**
+ * Set a font overlay for a given Elementary text class.
*
- * @param obj The window object
- * @param subobj The resize object to add
+ * @param text_class Text class name
+ * @param font Font name and style string
+ * @param size Font size
+ *
+ * @ingroup Fonts
+ *
+ * @p font has to be in the format returned by
+ * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
+ * and elm_font_overlay_unset().
*/
- EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+ EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
+
/**
- * Delete @p subobj as a resize object of window @p obj.
+ * Unset a font overlay for a given Elementary text class.
*
- * This function removes the object @p subobj from the resize objects of
- * the window @p obj. It will not delete the object itself, which will be
- * left unmanaged and should be deleted by the developer, manually handled
- * or set as child of some other container.
+ * @param text_class Text class name
*
- * @param obj The window object
- * @param subobj The resize object to add
+ * @ingroup Fonts
+ *
+ * This will bring back text elements belonging to text class
+ * @p text_class back to their default font settings.
*/
- EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+ EAPI void elm_font_overlay_unset(const char *text_class);
+
/**
- * Set the title of the window
+ * Apply the changes made with elm_font_overlay_set() and
+ * elm_font_overlay_unset() on the current Elementary window.
*
- * @param obj The window object
- * @param title The title to set
+ * @ingroup Fonts
+ *
+ * This applies all font overlays set to all objects in the UI.
*/
- EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
+ EAPI void elm_font_overlay_apply(void);
+
/**
- * Get the title of the window
+ * Apply the changes made with elm_font_overlay_set() and
+ * elm_font_overlay_unset() on all Elementary application windows.
*
- * The returned string is an internal one and should not be freed or
- * modified. It will also be rendered invalid if a new title is set or if
- * the window is destroyed.
+ * @ingroup Fonts
*
- * @param obj The window object
- * @return The title
+ * This applies all font overlays set to all objects in the UI.
*/
- EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_font_overlay_all_apply(void);
+
/**
- * Set the window's autodel state.
+ * Translate a font (family) name string in fontconfig's font names
+ * syntax into an @c Elm_Font_Properties struct.
*
- * When closing the window in any way outside of the program control, like
- * pressing the X button in the titlebar or using a command from the
- * Window Manager, a "delete,request" signal is emitted to indicate that
- * this event occurred and the developer can take any action, which may
- * include, or not, destroying the window object.
+ * @param font The font name and styles string
+ * @return the font properties struct
*
- * When the @p autodel parameter is set, the window will be automatically
- * destroyed when this event occurs, after the signal is emitted.
- * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
- * and is up to the program to do so when it's required.
+ * @ingroup Fonts
*
- * @param obj The window object
- * @param autodel If true, the window will automatically delete itself when
- * closed
+ * @note The reverse translation can be achived with
+ * elm_font_fontconfig_name_get(), for one style only (single font
+ * instance, not family).
*/
- EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
+ EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
+
/**
- * Get the window's autodel state.
+ * Free font properties return by elm_font_properties_get().
*
- * @param obj The window object
- * @return If the window will automatically delete itself when closed
+ * @param efp the font properties struct
*
- * @see elm_win_autodel_set()
+ * @ingroup Fonts
*/
- EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
+
/**
- * Activate a window object.
+ * Translate a font name, bound to a style, into fontconfig's font names
+ * syntax.
*
- * This function sends a request to the Window Manager to activate the
- * window pointed by @p obj. If honored by the WM, the window will receive
- * the keyboard focus.
+ * @param name The font (family) name
+ * @param style The given style (may be @c NULL)
*
- * @note This is just a request that a Window Manager may ignore, so calling
- * this function does not ensure in any way that the window will be the
- * active one after it.
+ * @return the font name and style string
*
- * @param obj The window object
+ * @ingroup Fonts
+ *
+ * @note The reverse translation can be achived with
+ * elm_font_properties_get(), for one style only (single font
+ * instance, not family).
*/
- EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
+
/**
- * Lower a window object.
- *
- * Places the window pointed by @p obj at the bottom of the stack, so that
- * no other window is covered by it.
+ * Free the font string return by elm_font_fontconfig_name_get().
*
- * If elm_win_override_set() is not set, the Window Manager may ignore this
- * request.
+ * @param efp the font properties struct
*
- * @param obj The window object
+ * @ingroup Fonts
*/
- EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
+
/**
- * Raise a window object.
+ * Create a font hash table of available system fonts.
*
- * Places the window pointed by @p obj at the top of the stack, so that it's
- * not covered by any other window.
+ * One must call it with @p list being the return value of
+ * evas_font_available_list(). The hash will be indexed by font
+ * (family) names, being its values @c Elm_Font_Properties blobs.
*
- * If elm_win_override_set() is not set, the Window Manager may ignore this
- * request.
+ * @param list The list of available system fonts, as returned by
+ * evas_font_available_list().
+ * @return the font hash.
*
- * @param obj The window object
+ * @ingroup Fonts
+ *
+ * @note The user is supposed to get it populated at least with 3
+ * default font families (Sans, Serif, Monospace), which should be
+ * present on most systems.
*/
- EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
+
/**
- * Set the borderless state of a window.
+ * Free the hash return by elm_font_available_hash_add().
*
- * This function requests the Window Manager to not draw any decoration
- * around the window.
+ * @param hash the hash to be freed.
*
- * @param obj The window object
- * @param borderless If true, the window is borderless
+ * @ingroup Fonts
*/
- EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
+ EAPI void elm_font_available_hash_del(Eina_Hash *hash);
+
/**
- * Get the borderless state of a window.
- *
- * @param obj The window object
- * @return If true, the window is borderless
+ * @}
*/
- EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set the shaped state of a window.
- *
- * Shaped windows, when supported, will render the parts of the window that
- * has no content, transparent.
- *
- * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
- * background object or cover the entire window in any other way, or the
- * parts of the canvas that have no data will show framebuffer artifacts.
+ * @defgroup Fingers Fingers
*
- * @param obj The window object
- * @param shaped If true, the window is shaped
+ * Elementary is designed to be finger-friendly for touchscreens,
+ * and so in addition to scaling for display resolution, it can
+ * also scale based on finger "resolution" (or size). You can then
+ * customize the granularity of the areas meant to receive clicks
+ * on touchscreens.
*
- * @see elm_win_alpha_set()
- */
- EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
- /**
- * Get the shaped state of a window.
+ * Different profiles may have pre-set values for finger sizes.
*
- * @param obj The window object
- * @return If true, the window is shaped
+ * @ref general_functions_example_page "This" example contemplates
+ * some of these functions.
*
- * @see elm_win_shaped_set()
+ * @{
*/
- EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set the alpha channel state of a window.
+ * Get the configured "finger size"
*
- * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
- * possibly making parts of the window completely or partially transparent.
- * This is also subject to the underlying system supporting it, like for
- * example, running under a compositing manager. If no compositing is
- * available, enabling this option will instead fallback to using shaped
- * windows, with elm_win_shaped_set().
+ * @return The finger size
*
- * @param obj The window object
- * @param alpha If true, the window has an alpha channel
+ * This gets the globally configured finger size, <b>in pixels</b>
*
- * @see elm_win_alpha_set()
+ * @ingroup Fingers
*/
- EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
+ EAPI Evas_Coord elm_finger_size_get(void);
+
/**
- * Get the transparency state of a window.
+ * Set the configured finger size
*
- * @param obj The window object
- * @return If true, the window is transparent
+ * This sets the globally configured finger size in pixels
*
- * @see elm_win_transparent_set()
+ * @param size The finger size
+ * @ingroup Fingers
*/
- EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_finger_size_set(Evas_Coord size);
+
/**
- * Set the transparency state of a window.
- *
- * Use elm_win_alpha_set() instead.
+ * Set the configured finger size for all applications on the display
*
- * @param obj The window object
- * @param transparent If true, the window is transparent
+ * This sets the globally configured finger size in pixels for all
+ * applications on the display
*
- * @see elm_win_alpha_set()
+ * @param size The finger size
+ * @ingroup Fingers
*/
- EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
+ EAPI void elm_finger_size_all_set(Evas_Coord size);
+
/**
- * Get the alpha channel state of a window.
- *
- * @param obj The window object
- * @return If true, the window has an alpha channel
+ * @}
*/
- EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set the override state of a window.
+ * @defgroup Focus Focus
*
- * A window with @p override set to EINA_TRUE will not be managed by the
- * Window Manager. This means that no decorations of any kind will be shown
- * for it, moving and resizing must be handled by the application, as well
- * as the window visibility.
+ * An Elementary application has, at all times, one (and only one)
+ * @b focused object. This is what determines where the input
+ * events go to within the application's window. Also, focused
+ * objects can be decorated differently, in order to signal to the
+ * user where the input is, at a given moment.
*
- * This should not be used for normal windows, and even for not so normal
- * ones, it should only be used when there's a good reason and with a lot
- * of care. Mishandling override windows may result situations that
- * disrupt the normal workflow of the end user.
+ * Elementary applications also have the concept of <b>focus
+ * chain</b>: one can cycle through all the windows' focusable
+ * objects by input (tab key) or programmatically. The default
+ * focus chain for an application is the one define by the order in
+ * which the widgets where added in code. One will cycle through
+ * top level widgets, and, for each one containg sub-objects, cycle
+ * through them all, before returning to the level
+ * above. Elementary also allows one to set @b custom focus chains
+ * for their applications.
*
- * @param obj The window object
- * @param override If true, the window is overridden
- */
- EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
- /**
- * Get the override state of a window.
+ * Besides the focused decoration a widget may exhibit, when it
+ * gets focus, Elementary has a @b global focus highlight object
+ * that can be enabled for a window. If one chooses to do so, this
+ * extra highlight effect will surround the current focused object,
+ * too.
*
- * @param obj The window object
- * @return If true, the window is overridden
+ * @note Some Elementary widgets are @b unfocusable, after
+ * creation, by their very nature: they are not meant to be
+ * interacted with input events, but are there just for visual
+ * purposes.
*
- * @see elm_win_override_set()
+ * @ref general_functions_example_page "This" example contemplates
+ * some of these functions.
*/
- EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set the fullscreen state of a window.
+ * Get the enable status of the focus highlight
*
- * @param obj The window object
- * @param fullscreen If true, the window is fullscreen
+ * This gets whether the highlight on focused objects is enabled or not
+ * @ingroup Focus
*/
- EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
+
/**
- * Get the fullscreen state of a window.
+ * Set the enable status of the focus highlight
*
- * @param obj The window object
- * @return If true, the window is fullscreen
+ * Set whether to show or not the highlight on focused objects
+ * @param enable Enable highlight if EINA_TRUE, disable otherwise
+ * @ingroup Focus
*/
- EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
+
/**
- * Set the maximized state of a window.
+ * Get the enable status of the highlight animation
*
- * @param obj The window object
- * @param maximized If true, the window is maximized
+ * Get whether the focus highlight, if enabled, will animate its switch from
+ * one object to the next
+ * @ingroup Focus
*/
- EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_focus_highlight_animate_get(void);
+
/**
- * Get the maximized state of a window.
+ * Set the enable status of the highlight animation
*
- * @param obj The window object
- * @return If true, the window is maximized
+ * Set whether the focus highlight, if enabled, will animate its switch from
+ * one object to the next
+ * @param animate Enable animation if EINA_TRUE, disable otherwise
+ * @ingroup Focus
*/
- EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
+
/**
- * Set the iconified state of a window.
+ * Get the whether an Elementary object has the focus or not.
*
- * @param obj The window object
- * @param iconified If true, the window is iconified
- */
- EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
- /**
- * Get the iconified state of a window.
+ * @param obj The Elementary object to get the information from
+ * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
+ * not (and on errors).
*
- * @param obj The window object
- * @return If true, the window is iconified
+ * @see elm_object_focus_set()
+ *
+ * @ingroup Focus
*/
- EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set the layer of the window.
- *
- * What this means exactly will depend on the underlying engine used.
+ * Set/unset focus to a given Elementary object.
*
- * In the case of X11 backed engines, the value in @p layer has the
- * following meanings:
- * @li < 3: The window will be placed below all others.
- * @li > 5: The window will be placed above all others.
- * @li other: The window will be placed in the default layer.
+ * @param obj The Elementary object to operate on.
+ * @param enable @c EINA_TRUE Set focus to a given object,
+ * @c EINA_FALSE Unset focus to a given object.
*
- * @param obj The window object
- * @param layer The layer of the window
- */
- EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
- /**
- * Get the layer of the window.
+ * @note When you set focus to this object, if it can handle focus, will
+ * take the focus away from the one who had it previously and will, for
+ * now on, be the one receiving input events. Unsetting focus will remove
+ * the focus from @p obj, passing it back to the previous element in the
+ * focus chain list.
*
- * @param obj The window object
- * @return The layer of the window
+ * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
*
- * @see elm_win_layer_set()
+ * @ingroup Focus
*/
- EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
+
/**
- * Set the rotation of the window.
+ * Make a given Elementary object the focused one.
*
- * Most engines only work with multiples of 90.
+ * @param obj The Elementary object to make focused.
*
- * This function is used to set the orientation of the window @p obj to
- * match that of the screen. The window itself will be resized to adjust
- * to the new geometry of its contents. If you want to keep the window size,
- * see elm_win_rotation_with_resize_set().
+ * @note This object, if it can handle focus, will take the focus
+ * away from the one who had it previously and will, for now on, be
+ * the one receiving input events.
*
- * @param obj The window object
- * @param rotation The rotation of the window, in degrees (0-360),
- * counter-clockwise.
+ * @see elm_object_focus_get()
+ * @deprecated use elm_object_focus_set() instead.
+ *
+ * @ingroup Focus
*/
- EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Rotates the window and resizes it.
+ * Remove the focus from an Elementary object
*
- * Like elm_win_rotation_set(), but it also resizes the window's contents so
- * that they fit inside the current window geometry.
+ * @param obj The Elementary to take focus from
*
- * @param obj The window object
- * @param layer The rotation of the window in degrees (0-360),
- * counter-clockwise.
+ * This removes the focus from @p obj, passing it back to the
+ * previous element in the focus chain list.
+ *
+ * @see elm_object_focus() and elm_object_focus_custom_chain_get()
+ * @deprecated use elm_object_focus_set() instead.
+ *
+ * @ingroup Focus
*/
- EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the rotation of the window.
+ * Set the ability for an Element object to be focused
*
- * @param obj The window object
- * @return The rotation of the window in degrees (0-360)
+ * @param obj The Elementary object to operate on
+ * @param enable @c EINA_TRUE if the object can be focused, @c
+ * EINA_FALSE if not (and on errors)
*
- * @see elm_win_rotation_set()
- * @see elm_win_rotation_with_resize_set()
+ * This sets whether the object @p obj is able to take focus or
+ * not. Unfocusable objects do nothing when programmatically
+ * focused, being the nearest focusable parent object the one
+ * really getting focus. Also, when they receive mouse input, they
+ * will get the event, but not take away the focus from where it
+ * was previously.
+ *
+ * @ingroup Focus
*/
- EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
+
/**
- * Set the sticky state of the window.
+ * Get whether an Elementary object is focusable or not
*
- * Hints the Window Manager that the window in @p obj should be left fixed
- * at its position even when the virtual desktop it's on moves or changes.
+ * @param obj The Elementary object to operate on
+ * @return @c EINA_TRUE if the object is allowed to be focused, @c
+ * EINA_FALSE if not (and on errors)
*
- * @param obj The window object
- * @param sticky If true, the window's sticky state is enabled
+ * @note Objects which are meant to be interacted with by input
+ * events are created able to be focused, by default. All the
+ * others are not.
+ *
+ * @ingroup Focus
*/
- EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the sticky state of the window.
+ * Set custom focus chain.
*
- * @param obj The window object
- * @return If true, the window's sticky state is enabled
+ * This function overwrites any previous custom focus chain within
+ * the list of objects. The previous list will be deleted and this list
+ * will be managed by elementary. After it is set, don't modify it.
*
- * @see elm_win_sticky_set()
+ * @note On focus cycle, only will be evaluated children of this container.
+ *
+ * @param obj The container object
+ * @param objs Chain of objects to pass focus
+ * @ingroup Focus
*/
- EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
+
/**
- * Set if this window is an illume conformant window
+ * Unset a custom focus chain on a given Elementary widget
*
- * @param obj The window object
- * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
+ * @param obj The container object to remove focus chain from
+ *
+ * Any focus chain previously set on @p obj (for its child objects)
+ * is removed entirely after this call.
+ *
+ * @ingroup Focus
*/
- EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get if this window is an illume conformant window
+ * Get custom focus chain
*
- * @param obj The window object
- * @return A boolean if this window is illume conformant or not
+ * @param obj The container object
+ * @ingroup Focus
*/
- EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set a window to be an illume quickpanel window
+ * Append object to custom focus chain.
*
- * By default window objects are not quickpanel windows.
+ * @note If relative_child equal to NULL or not in custom chain, the object
+ * will be added in end.
*
- * @param obj The window object
- * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
- */
- EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
- /**
- * Get if this window is a quickpanel or not
+ * @note On focus cycle, only will be evaluated children of this container.
*
- * @param obj The window object
- * @return A boolean if this window is a quickpanel or not
+ * @param obj The container object
+ * @param child The child to be added in custom chain
+ * @param relative_child The relative object to position the child
+ * @ingroup Focus
*/
- EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
+
/**
- * Set the major priority of a quickpanel window
+ * Prepend object to custom focus chain.
*
- * @param obj The window object
- * @param priority The major priority for this quickpanel
+ * @note If relative_child equal to NULL or not in custom chain, the object
+ * will be added in begin.
+ *
+ * @note On focus cycle, only will be evaluated children of this container.
+ *
+ * @param obj The container object
+ * @param child The child to be added in custom chain
+ * @param relative_child The relative object to position the child
+ * @ingroup Focus
*/
- EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
+
/**
- * Get the major priority of a quickpanel window
+ * Give focus to next object in object tree.
*
- * @param obj The window object
- * @return The major priority of this quickpanel
+ * Give focus to next object in focus chain of one object sub-tree.
+ * If the last object of chain already have focus, the focus will go to the
+ * first object of chain.
+ *
+ * @param obj The object root of sub-tree
+ * @param dir Direction to cycle the focus
+ *
+ * @ingroup Focus
*/
- EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
+
/**
- * Set the minor priority of a quickpanel window
+ * Give focus to near object in one direction.
*
- * @param obj The window object
- * @param priority The minor priority for this quickpanel
+ * Give focus to near object in direction of one object.
+ * If none focusable object in given direction, the focus will not change.
+ *
+ * @param obj The reference object
+ * @param x Horizontal component of direction to focus
+ * @param y Vertical component of direction to focus
+ *
+ * @ingroup Focus
*/
- EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
+
/**
- * Get the minor priority of a quickpanel window
+ * Make the elementary object and its children to be unfocusable
+ * (or focusable).
*
- * @param obj The window object
- * @return The minor priority of this quickpanel
+ * @param obj The Elementary object to operate on
+ * @param tree_unfocusable @c EINA_TRUE for unfocusable,
+ * @c EINA_FALSE for focusable.
+ *
+ * This sets whether the object @p obj and its children objects
+ * are able to take focus or not. If the tree is set as unfocusable,
+ * newest focused object which is not in this tree will get focus.
+ * This API can be helpful for an object to be deleted.
+ * When an object will be deleted soon, it and its children may not
+ * want to get focus (by focus reverting or by other focus controls).
+ * Then, just use this API before deleting.
+ *
+ * @see elm_object_tree_unfocusable_get()
+ *
+ * @ingroup Focus
*/
- EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
+
/**
- * Set which zone this quickpanel should appear in
+ * Get whether an Elementary object and its children are unfocusable or not.
*
- * @param obj The window object
- * @param zone The requested zone for this quickpanel
+ * @param obj The Elementary object to get the information from
+ * @return @c EINA_TRUE, if the tree is unfocussable,
+ * @c EINA_FALSE if not (and on errors).
+ *
+ * @see elm_object_tree_unfocusable_set()
+ *
+ * @ingroup Focus
*/
- EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
+
/**
- * Get which zone this quickpanel should appear in
+ * @defgroup Scrolling Scrolling
*
- * @param obj The window object
- * @return The requested zone for this quickpanel
+ * These are functions setting how scrollable views in Elementary
+ * widgets should behave on user interaction.
+ *
+ * @{
*/
- EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set the window to be skipped by keyboard focus
+ * Get whether scrollers should bounce when they reach their
+ * viewport's edge during a scroll.
*
- * This sets the window to be skipped by normal keyboard input. This means
- * a window manager will be asked to not focus this window as well as omit
- * it from things like the taskbar, pager, "alt-tab" list etc. etc.
+ * @return the thumb scroll bouncing state
*
- * Call this and enable it on a window BEFORE you show it for the first time,
- * otherwise it may have no effect.
+ * This is the default behavior for touch screens, in general.
+ * @ingroup Scrolling
+ */
+ EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
+
+ /**
+ * Set whether scrollers should bounce when they reach their
+ * viewport's edge during a scroll.
*
- * Use this for windows that have only output information or might only be
- * interacted with by the mouse or fingers, and never for typing input.
- * Be careful that this may have side-effects like making the window
- * non-accessible in some cases unless the window is specially handled. Use
- * this with care.
+ * @param enabled the thumb scroll bouncing state
*
- * @param obj The window object
- * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
+ * @see elm_thumbscroll_bounce_enabled_get()
+ * @ingroup Scrolling
*/
- EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
+ EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
+
/**
- * Send a command to the windowing environment
+ * Set whether scrollers should bounce when they reach their
+ * viewport's edge during a scroll, for all Elementary application
+ * windows.
*
- * This is intended to work in touchscreen or small screen device
- * environments where there is a more simplistic window management policy in
- * place. This uses the window object indicated to select which part of the
- * environment to control (the part that this window lives in), and provides
- * a command and an optional parameter structure (use NULL for this if not
- * needed).
+ * @param enabled the thumb scroll bouncing state
*
- * @param obj The window object that lives in the environment to control
- * @param command The command to send
- * @param params Optional parameters for the command
+ * @see elm_thumbscroll_bounce_enabled_get()
+ * @ingroup Scrolling
*/
- EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
+ EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
+
/**
- * Get the inlined image object handle
+ * Get the amount of inertia a scroller will impose at bounce
+ * animations.
*
- * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
- * then the window is in fact an evas image object inlined in the parent
- * canvas. You can get this object (be careful to not manipulate it as it
- * is under control of elementary), and use it to do things like get pixel
- * data, save the image to a file, etc.
+ * @return the thumb scroll bounce friction
*
- * @param obj The window object to get the inlined image from
- * @return The inlined image object, or NULL if none exists
+ * @ingroup Scrolling
*/
- EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
+ EAPI double elm_scroll_bounce_friction_get(void);
+
/**
- * Set the enabled status for the focus highlight in a window
+ * Set the amount of inertia a scroller will impose at bounce
+ * animations.
*
- * This function will enable or disable the focus highlight only for the
- * given window, regardless of the global setting for it
+ * @param friction the thumb scroll bounce friction
*
- * @param obj The window where to enable the highlight
- * @param enabled The enabled value for the highlight
+ * @see elm_thumbscroll_bounce_friction_get()
+ * @ingroup Scrolling
*/
- EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
+ EAPI void elm_scroll_bounce_friction_set(double friction);
+
/**
- * Get the enabled value of the focus highlight for this window
+ * Set the amount of inertia a scroller will impose at bounce
+ * animations, for all Elementary application windows.
*
- * @param obj The window in which to check if the focus highlight is enabled
+ * @param friction the thumb scroll bounce friction
*
- * @return EINA_TRUE if enabled, EINA_FALSE otherwise
+ * @see elm_thumbscroll_bounce_friction_get()
+ * @ingroup Scrolling
*/
- EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_scroll_bounce_friction_all_set(double friction);
+
/**
- * Set the style for the focus highlight on this window
+ * Get the amount of inertia a <b>paged</b> scroller will impose at
+ * page fitting animations.
*
- * Sets the style to use for theming the highlight of focused objects on
- * the given window. If @p style is NULL, the default will be used.
+ * @return the page scroll friction
*
- * @param obj The window where to set the style
- * @param style The style to set
+ * @ingroup Scrolling
*/
- EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
+ EAPI double elm_scroll_page_scroll_friction_get(void);
+
/**
- * Get the style set for the focus highlight object
- *
- * Gets the style set for this windows highilght object, or NULL if none
- * is set.
+ * Set the amount of inertia a <b>paged</b> scroller will impose at
+ * page fitting animations.
*
- * @param obj The window to retrieve the highlights style from
+ * @param friction the page scroll friction
*
- * @return The style set or NULL if none was. Default is used in that case.
+ * @see elm_thumbscroll_page_scroll_friction_get()
+ * @ingroup Scrolling
*/
- EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /*...
- * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
- * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
- * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
- * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
- * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
- * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
- * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
+ EAPI void elm_scroll_page_scroll_friction_set(double friction);
+
+ /**
+ * Set the amount of inertia a <b>paged</b> scroller will impose at
+ * page fitting animations, for all Elementary application windows.
*
- * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
- * (blank mouse, private mouse obj, defaultmouse)
+ * @param friction the page scroll friction
*
+ * @see elm_thumbscroll_page_scroll_friction_get()
+ * @ingroup Scrolling
*/
+ EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
+
/**
- * Sets the keyboard mode of the window.
+ * Get the amount of inertia a scroller will impose at region bring
+ * animations.
*
- * @param obj The window object
- * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
+ * @return the bring in scroll friction
+ *
+ * @ingroup Scrolling
*/
- EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
+ EAPI double elm_scroll_bring_in_scroll_friction_get(void);
+
/**
- * Gets the keyboard mode of the window.
+ * Set the amount of inertia a scroller will impose at region bring
+ * animations.
*
- * @param obj The window object
- * @return The mode, one of #Elm_Win_Keyboard_Mode
- */
- EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Sets whether the window is a keyboard.
+ * @param friction the bring in scroll friction
*
- * @param obj The window object
- * @param is_keyboard If true, the window is a virtual keyboard
+ * @see elm_thumbscroll_bring_in_scroll_friction_get()
+ * @ingroup Scrolling
*/
- EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
+ EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
+
/**
- * Gets whether the window is a keyboard.
+ * Set the amount of inertia a scroller will impose at region bring
+ * animations, for all Elementary application windows.
*
- * @param obj The window object
- * @return If the window is a virtual keyboard
+ * @param friction the bring in scroll friction
+ *
+ * @see elm_thumbscroll_bring_in_scroll_friction_get()
+ * @ingroup Scrolling
*/
- EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
/**
- * Get the screen position of a window.
+ * Get the amount of inertia scrollers will impose at animations
+ * triggered by Elementary widgets' zooming API.
*
- * @param obj The window object
- * @param x The int to store the x coordinate to
- * @param y The int to store the y coordinate to
- */
- EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
- /**
- * @}
+ * @return the zoom friction
+ *
+ * @ingroup Scrolling
*/
+ EAPI double elm_scroll_zoom_friction_get(void);
/**
- * @defgroup Inwin Inwin
- *
- * @image html img/widget/inwin/preview-00.png
- * @image latex img/widget/inwin/preview-00.eps
- * @image html img/widget/inwin/preview-01.png
- * @image latex img/widget/inwin/preview-01.eps
- * @image html img/widget/inwin/preview-02.png
- * @image latex img/widget/inwin/preview-02.eps
- *
- * An inwin is a window inside a window that is useful for a quick popup.
- * It does not hover.
- *
- * It works by creating an object that will occupy the entire window, so it
- * must be created using an @ref Win "elm_win" as parent only. The inwin
- * object can be hidden or restacked below every other object if it's
- * needed to show what's behind it without destroying it. If this is done,
- * the elm_win_inwin_activate() function can be used to bring it back to
- * full visibility again.
- *
- * There are three styles available in the default theme. These are:
- * @li default: The inwin is sized to take over most of the window it's
- * placed in.
- * @li minimal: The size of the inwin will be the minimum necessary to show
- * its contents.
- * @li minimal_vertical: Horizontally, the inwin takes as much space as
- * possible, but it's sized vertically the most it needs to fit its\
- * contents.
+ * Set the amount of inertia scrollers will impose at animations
+ * triggered by Elementary widgets' zooming API.
*
- * Some examples of Inwin can be found in the following:
- * @li @ref inwin_example_01
+ * @param friction the zoom friction
*
- * @{
+ * @see elm_thumbscroll_zoom_friction_get()
+ * @ingroup Scrolling
*/
+ EAPI void elm_scroll_zoom_friction_set(double friction);
+
/**
- * Adds an inwin to the current window
- *
- * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
- * Never call this function with anything other than the top-most window
- * as its parameter, unless you are fond of undefined behavior.
+ * Set the amount of inertia scrollers will impose at animations
+ * triggered by Elementary widgets' zooming API, for all Elementary
+ * application windows.
*
- * After creating the object, the widget will set itself as resize object
- * for the window with elm_win_resize_object_add(), so when shown it will
- * appear to cover almost the entire window (how much of it depends on its
- * content and the style used). It must not be added into other container
- * objects and it needs not be moved or resized manually.
+ * @param friction the zoom friction
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @see elm_thumbscroll_zoom_friction_get()
+ * @ingroup Scrolling
*/
- EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_scroll_zoom_friction_all_set(double friction);
+
/**
- * Activates an inwin object, ensuring its visibility
+ * Get whether scrollers should be draggable from any point in their
+ * views.
*
- * This function will make sure that the inwin @p obj is completely visible
- * by calling evas_object_show() and evas_object_raise() on it, to bring it
- * to the front. It also sets the keyboard focus to it, which will be passed
- * onto its content.
+ * @return the thumb scroll state
*
- * The object's theme will also receive the signal "elm,action,show" with
- * source "elm".
+ * @note This is the default behavior for touch screens, in general.
+ * @note All other functions namespaced with "thumbscroll" will only
+ * have effect if this mode is enabled.
*
- * @param obj The inwin to activate
+ * @ingroup Scrolling
*/
- EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
+
/**
- * Set the content of an inwin object.
+ * Set whether scrollers should be draggable from any point in their
+ * views.
*
- * Once the content object is set, a previously set one will be deleted.
- * If you want to keep that old content object, use the
- * elm_win_inwin_content_unset() function.
+ * @param enabled the thumb scroll state
*
- * @param obj The inwin object
- * @param content The object to set as content
+ * @see elm_thumbscroll_enabled_get()
+ * @ingroup Scrolling
*/
- EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+ EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
+
/**
- * Get the content of an inwin object.
- *
- * Return the content object which is set for this widget.
- *
- * The returned object is valid as long as the inwin is still alive and no
- * other content is set on it. Deleting the object will notify the inwin
- * about it and this one will be left empty.
+ * Set whether scrollers should be draggable from any point in their
+ * views, for all Elementary application windows.
*
- * If you need to remove an inwin's content to be reused somewhere else,
- * see elm_win_inwin_content_unset().
+ * @param enabled the thumb scroll state
*
- * @param obj The inwin object
- * @return The content that is being used
+ * @see elm_thumbscroll_enabled_get()
+ * @ingroup Scrolling
*/
- EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
+
/**
- * Unset the content of an inwin object.
+ * Get the number of pixels one should travel while dragging a
+ * scroller's view to actually trigger scrolling.
*
- * Unparent and return the content object which was set for this widget.
+ * @return the thumb scroll threshould
*
- * @param obj The inwin object
- * @return The content that was being used
- */
- EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @}
- */
- /* X specific calls - won't work on non-x engines (return 0) */
- EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /* smart callbacks called:
- * "delete,request" - the user requested to delete the window
- * "focus,in" - window got focus
- * "focus,out" - window lost focus
- * "moved" - window that holds the canvas was moved
+ * One would use higher values for touch screens, in general, because
+ * of their inherent imprecision.
+ * @ingroup Scrolling
*/
+ EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
/**
- * @defgroup Bg Bg
+ * Set the number of pixels one should travel while dragging a
+ * scroller's view to actually trigger scrolling.
*
- * @image html img/widget/bg/preview-00.png
- * @image latex img/widget/bg/preview-00.eps
+ * @param threshold the thumb scroll threshould
*
- * @brief Background object, used for setting a solid color, image or Edje
- * group as background to a window or any container object.
+ * @see elm_thumbscroll_threshould_get()
+ * @ingroup Scrolling
+ */
+ EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
+
+ /**
+ * Set the number of pixels one should travel while dragging a
+ * scroller's view to actually trigger scrolling, for all Elementary
+ * application windows.
*
- * The bg object is used for setting a solid background to a window or
- * packing into any container object. It works just like an image, but has
- * some properties useful to a background, like setting it to tiled,
- * centered, scaled or stretched.
+ * @param threshold the thumb scroll threshould
*
- * Here is some sample code using it:
- * @li @ref bg_01_example_page
- * @li @ref bg_02_example_page
- * @li @ref bg_03_example_page
+ * @see elm_thumbscroll_threshould_get()
+ * @ingroup Scrolling
*/
-
- /* bg */
- typedef enum _Elm_Bg_Option
- {
- ELM_BG_OPTION_CENTER, /**< center the background */
- ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
- ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
- ELM_BG_OPTION_TILE /**< tile background at its original size */
- } Elm_Bg_Option;
+ EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
/**
- * Add a new background to the parent
+ * Get the minimum speed of mouse cursor movement which will trigger
+ * list self scrolling animation after a mouse up event
+ * (pixels/second).
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @return the thumb scroll momentum threshould
*
- * @ingroup Bg
+ * @ingroup Scrolling
*/
- EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
/**
- * Set the file (image or edje) used for the background
+ * Set the minimum speed of mouse cursor movement which will trigger
+ * list self scrolling animation after a mouse up event
+ * (pixels/second).
*
- * @param obj The bg object
- * @param file The file path
- * @param group Optional key (group in Edje) within the file
+ * @param threshold the thumb scroll momentum threshould
*
- * This sets the image file used in the background object. The image (or edje)
- * will be stretched (retaining aspect if its an image file) to completely fill
- * the bg object. This may mean some parts are not visible.
+ * @see elm_thumbscroll_momentum_threshould_get()
+ * @ingroup Scrolling
+ */
+ EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
+
+ /**
+ * Set the minimum speed of mouse cursor movement which will trigger
+ * list self scrolling animation after a mouse up event
+ * (pixels/second), for all Elementary application windows.
*
- * @note Once the image of @p obj is set, a previously set one will be deleted,
- * even if @p file is NULL.
+ * @param threshold the thumb scroll momentum threshould
*
- * @ingroup Bg
+ * @see elm_thumbscroll_momentum_threshould_get()
+ * @ingroup Scrolling
*/
- EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
+ EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
/**
- * Get the file (image or edje) used for the background
+ * Get the amount of inertia a scroller will impose at self scrolling
+ * animations.
*
- * @param obj The bg object
- * @param file The file path
- * @param group Optional key (group in Edje) within the file
+ * @return the thumb scroll friction
*
- * @ingroup Bg
+ * @ingroup Scrolling
*/
- EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
+ EAPI double elm_scroll_thumbscroll_friction_get(void);
/**
- * Set the option used for the background image
- *
- * @param obj The bg object
- * @param option The desired background option (TILE, SCALE)
+ * Set the amount of inertia a scroller will impose at self scrolling
+ * animations.
*
- * This sets the option used for manipulating the display of the background
- * image. The image can be tiled or scaled.
+ * @param friction the thumb scroll friction
*
- * @ingroup Bg
+ * @see elm_thumbscroll_friction_get()
+ * @ingroup Scrolling
*/
- EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
+ EAPI void elm_scroll_thumbscroll_friction_set(double friction);
/**
- * Get the option used for the background image
+ * Set the amount of inertia a scroller will impose at self scrolling
+ * animations, for all Elementary application windows.
*
- * @param obj The bg object
- * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
+ * @param friction the thumb scroll friction
*
- * @ingroup Bg
+ * @see elm_thumbscroll_friction_get()
+ * @ingroup Scrolling
*/
- EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
+
/**
- * Set the option used for the background color
- *
- * @param obj The bg object
- * @param r
- * @param g
- * @param b
+ * Get the amount of lag between your actual mouse cursor dragging
+ * movement and a scroller's view movement itself, while pushing it
+ * into bounce state manually.
*
- * This sets the color used for the background rectangle. Its range goes
- * from 0 to 255.
+ * @return the thumb scroll border friction
*
- * @ingroup Bg
+ * @ingroup Scrolling
*/
- EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
+ EAPI double elm_scroll_thumbscroll_border_friction_get(void);
+
/**
- * Get the option used for the background color
+ * Set the amount of lag between your actual mouse cursor dragging
+ * movement and a scroller's view movement itself, while pushing it
+ * into bounce state manually.
*
- * @param obj The bg object
- * @param r
- * @param g
- * @param b
+ * @param friction the thumb scroll border friction. @c 0.0 for
+ * perfect synchrony between two movements, @c 1.0 for maximum
+ * lag.
*
- * @ingroup Bg
+ * @see elm_thumbscroll_border_friction_get()
+ * @note parameter value will get bound to 0.0 - 1.0 interval, always
+ *
+ * @ingroup Scrolling
*/
- EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
+ EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
/**
- * Set the overlay object used for the background object.
+ * Set the amount of lag between your actual mouse cursor dragging
+ * movement and a scroller's view movement itself, while pushing it
+ * into bounce state manually, for all Elementary application windows.
*
- * @param obj The bg object
- * @param overlay The overlay object
+ * @param friction the thumb scroll border friction. @c 0.0 for
+ * perfect synchrony between two movements, @c 1.0 for maximum
+ * lag.
*
- * This provides a way for elm_bg to have an 'overlay' that will be on top
- * of the bg. Once the over object is set, a previously set one will be
- * deleted, even if you set the new one to NULL. If you want to keep that
- * old content object, use the elm_bg_overlay_unset() function.
+ * @see elm_thumbscroll_border_friction_get()
+ * @note parameter value will get bound to 0.0 - 1.0 interval, always
*
- * @ingroup Bg
+ * @ingroup Scrolling
*/
+ EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
- EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
+ /**
+ * @}
+ */
/**
- * Get the overlay object used for the background object.
+ * @defgroup Scrollhints Scrollhints
*
- * @param obj The bg object
- * @return The content that is being used
+ * Objects when inside a scroller can scroll, but this may not always be
+ * desirable in certain situations. This allows an object to hint to itself
+ * and parents to "not scroll" in one of 2 ways. If any child object of a
+ * scroller has pushed a scroll freeze or hold then it affects all parent
+ * scrollers until all children have released them.
*
- * Return the content object which is set for this widget
+ * 1. To hold on scrolling. This means just flicking and dragging may no
+ * longer scroll, but pressing/dragging near an edge of the scroller will
+ * still scroll. This is automatically used by the entry object when
+ * selecting text.
*
- * @ingroup Bg
+ * 2. To totally freeze scrolling. This means it stops. until
+ * popped/released.
+ *
+ * @{
*/
- EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the overlay object used for the background object.
+ * Push the scroll hold by 1
*
- * @param obj The bg object
- * @return The content that was being used
+ * This increments the scroll hold count by one. If it is more than 0 it will
+ * take effect on the parents of the indicated object.
*
- * Unparent and return the overlay object which was set for this widget
+ * @param obj The object
+ * @ingroup Scrollhints
+ */
+ EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Pop the scroll hold by 1
*
- * @ingroup Bg
+ * This decrements the scroll hold count by one. If it is more than 0 it will
+ * take effect on the parents of the indicated object.
+ *
+ * @param obj The object
+ * @ingroup Scrollhints
*/
- EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the size of the pixmap representation of the image.
+ * Push the scroll freeze by 1
*
- * This option just makes sense if an image is going to be set in the bg.
+ * This increments the scroll freeze count by one. If it is more
+ * than 0 it will take effect on the parents of the indicated
+ * object.
*
- * @param obj The bg object
- * @param w The new width of the image pixmap representation.
- * @param h The new height of the image pixmap representation.
- *
- * This function sets a new size for pixmap representation of the given bg
- * image. It allows the image to be loaded already in the specified size,
- * reducing the memory usage and load time when loading a big image with load
- * size set to a smaller size.
- *
- * NOTE: this is just a hint, the real size of the pixmap may differ
- * depending on the type of image being loaded, being bigger than requested.
- *
- * @ingroup Bg
- */
- EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
- /* smart callbacks called:
+ * @param obj The object
+ * @ingroup Scrollhints
*/
+ EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @defgroup Icon Icon
- *
- * @image html img/widget/icon/preview-00.png
- * @image latex img/widget/icon/preview-00.eps
+ * Pop the scroll freeze by 1
*
- * An object that provides standard icon images (delete, edit, arrows, etc.)
- * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
+ * This decrements the scroll freeze count by one. If it is more
+ * than 0 it will take effect on the parents of the indicated
+ * object.
*
- * The icon image requested can be in the elementary theme, or in the
- * freedesktop.org paths. It's possible to set the order of preference from
- * where the image will be used.
+ * @param obj The object
+ * @ingroup Scrollhints
+ */
+ EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Lock the scrolling of the given widget (and thus all parents)
*
- * This API is very similar to @ref Image, but with ready to use images.
+ * This locks the given object from scrolling in the X axis (and implicitly
+ * also locks all parent scrollers too from doing the same).
*
- * Default images provided by the theme are described below.
+ * @param obj The object
+ * @param lock The lock state (1 == locked, 0 == unlocked)
+ * @ingroup Scrollhints
+ */
+ EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
+
+ /**
+ * Lock the scrolling of the given widget (and thus all parents)
*
- * The first list contains icons that were first intended to be used in
- * toolbars, but can be used in many other places too:
- * @li home
- * @li close
- * @li apps
- * @li arrow_up
- * @li arrow_down
- * @li arrow_left
- * @li arrow_right
- * @li chat
- * @li clock
- * @li delete
- * @li edit
- * @li refresh
- * @li folder
- * @li file
+ * This locks the given object from scrolling in the Y axis (and implicitly
+ * also locks all parent scrollers too from doing the same).
*
- * Now some icons that were designed to be used in menus (but again, you can
- * use them anywhere else):
- * @li menu/home
- * @li menu/close
- * @li menu/apps
- * @li menu/arrow_up
- * @li menu/arrow_down
- * @li menu/arrow_left
- * @li menu/arrow_right
- * @li menu/chat
- * @li menu/clock
- * @li menu/delete
- * @li menu/edit
- * @li menu/refresh
- * @li menu/folder
- * @li menu/file
+ * @param obj The object
+ * @param lock The lock state (1 == locked, 0 == unlocked)
+ * @ingroup Scrollhints
+ */
+ EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the scrolling lock of the given widget
*
- * And here we have some media player specific icons:
- * @li media_player/forward
- * @li media_player/info
- * @li media_player/next
- * @li media_player/pause
- * @li media_player/play
- * @li media_player/prev
- * @li media_player/rewind
- * @li media_player/stop
+ * This gets the lock for X axis scrolling.
*
- * Signals that you can add callbacks for are:
+ * @param obj The object
+ * @ingroup Scrollhints
+ */
+ EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the scrolling lock of the given widget
*
- * "clicked" - This is called when a user has clicked the icon
+ * This gets the lock for X axis scrolling.
*
- * An example of usage for this API follows:
- * @li @ref tutorial_icon
+ * @param obj The object
+ * @ingroup Scrollhints
*/
+ EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @addtogroup Icon
- * @{
+ * @}
*/
- typedef enum _Elm_Icon_Type
- {
- ELM_ICON_NONE,
- ELM_ICON_FILE,
- ELM_ICON_STANDARD
- } Elm_Icon_Type;
/**
- * @enum _Elm_Icon_Lookup_Order
- * @typedef Elm_Icon_Lookup_Order
+ * Send a signal to the widget edje object.
*
- * Lookup order used by elm_icon_standard_set(). Should look for icons in the
- * theme, FDO paths, or both?
+ * This function sends a signal to the edje object of the obj. An
+ * edje program can respond to a signal by specifying matching
+ * 'signal' and 'source' fields.
*
- * @ingroup Icon
+ * @param obj The object
+ * @param emission The signal's name.
+ * @param source The signal's source.
+ * @ingroup General
*/
- typedef enum _Elm_Icon_Lookup_Order
- {
- ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
- ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
- ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
- ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
- } Elm_Icon_Lookup_Order;
+ EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
/**
- * Add a new icon object to the parent.
- *
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * Add a callback for a signal emitted by widget edje object.
*
- * @see elm_icon_file_set()
+ * This function connects a callback function to a signal emitted by the
+ * edje object of the obj.
+ * Globs can occur in either the emission or source name.
*
- * @ingroup Icon
+ * @param obj The object
+ * @param emission The signal's name.
+ * @param source The signal's source.
+ * @param func The callback function to be executed when the signal is
+ * emitted.
+ * @param data A pointer to data to pass in to the callback function.
+ * @ingroup General
*/
- EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
+
/**
- * Set the file that will be used as icon.
- *
- * @param obj The icon object
- * @param file The path to file that will be used as icon image
- * @param group The group that the icon belongs to in edje file
- *
- * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
- *
- * @note The icon image set by this function can be changed by
- * elm_icon_standard_set().
+ * Remove a signal-triggered callback from a widget edje object.
*
- * @see elm_icon_file_get()
+ * This function removes a callback, previoulsy attached to a
+ * signal emitted by the edje object of the obj. The parameters
+ * emission, source and func must match exactly those passed to a
+ * previous call to elm_object_signal_callback_add(). The data
+ * pointer that was passed to this call will be returned.
*
- * @ingroup Icon
+ * @param obj The object
+ * @param emission The signal's name.
+ * @param source The signal's source.
+ * @param func The callback function to be executed when the signal is
+ * emitted.
+ * @return The data pointer
+ * @ingroup General
*/
- EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
+ EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
+
/**
- * Set a location in memory to be used as an icon
- *
- * @param obj The icon object
- * @param img The binary data that will be used as an image
- * @param size The size of binary data @p img
- * @param format Optional format of @p img to pass to the image loader
- * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
+ * Add a callback for input events (key up, key down, mouse wheel)
+ * on a given Elementary widget
+ *
+ * @param obj The widget to add an event callback on
+ * @param func The callback function to be executed when the event
+ * happens
+ * @param data Data to pass in to @p func
+ *
+ * Every widget in an Elementary interface set to receive focus,
+ * with elm_object_focus_allow_set(), will propagate @b all of its
+ * key up, key down and mouse wheel input events up to its parent
+ * object, and so on. All of the focusable ones in this chain which
+ * had an event callback set, with this call, will be able to treat
+ * those events. There are two ways of making the propagation of
+ * these event upwards in the tree of widgets to @b cease:
+ * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
+ * the event was @b not processed, so the propagation will go on.
+ * - The @c event_info pointer passed to @p func will contain the
+ * event's structure and, if you OR its @c event_flags inner
+ * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
+ * one has already handled it, thus killing the event's
+ * propagation, too.
+ *
+ * @note Your event callback will be issued on those events taking
+ * place only if no other child widget of @obj has consumed the
+ * event already.
+ *
+ * @note Not to be confused with @c
+ * evas_object_event_callback_add(), which will add event callbacks
+ * per type on general Evas objects (no event propagation
+ * infrastructure taken in account).
+ *
+ * @note Not to be confused with @c
+ * elm_object_signal_callback_add(), which will add callbacks to @b
+ * signals coming from a widget's theme, not input events.
+ *
+ * @note Not to be confused with @c
+ * edje_object_signal_callback_add(), which does the same as
+ * elm_object_signal_callback_add(), but directly on an Edje
+ * object.
*
- * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
+ * @note Not to be confused with @c
+ * evas_object_smart_callback_add(), which adds callbacks to smart
+ * objects' <b>smart events</b>, and not input events.
*
- * @note The icon image set by this function can be changed by
- * elm_icon_standard_set().
+ * @see elm_object_event_callback_del()
*
- * @ingroup Icon
+ * @ingroup General
*/
- EAPI Eina_Bool elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key); EINA_ARG_NONNULL(1, 2);
+ EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
+
/**
- * Get the file that will be used as icon.
- *
- * @param obj The icon object
- * @param file The path to file that will be used as icon icon image
- * @param group The group that the icon belongs to in edje file
+ * Remove an event callback from a widget.
*
- * @see elm_icon_file_set()
+ * This function removes a callback, previoulsy attached to event emission
+ * by the @p obj.
+ * The parameters func and data must match exactly those passed to
+ * a previous call to elm_object_event_callback_add(). The data pointer that
+ * was passed to this call will be returned.
*
- * @ingroup Icon
+ * @param obj The object
+ * @param func The callback function to be executed when the event is
+ * emitted.
+ * @param data Data to pass in to the callback function.
+ * @return The data pointer
+ * @ingroup General
*/
- EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
- EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
+ EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
+
/**
- * Set the icon by icon standards names.
- *
- * @param obj The icon object
- * @param name The icon name
- *
- * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
- *
- * For example, freedesktop.org defines standard icon names such as "home",
- * "network", etc. There can be different icon sets to match those icon
- * keys. The @p name given as parameter is one of these "keys", and will be
- * used to look in the freedesktop.org paths and elementary theme. One can
- * change the lookup order with elm_icon_order_lookup_set().
+ * Adjust size of an element for finger usage.
*
- * If name is not found in any of the expected locations and it is the
- * absolute path of an image file, this image will be used.
+ * @param times_w How many fingers should fit horizontally
+ * @param w Pointer to the width size to adjust
+ * @param times_h How many fingers should fit vertically
+ * @param h Pointer to the height size to adjust
*
- * @note The icon image set by this function can be changed by
- * elm_icon_file_set().
+ * This takes width and height sizes (in pixels) as input and a
+ * size multiple (which is how many fingers you want to place
+ * within the area, being "finger" the size set by
+ * elm_finger_size_set()), and adjusts the size to be large enough
+ * to accommodate the resulting size -- if it doesn't already
+ * accommodate it. On return the @p w and @p h sizes pointed to by
+ * these parameters will be modified, on those conditions.
*
- * @see elm_icon_standard_get()
- * @see elm_icon_file_set()
+ * @note This is kind of a low level Elementary call, most useful
+ * on size evaluation times for widgets. An external user wouldn't
+ * be calling, most of the time.
*
- * @ingroup Icon
+ * @ingroup Fingers
*/
- EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
+ EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
+
/**
- * Get the icon name set by icon standard names.
- *
- * @param obj The icon object
- * @return The icon name
- *
- * If the icon image was set using elm_icon_file_set() instead of
- * elm_icon_standard_set(), then this function will return @c NULL.
- *
- * @see elm_icon_standard_set()
+ * Get the duration for occuring long press event.
*
- * @ingroup Icon
+ * @return Timeout for long press event
+ * @ingroup Longpress
*/
- EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI double elm_longpress_timeout_get(void);
+
/**
- * Set the smooth effect for an icon object.
- *
- * @param obj The icon object
- * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
- * otherwise. Default is @c EINA_TRUE.
- *
- * Set the scaling algorithm to be used when scaling the icon image. Smooth
- * scaling provides a better resulting image, but is slower.
+ * Set the duration for occuring long press event.
*
- * The smooth scaling should be disabled when making animations that change
- * the icon size, since they will be faster. Animations that don't require
- * resizing of the icon can keep the smooth scaling enabled (even if the icon
- * is already scaled, since the scaled icon image will be cached).
+ * @param lonpress_timeout Timeout for long press event
+ * @ingroup Longpress
+ */
+ EAPI void elm_longpress_timeout_set(double longpress_timeout);
+
+ /**
+ * @defgroup Debug Debug
+ * don't use it unless you are sure
*
- * @see elm_icon_smooth_get()
+ * @{
+ */
+
+ /**
+ * Print Tree object hierarchy in stdout
*
- * @ingroup Icon
+ * @param obj The root object
+ * @ingroup Debug
*/
- EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_tree_dump(const Evas_Object *top);
+
/**
- * Get the smooth effect for an icon object.
+ * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
*
- * @param obj The icon object
- * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
- *
- * @see elm_icon_smooth_set()
- *
- * @ingroup Icon
+ * @param obj The root object
+ * @param file The path of output file
+ * @ingroup Debug
*/
- EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
+
/**
- * Disable scaling of this object.
- *
- * @param obj The icon object.
- * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
- * otherwise. Default is @c EINA_FALSE.
- *
- * This function disables scaling of the icon object through the function
- * elm_object_scale_set(). However, this does not affect the object
- * size/resize in any way. For that effect, take a look at
- * elm_icon_scale_set().
- *
- * @see elm_icon_no_scale_get()
- * @see elm_icon_scale_set()
- * @see elm_object_scale_set()
- *
- * @ingroup Icon
+ * @}
*/
- EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
+
/**
- * Get whether scaling is disabled on the object.
+ * @defgroup Theme Theme
*
- * @param obj The icon object
- * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
+ * Elementary uses Edje to theme its widgets, naturally. But for the most
+ * part this is hidden behind a simpler interface that lets the user set
+ * extensions and choose the style of widgets in a much easier way.
*
- * @see elm_icon_no_scale_set()
+ * Instead of thinking in terms of paths to Edje files and their groups
+ * each time you want to change the appearance of a widget, Elementary
+ * works so you can add any theme file with extensions or replace the
+ * main theme at one point in the application, and then just set the style
+ * of widgets with elm_object_style_set() and related functions. Elementary
+ * will then look in its list of themes for a matching group and apply it,
+ * and when the theme changes midway through the application, all widgets
+ * will be updated accordingly.
*
- * @ingroup Icon
- */
- EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Set if the object is (up/down) resizeable.
+ * There are three concepts you need to know to understand how Elementary
+ * theming works: default theme, extensions and overlays.
*
- * @param obj The icon object
- * @param scale_up A bool to set if the object is resizeable up. Default is
- * @c EINA_TRUE.
- * @param scale_down A bool to set if the object is resizeable down. Default
- * is @c EINA_TRUE.
+ * Default theme, obviously enough, is the one that provides the default
+ * look of all widgets. End users can change the theme used by Elementary
+ * by setting the @c ELM_THEME environment variable before running an
+ * application, or globally for all programs using the @c elementary_config
+ * utility. Applications can change the default theme using elm_theme_set(),
+ * but this can go against the user wishes, so it's not an adviced practice.
*
- * This function limits the icon object resize ability. If @p scale_up is set to
- * @c EINA_FALSE, the object can't have its height or width resized to a value
- * higher than the original icon size. Same is valid for @p scale_down.
+ * Ideally, applications should find everything they need in the already
+ * provided theme, but there may be occasions when that's not enough and
+ * custom styles are required to correctly express the idea. For this
+ * cases, Elementary has extensions.
*
- * @see elm_icon_scale_get()
+ * Extensions allow the application developer to write styles of its own
+ * to apply to some widgets. This requires knowledge of how each widget
+ * is themed, as extensions will always replace the entire group used by
+ * the widget, so important signals and parts need to be there for the
+ * object to behave properly (see documentation of Edje for details).
+ * Once the theme for the extension is done, the application needs to add
+ * it to the list of themes Elementary will look into, using
+ * elm_theme_extension_add(), and set the style of the desired widgets as
+ * he would normally with elm_object_style_set().
*
- * @ingroup Icon
- */
- EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
- /**
- * Get if the object is (up/down) resizeable.
+ * Overlays, on the other hand, can replace the look of all widgets by
+ * overriding the default style. Like extensions, it's up to the application
+ * developer to write the theme for the widgets it wants, the difference
+ * being that when looking for the theme, Elementary will check first the
+ * list of overlays, then the set theme and lastly the list of extensions,
+ * so with overlays it's possible to replace the default view and every
+ * widget will be affected. This is very much alike to setting the whole
+ * theme for the application and will probably clash with the end user
+ * options, not to mention the risk of ending up with not matching styles
+ * across the program. Unless there's a very special reason to use them,
+ * overlays should be avoided for the resons exposed before.
*
- * @param obj The icon object
- * @param scale_up A bool to set if the object is resizeable up
- * @param scale_down A bool to set if the object is resizeable down
+ * All these theme lists are handled by ::Elm_Theme instances. Elementary
+ * keeps one default internally and every function that receives one of
+ * these can be called with NULL to refer to this default (except for
+ * elm_theme_free()). It's possible to create a new instance of a
+ * ::Elm_Theme to set other theme for a specific widget (and all of its
+ * children), but this is as discouraged, if not even more so, than using
+ * overlays. Don't use this unless you really know what you are doing.
*
- * @see elm_icon_scale_set()
+ * But to be less negative about things, you can look at the following
+ * examples:
+ * @li @ref theme_example_01 "Using extensions"
+ * @li @ref theme_example_02 "Using overlays"
*
- * @ingroup Icon
+ * @{
*/
- EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
/**
- * Get the object's image size
+ * @typedef Elm_Theme
*
- * @param obj The icon object
- * @param w A pointer to store the width in
- * @param h A pointer to store the height in
+ * Opaque handler for the list of themes Elementary looks for when
+ * rendering widgets.
*
- * @ingroup Icon
+ * Stay out of this unless you really know what you are doing. For most
+ * cases, sticking to the default is all a developer needs.
*/
- EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
+ typedef struct _Elm_Theme Elm_Theme;
+
/**
- * Set if the icon fill the entire object area.
- *
- * @param obj The icon object
- * @param fill_outside @c EINA_TRUE if the object is filled outside,
- * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
- *
- * When the icon object is resized to a different aspect ratio from the
- * original icon image, the icon image will still keep its aspect. This flag
- * tells how the image should fill the object's area. They are: keep the
- * entire icon inside the limits of height and width of the object (@p
- * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
- * of the object, and the icon will fill the entire object (@p fill_outside
- * is @c EINA_TRUE).
- *
- * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
- * retain property to false. Thus, the icon image will always keep its
- * original aspect ratio.
- *
- * @see elm_icon_fill_outside_get()
- * @see elm_image_fill_outside_set()
+ * Create a new specific theme
*
- * @ingroup Icon
+ * This creates an empty specific theme that only uses the default theme. A
+ * specific theme has its own private set of extensions and overlays too
+ * (which are empty by default). Specific themes do not fall back to themes
+ * of parent objects. They are not intended for this use. Use styles, overlays
+ * and extensions when needed, but avoid specific themes unless there is no
+ * other way (example: you want to have a preview of a new theme you are
+ * selecting in a "theme selector" window. The preview is inside a scroller
+ * and should display what the theme you selected will look like, but not
+ * actually apply it yet. The child of the scroller will have a specific
+ * theme set to show this preview before the user decides to apply it to all
+ * applications).
*/
- EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
+ EAPI Elm_Theme *elm_theme_new(void);
/**
- * Get if the object is filled outside.
- *
- * @param obj The icon object
- * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
+ * Free a specific theme
*
- * @see elm_icon_fill_outside_set()
+ * @param th The theme to free
*
- * @ingroup Icon
+ * This frees a theme created with elm_theme_new().
*/
- EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_theme_free(Elm_Theme *th);
/**
- * Set the prescale size for the icon.
+ * Copy the theme fom the source to the destination theme
*
- * @param obj The icon object
- * @param size The prescale size. This value is used for both width and
- * height.
+ * @param th The source theme to copy from
+ * @param thdst The destination theme to copy data to
*
- * This function sets a new size for pixmap representation of the given
- * icon. It allows the icon to be loaded already in the specified size,
- * reducing the memory usage and load time when loading a big icon with load
- * size set to a smaller size.
+ * This makes a one-time static copy of all the theme config, extensions
+ * and overlays from @p th to @p thdst. If @p th references a theme, then
+ * @p thdst is also set to reference it, with all the theme settings,
+ * overlays and extensions that @p th had.
+ */
+ EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
+ /**
+ * Tell the source theme to reference the ref theme
*
- * It's equivalent to the elm_bg_load_size_set() function for bg.
+ * @param th The theme that will do the referencing
+ * @param thref The theme that is the reference source
*
- * @note this is just a hint, the real size of the pixmap may differ
- * depending on the type of icon being loaded, being bigger than requested.
+ * This clears @p th to be empty and then sets it to refer to @p thref
+ * so @p th acts as an override to @p thref, but where its overrides
+ * don't apply, it will fall through to @p thref for configuration.
+ */
+ EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
+ /**
+ * Return the theme referred to
*
- * @see elm_icon_prescale_get()
- * @see elm_bg_load_size_set()
+ * @param th The theme to get the reference from
+ * @return The referenced theme handle
*
- * @ingroup Icon
+ * This gets the theme set as the reference theme by elm_theme_ref_set().
+ * If no theme is set as a reference, NULL is returned.
*/
- EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
+ EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
/**
- * Get the prescale size for the icon.
- *
- * @param obj The icon object
- * @return The prescale size
+ * Return the default theme
*
- * @see elm_icon_prescale_set()
+ * @return The default theme handle
*
- * @ingroup Icon
+ * This returns the internal default theme setup handle that all widgets
+ * use implicitly unless a specific theme is set. This is also often use
+ * as a shorthand of NULL.
*/
- EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Elm_Theme *elm_theme_default_get(void);
/**
- * Sets the icon lookup order used by elm_icon_standard_set().
+ * Prepends a theme overlay to the list of overlays
*
- * @param obj The icon object
- * @param order The icon lookup order (can be one of
- * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
- * or ELM_ICON_LOOKUP_THEME)
+ * @param th The theme to add to, or if NULL, the default theme
+ * @param item The Edje file path to be used
*
- * @see elm_icon_order_lookup_get()
- * @see Elm_Icon_Lookup_Order
+ * Use this if your application needs to provide some custom overlay theme
+ * (An Edje file that replaces some default styles of widgets) where adding
+ * new styles, or changing system theme configuration is not possible. Do
+ * NOT use this instead of a proper system theme configuration. Use proper
+ * configuration files, profiles, environment variables etc. to set a theme
+ * so that the theme can be altered by simple confiugration by a user. Using
+ * this call to achieve that effect is abusing the API and will create lots
+ * of trouble.
*
- * @ingroup Icon
+ * @see elm_theme_extension_add()
*/
- EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
+ EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
/**
- * Gets the icon lookup order.
- *
- * @param obj The icon object
- * @return The icon lookup order
+ * Delete a theme overlay from the list of overlays
*
- * @see elm_icon_order_lookup_set()
- * @see Elm_Icon_Lookup_Order
+ * @param th The theme to delete from, or if NULL, the default theme
+ * @param item The name of the theme overlay
*
- * @ingroup Icon
+ * @see elm_theme_overlay_add()
*/
- EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
/**
- * @}
- */
-
- /**
- * @defgroup Image Image
- *
- * @image html img/widget/image/preview-00.png
- * @image latex img/widget/image/preview-00.eps
- *
- * An object that allows one to load an image file to it. It can be used
- * anywhere like any other elementary widget.
- *
- * This widget provides most of the functionality provided from @ref Bg or @ref
- * Icon, but with a slightly different API (use the one that fits better your
- * needs).
- *
- * The features not provided by those two other image widgets are:
- * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
- * @li change the object orientation with elm_image_orient_set();
- * @li and turning the image editable with elm_image_editable_set().
+ * Appends a theme extension to the list of extensions.
*
- * Signals that you can add callbacks for are:
+ * @param th The theme to add to, or if NULL, the default theme
+ * @param item The Edje file path to be used
*
- * @li @c "clicked" - This is called when a user has clicked the image
+ * This is intended when an application needs more styles of widgets or new
+ * widget themes that the default does not provide (or may not provide). The
+ * application has "extended" usage by coming up with new custom style names
+ * for widgets for specific uses, but as these are not "standard", they are
+ * not guaranteed to be provided by a default theme. This means the
+ * application is required to provide these extra elements itself in specific
+ * Edje files. This call adds one of those Edje files to the theme search
+ * path to be search after the default theme. The use of this call is
+ * encouraged when default styles do not meet the needs of the application.
+ * Use this call instead of elm_theme_overlay_add() for almost all cases.
*
- * An example of usage for this API follows:
- * @li @ref tutorial_image
- */
-
- /**
- * @addtogroup Image
- * @{
+ * @see elm_object_style_set()
*/
-
+ EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
/**
- * @enum _Elm_Image_Orient
- * @typedef Elm_Image_Orient
- *
- * Possible orientation options for elm_image_orient_set().
+ * Deletes a theme extension from the list of extensions.
*
- * @image html elm_image_orient_set.png
- * @image latex elm_image_orient_set.eps width=\textwidth
+ * @param th The theme to delete from, or if NULL, the default theme
+ * @param item The name of the theme extension
*
- * @ingroup Image
+ * @see elm_theme_extension_add()
*/
- typedef enum _Elm_Image_Orient
- {
- ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
- ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
- ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
- ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
- ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
- ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
- ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
- ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
- } Elm_Image_Orient;
-
+ EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
/**
- * Add a new image to the parent.
- *
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
- *
- * @see elm_image_file_set()
+ * Set the theme search order for the given theme
*
- * @ingroup Image
- */
- EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
- /**
- * Set the file that will be used as image.
+ * @param th The theme to set the search order, or if NULL, the default theme
+ * @param theme Theme search string
*
- * @param obj The image object
- * @param file The path to file that will be used as image
- * @param group The group that the image belongs in edje file (if it's an
- * edje image)
+ * This sets the search string for the theme in path-notation from first
+ * theme to search, to last, delimited by the : character. Example:
*
- * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
+ * "shiny:/path/to/file.edj:default"
*
- * @see elm_image_file_get()
+ * See the ELM_THEME environment variable for more information.
*
- * @ingroup Image
+ * @see elm_theme_get()
+ * @see elm_theme_list_get()
*/
- EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
+ EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
/**
- * Get the file that will be used as image.
+ * Return the theme search order
*
- * @param obj The image object
- * @param file The path to file
- * @param group The group that the image belongs in edje file
+ * @param th The theme to get the search order, or if NULL, the default theme
+ * @return The internal search order path
*
- * @see elm_image_file_set()
+ * This function returns a colon separated string of theme elements as
+ * returned by elm_theme_list_get().
*
- * @ingroup Image
+ * @see elm_theme_set()
+ * @see elm_theme_list_get()
*/
- EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_theme_get(Elm_Theme *th);
/**
- * Set the smooth effect for an image.
- *
- * @param obj The image object
- * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
- * otherwise. Default is @c EINA_TRUE.
+ * Return a list of theme elements to be used in a theme.
*
- * Set the scaling algorithm to be used when scaling the image. Smooth
- * scaling provides a better resulting image, but is slower.
+ * @param th Theme to get the list of theme elements from.
+ * @return The internal list of theme elements
*
- * The smooth scaling should be disabled when making animations that change
- * the image size, since it will be faster. Animations that don't require
- * resizing of the image can keep the smooth scaling enabled (even if the
- * image is already scaled, since the scaled image will be cached).
+ * This returns the internal list of theme elements (will only be valid as
+ * long as the theme is not modified by elm_theme_set() or theme is not
+ * freed by elm_theme_free(). This is a list of strings which must not be
+ * altered as they are also internal. If @p th is NULL, then the default
+ * theme element list is returned.
*
- * @see elm_image_smooth_get()
+ * A theme element can consist of a full or relative path to a .edj file,
+ * or a name, without extension, for a theme to be searched in the known
+ * theme paths for Elemementary.
*
- * @ingroup Image
+ * @see elm_theme_set()
+ * @see elm_theme_get()
*/
- EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
+ EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
/**
- * Get the smooth effect for an image.
- *
- * @param obj The image object
- * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
+ * Return the full patrh for a theme element
*
- * @see elm_image_smooth_get()
+ * @param f The theme element name
+ * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
+ * @return The full path to the file found.
*
- * @ingroup Image
+ * This returns a string you should free with free() on success, NULL on
+ * failure. This will search for the given theme element, and if it is a
+ * full or relative path element or a simple searchable name. The returned
+ * path is the full path to the file, if searched, and the file exists, or it
+ * is simply the full path given in the element or a resolved path if
+ * relative to home. The @p in_search_path boolean pointed to is set to
+ * EINA_TRUE if the file was a searchable file andis in the search path,
+ * and EINA_FALSE otherwise.
*/
- EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
/**
- * Gets the current size of the image.
- *
- * @param obj The image object.
- * @param w Pointer to store width, or NULL.
- * @param h Pointer to store height, or NULL.
+ * Flush the current theme.
*
- * This is the real size of the image, not the size of the object.
+ * @param th Theme to flush
*
- * On error, neither w or h will be written.
+ * This flushes caches that let elementary know where to find theme elements
+ * in the given theme. If @p th is NULL, then the default theme is flushed.
+ * Call this function if source theme data has changed in such a way as to
+ * make any caches Elementary kept invalid.
+ */
+ EAPI void elm_theme_flush(Elm_Theme *th);
+ /**
+ * This flushes all themes (default and specific ones).
*
- * @ingroup Image
+ * This will flush all themes in the current application context, by calling
+ * elm_theme_flush() on each of them.
*/
- EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
+ EAPI void elm_theme_full_flush(void);
/**
- * Disable scaling of this object.
+ * Set the theme for all elementary using applications on the current display
*
- * @param obj The image object.
- * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
- * otherwise. Default is @c EINA_FALSE.
+ * @param theme The name of the theme to use. Format same as the ELM_THEME
+ * environment variable.
+ */
+ EAPI void elm_theme_all_set(const char *theme);
+ /**
+ * Return a list of theme elements in the theme search path
*
- * This function disables scaling of the elm_image widget through the
- * function elm_object_scale_set(). However, this does not affect the widget
- * size/resize in any way. For that effect, take a look at
- * elm_image_scale_set().
+ * @return A list of strings that are the theme element names.
*
- * @see elm_image_no_scale_get()
- * @see elm_image_scale_set()
- * @see elm_object_scale_set()
+ * This lists all available theme files in the standard Elementary search path
+ * for theme elements, and returns them in alphabetical order as theme
+ * element names in a list of strings. Free this with
+ * elm_theme_name_available_list_free() when you are done with the list.
+ */
+ EAPI Eina_List *elm_theme_name_available_list_new(void);
+ /**
+ * Free the list returned by elm_theme_name_available_list_new()
*
- * @ingroup Image
+ * This frees the list of themes returned by
+ * elm_theme_name_available_list_new(). Once freed the list should no longer
+ * be used. a new list mys be created.
*/
- EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
+ EAPI void elm_theme_name_available_list_free(Eina_List *list);
/**
- * Get whether scaling is disabled on the object.
+ * Set a specific theme to be used for this object and its children
*
- * @param obj The image object
- * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
+ * @param obj The object to set the theme on
+ * @param th The theme to set
*
- * @see elm_image_no_scale_set()
+ * This sets a specific theme that will be used for the given object and any
+ * child objects it has. If @p th is NULL then the theme to be used is
+ * cleared and the object will inherit its theme from its parent (which
+ * ultimately will use the default theme if no specific themes are set).
*
- * @ingroup Image
+ * Use special themes with great care as this will annoy users and make
+ * configuration difficult. Avoid any custom themes at all if it can be
+ * helped.
*/
- EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
/**
- * Set if the object is (up/down) resizeable.
- *
- * @param obj The image object
- * @param scale_up A bool to set if the object is resizeable up. Default is
- * @c EINA_TRUE.
- * @param scale_down A bool to set if the object is resizeable down. Default
- * is @c EINA_TRUE.
- *
- * This function limits the image resize ability. If @p scale_up is set to
- * @c EINA_FALSE, the object can't have its height or width resized to a value
- * higher than the original image size. Same is valid for @p scale_down.
+ * Get the specific theme to be used
*
- * @see elm_image_scale_get()
+ * @param obj The object to get the specific theme from
+ * @return The specifc theme set.
*
- * @ingroup Image
+ * This will return a specific theme set, or NULL if no specific theme is
+ * set on that object. It will not return inherited themes from parents, only
+ * the specific theme set for that specific object. See elm_object_theme_set()
+ * for more information.
*/
- EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
+ EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get if the object is (up/down) resizeable.
- *
- * @param obj The image object
- * @param scale_up A bool to set if the object is resizeable up
- * @param scale_down A bool to set if the object is resizeable down
+ * Get a data item from a theme
*
- * @see elm_image_scale_set()
+ * @param th The theme, or NULL for default theme
+ * @param key The data key to search with
+ * @return The data value, or NULL on failure
*
- * @ingroup Image
+ * This function is used to return data items from edc in @p th, an overlay, or an extension.
+ * It works the same way as edje_file_data_get() except that the return is stringshared.
*/
- EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
/**
- * Set if the image fill the entire object area when keeping the aspect ratio.
- *
- * @param obj The image object
- * @param fill_outside @c EINA_TRUE if the object is filled outside,
- * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
- *
- * When the image should keep its aspect ratio even if resized to another
- * aspect ratio, there are two possibilities to resize it: keep the entire
- * image inside the limits of height and width of the object (@p fill_outside
- * is @c EINA_FALSE) or let the extra width or height go outside of the object,
- * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
- *
- * @note This option will have no effect if
- * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
+ * @}
+ */
+
+ /* win */
+ /** @defgroup Win Win
*
- * @see elm_image_fill_outside_get()
- * @see elm_image_aspect_ratio_retained_set()
+ * @image html img/widget/win/preview-00.png
+ * @image latex img/widget/win/preview-00.eps
*
- * @ingroup Image
- */
- EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
- /**
- * Get if the object is filled outside
+ * The window class of Elementary. Contains functions to manipulate
+ * windows. The Evas engine used to render the window contents is specified
+ * in the system or user elementary config files (whichever is found last),
+ * and can be overridden with the ELM_ENGINE environment variable for
+ * testing. Engines that may be supported (depending on Evas and Ecore-Evas
+ * compilation setup and modules actually installed at runtime) are (listed
+ * in order of best supported and most likely to be complete and work to
+ * lowest quality).
*
- * @param obj The image object
- * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
+ * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
+ * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
+ * rendering in X11)
+ * @li "shot:..." (Virtual screenshot renderer - renders to output file and
+ * exits)
+ * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
+ * rendering)
+ * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
+ * buffer)
+ * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
+ * rendering using SDL as the buffer)
+ * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
+ * GDI with software)
+ * @li "dfb", "directfb" (Rendering to a DirectFB window)
+ * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
+ * grayscale using dedicated 8bit software engine in X11)
+ * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
+ * X11 using 16bit software engine)
+ * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
+ * (Windows CE rendering via GDI with 16bit software renderer)
+ * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
+ * buffer with 16bit software renderer)
*
- * @see elm_image_fill_outside_set()
+ * All engines use a simple string to select the engine to render, EXCEPT
+ * the "shot" engine. This actually encodes the output of the virtual
+ * screenshot and how long to delay in the engine string. The engine string
+ * is encoded in the following way:
*
- * @ingroup Image
- */
- EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Set the prescale size for the image
+ * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
*
- * @param obj The image object
- * @param size The prescale size. This value is used for both width and
- * height.
+ * Where options are separated by a ":" char if more than one option is
+ * given, with delay, if provided being the first option and file the last
+ * (order is important). The delay specifies how long to wait after the
+ * window is shown before doing the virtual "in memory" rendering and then
+ * save the output to the file specified by the file option (and then exit).
+ * If no delay is given, the default is 0.5 seconds. If no file is given the
+ * default output file is "out.png". Repeat option is for continous
+ * capturing screenshots. Repeat range is from 1 to 999 and filename is
+ * fixed to "out001.png" Some examples of using the shot engine:
*
- * This function sets a new size for pixmap representation of the given
- * image. It allows the image to be loaded already in the specified size,
- * reducing the memory usage and load time when loading a big image with load
- * size set to a smaller size.
+ * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
+ * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
+ * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
+ * ELM_ENGINE="shot:delay=2.0" elementary_test
+ * ELM_ENGINE="shot:" elementary_test
*
- * It's equivalent to the elm_bg_load_size_set() function for bg.
+ * Signals that you can add callbacks for are:
*
- * @note this is just a hint, the real size of the pixmap may differ
- * depending on the type of image being loaded, being bigger than requested.
+ * @li "delete,request": the user requested to close the window. See
+ * elm_win_autodel_set().
+ * @li "focus,in": window got focus
+ * @li "focus,out": window lost focus
+ * @li "moved": window that holds the canvas was moved
*
- * @see elm_image_prescale_get()
- * @see elm_bg_load_size_set()
+ * Examples:
+ * @li @ref win_example_01
*
- * @ingroup Image
+ * @{
*/
- EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
/**
- * Get the prescale size for the image
- *
- * @param obj The image object
- * @return The prescale size
+ * Defines the types of window that can be created
*
- * @see elm_image_prescale_set()
+ * These are hints set on the window so that a running Window Manager knows
+ * how the window should be handled and/or what kind of decorations it
+ * should have.
*
- * @ingroup Image
+ * Currently, only the X11 backed engines use them.
*/
- EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Win_Type
+ {
+ ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
+ window. Almost every window will be created with this
+ type. */
+ ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
+ ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
+ window holding desktop icons. */
+ ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
+ be kept on top of any other window by the Window
+ Manager. */
+ ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
+ similar. */
+ ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
+ ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
+ pallete. */
+ ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
+ ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
+ entry in a menubar is clicked. Typically used
+ with elm_win_override_set(). This hint exists
+ for completion only, as the EFL way of
+ implementing a menu would not normally use a
+ separate window for its contents. */
+ ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
+ triggered by right-clicking an object. */
+ ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
+ explanatory text that typically appear after the
+ mouse cursor hovers over an object for a while.
+ Typically used with elm_win_override_set() and also
+ not very commonly used in the EFL. */
+ ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
+ battery life or a new E-Mail received. */
+ ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
+ usually used in the EFL. */
+ ELM_WIN_DND, /**< Used to indicate the window is a representation of an
+ object being dragged across different windows, or even
+ applications. Typically used with
+ elm_win_override_set(). */
+ ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
+ buffer. No actual window is created for this
+ type, instead the window and all of its
+ contents will be rendered to an image buffer.
+ This allows to have children window inside a
+ parent one just like any other object would
+ be, and do other things like applying @c
+ Evas_Map effects to it. This is the only type
+ of window that requires the @c parent
+ parameter of elm_win_add() to be a valid @c
+ Evas_Object. */
+ } Elm_Win_Type;
+
/**
- * Set the image orientation.
- *
- * @param obj The image object
- * @param orient The image orientation
- * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
- * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
- * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
- * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
- * Default is #ELM_IMAGE_ORIENT_NONE.
- *
- * This function allows to rotate or flip the given image.
- *
- * @see elm_image_orient_get()
- * @see @ref Elm_Image_Orient
+ * The differents layouts that can be requested for the virtual keyboard.
*
- * @ingroup Image
+ * When the application window is being managed by Illume, it may request
+ * any of the following layouts for the virtual keyboard.
*/
- EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Win_Keyboard_Mode
+ {
+ ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
+ ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
+ ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
+ ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
+ ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
+ ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
+ ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
+ ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
+ ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
+ ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
+ ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
+ ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
+ ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
+ ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
+ ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
+ ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
+ } Elm_Win_Keyboard_Mode;
+
/**
- * Get the image orientation.
- *
- * @param obj The image object
- * @return The image orientation
- * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
- * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
- * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
- * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
- *
- * @see elm_image_orient_set()
- * @see @ref Elm_Image_Orient
+ * Available commands that can be sent to the Illume manager.
*
- * @ingroup Image
+ * When running under an Illume session, a window may send commands to the
+ * Illume manager to perform different actions.
*/
- EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Illume_Command
+ {
+ ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
+ window */
+ ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
+ in the list */
+ ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
+ screen */
+ ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
+ } Elm_Illume_Command;
+
/**
- * Make the image 'editable'.
+ * Adds a window object. If this is the first window created, pass NULL as
+ * @p parent.
*
- * @param obj Image object.
- * @param set Turn on or off editability. Default is @c EINA_FALSE.
+ * @param parent Parent object to add the window to, or NULL
+ * @param name The name of the window
+ * @param type The window type, one of #Elm_Win_Type.
*
- * This means the image is a valid drag target for drag and drop, and can be
- * cut or pasted too.
+ * The @p parent paramter can be @c NULL for every window @p type except
+ * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
+ * which the image object will be created.
*
- * @ingroup Image
+ * @return The created object, or NULL on failure
*/
- EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
/**
- * Make the image 'editable'.
+ * Add @p subobj as a resize object of window @p obj.
*
- * @param obj Image object.
- * @return Editability.
*
- * This means the image is a valid drag target for drag and drop, and can be
- * cut or pasted too.
+ * Setting an object as a resize object of the window means that the
+ * @p subobj child's size and position will be controlled by the window
+ * directly. That is, the object will be resized to match the window size
+ * and should never be moved or resized manually by the developer.
*
- * @ingroup Image
- */
- EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Get the basic Evas_Image object from this object (widget).
+ * In addition, resize objects of the window control what the minimum size
+ * of it will be, as well as whether it can or not be resized by the user.
*
- * @param obj The image object to get the inlined image from
- * @return The inlined image object, or NULL if none exists
+ * For the end user to be able to resize a window by dragging the handles
+ * or borders provided by the Window Manager, or using any other similar
+ * mechanism, all of the resize objects in the window should have their
+ * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
*
- * This function allows one to get the underlying @c Evas_Object of type
- * Image from this elementary widget. It can be useful to do things like get
- * the pixel data, save the image to a file, etc.
+ * @param obj The window object
+ * @param subobj The resize object to add
+ */
+ EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+ /**
+ * Delete @p subobj as a resize object of window @p obj.
*
- * @note Be careful to not manipulate it, as it is under control of
- * elementary.
+ * This function removes the object @p subobj from the resize objects of
+ * the window @p obj. It will not delete the object itself, which will be
+ * left unmanaged and should be deleted by the developer, manually handled
+ * or set as child of some other container.
*
- * @ingroup Image
+ * @param obj The window object
+ * @param subobj The resize object to add
*/
- EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
/**
- * Set whether the original aspect ratio of the image should be kept on resize.
- *
- * @param obj The image object.
- * @param retained @c EINA_TRUE if the image should retain the aspect,
- * @c EINA_FALSE otherwise.
+ * Set the title of the window
*
- * The original aspect ratio (width / height) of the image is usually
- * distorted to match the object's size. Enabling this option will retain
- * this original aspect, and the way that the image is fit into the object's
- * area depends on the option set by elm_image_fill_outside_set().
+ * @param obj The window object
+ * @param title The title to set
+ */
+ EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
+ /**
+ * Get the title of the window
*
- * @see elm_image_aspect_ratio_retained_get()
- * @see elm_image_fill_outside_set()
+ * The returned string is an internal one and should not be freed or
+ * modified. It will also be rendered invalid if a new title is set or if
+ * the window is destroyed.
*
- * @ingroup Image
+ * @param obj The window object
+ * @return The title
*/
- EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get if the object retains the original aspect ratio.
+ * Set the window's autodel state.
*
- * @param obj The image object.
- * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
- * otherwise.
+ * When closing the window in any way outside of the program control, like
+ * pressing the X button in the titlebar or using a command from the
+ * Window Manager, a "delete,request" signal is emitted to indicate that
+ * this event occurred and the developer can take any action, which may
+ * include, or not, destroying the window object.
*
- * @ingroup Image
- */
- EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /* smart callbacks called:
- * "clicked" - the user clicked the image
+ * When the @p autodel parameter is set, the window will be automatically
+ * destroyed when this event occurs, after the signal is emitted.
+ * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
+ * and is up to the program to do so when it's required.
+ *
+ * @param obj The window object
+ * @param autodel If true, the window will automatically delete itself when
+ * closed
*/
-
+ EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
/**
- * @}
+ * Get the window's autodel state.
+ *
+ * @param obj The window object
+ * @return If the window will automatically delete itself when closed
+ *
+ * @see elm_win_autodel_set()
*/
-
- /* glview */
- typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
-
- typedef enum _Elm_GLView_Mode
- {
- ELM_GLVIEW_ALPHA = 1,
- ELM_GLVIEW_DEPTH = 2,
- ELM_GLVIEW_STENCIL = 4
- } Elm_GLView_Mode;
-
+ EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Defines a policy for the glview resizing.
+ * Activate a window object.
*
- * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
+ * This function sends a request to the Window Manager to activate the
+ * window pointed by @p obj. If honored by the WM, the window will receive
+ * the keyboard focus.
+ *
+ * @note This is just a request that a Window Manager may ignore, so calling
+ * this function does not ensure in any way that the window will be the
+ * active one after it.
+ *
+ * @param obj The window object
*/
- typedef enum _Elm_GLView_Resize_Policy
- {
- ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
- ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
- } Elm_GLView_Resize_Policy;
-
- typedef enum _Elm_GLView_Render_Policy
- {
- ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
- ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
- } Elm_GLView_Render_Policy;
-
-
- EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
- EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
- EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
- EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
- EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
- EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
- EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
- EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
- EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /* box */
+ EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @defgroup Box Box
+ * Lower a window object.
*
- * @image html img/widget/box/preview-00.png
- * @image latex img/widget/box/preview-00.eps width=\textwidth
+ * Places the window pointed by @p obj at the bottom of the stack, so that
+ * no other window is covered by it.
*
- * @image html img/box.png
- * @image latex img/box.eps width=\textwidth
+ * If elm_win_override_set() is not set, the Window Manager may ignore this
+ * request.
*
- * A box arranges objects in a linear fashion, governed by a layout function
- * that defines the details of this arrangement.
+ * @param obj The window object
+ */
+ EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Raise a window object.
*
- * By default, the box will use an internal function to set the layout to
- * a single row, either vertical or horizontal. This layout is affected
- * by a number of parameters, such as the homogeneous flag set by
- * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
- * elm_box_align_set() and the hints set to each object in the box.
+ * Places the window pointed by @p obj at the top of the stack, so that it's
+ * not covered by any other window.
*
- * For this default layout, it's possible to change the orientation with
- * elm_box_horizontal_set(). The box will start in the vertical orientation,
- * placing its elements ordered from top to bottom. When horizontal is set,
- * the order will go from left to right. If the box is set to be
- * homogeneous, every object in it will be assigned the same space, that
- * of the largest object. Padding can be used to set some spacing between
- * the cell given to each object. The alignment of the box, set with
- * elm_box_align_set(), determines how the bounding box of all the elements
- * will be placed within the space given to the box widget itself.
+ * If elm_win_override_set() is not set, the Window Manager may ignore this
+ * request.
*
- * The size hints of each object also affect how they are placed and sized
- * within the box. evas_object_size_hint_min_set() will give the minimum
- * size the object can have, and the box will use it as the basis for all
- * latter calculations. Elementary widgets set their own minimum size as
- * needed, so there's rarely any need to use it manually.
+ * @param obj The window object
+ */
+ EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the borderless state of a window.
*
- * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
- * used to tell whether the object will be allocated the minimum size it
- * needs or if the space given to it should be expanded. It's important
- * to realize that expanding the size given to the object is not the same
- * thing as resizing the object. It could very well end being a small
- * widget floating in a much larger empty space. If not set, the weight
- * for objects will normally be 0.0 for both axis, meaning the widget will
- * not be expanded. To take as much space possible, set the weight to
- * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
+ * This function requests the Window Manager to not draw any decoration
+ * around the window.
*
- * Besides how much space each object is allocated, it's possible to control
- * how the widget will be placed within that space using
- * evas_object_size_hint_align_set(). By default, this value will be 0.5
- * for both axis, meaning the object will be centered, but any value from
- * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
- * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
- * is -1.0, means the object will be resized to fill the entire space it
- * was allocated.
+ * @param obj The window object
+ * @param borderless If true, the window is borderless
+ */
+ EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
+ /**
+ * Get the borderless state of a window.
*
- * In addition, customized functions to define the layout can be set, which
- * allow the application developer to organize the objects within the box
- * in any number of ways.
+ * @param obj The window object
+ * @return If true, the window is borderless
+ */
+ EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the shaped state of a window.
*
- * The special elm_box_layout_transition() function can be used
- * to switch from one layout to another, animating the motion of the
- * children of the box.
+ * Shaped windows, when supported, will render the parts of the window that
+ * has no content, transparent.
*
- * @note Objects should not be added to box objects using _add() calls.
+ * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
+ * background object or cover the entire window in any other way, or the
+ * parts of the canvas that have no data will show framebuffer artifacts.
*
- * Some examples on how to use boxes follow:
- * @li @ref box_example_01
- * @li @ref box_example_02
+ * @param obj The window object
+ * @param shaped If true, the window is shaped
*
- * @{
+ * @see elm_win_alpha_set()
*/
+ EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
/**
- * @typedef Elm_Box_Transition
+ * Get the shaped state of a window.
*
- * Opaque handler containing the parameters to perform an animated
- * transition of the layout the box uses.
+ * @param obj The window object
+ * @return If true, the window is shaped
*
- * @see elm_box_transition_new()
- * @see elm_box_layout_set()
- * @see elm_box_layout_transition()
+ * @see elm_win_shaped_set()
*/
- typedef struct _Elm_Box_Transition Elm_Box_Transition;
-
- /**
- * Add a new box to the parent
- *
- * By default, the box will be in vertical mode and non-homogeneous.
- *
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
- */
- EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the horizontal orientation
+ * Set the alpha channel state of a window.
*
- * By default, box object arranges their contents vertically from top to
- * bottom.
- * By calling this function with @p horizontal as EINA_TRUE, the box will
- * become horizontal, arranging contents from left to right.
+ * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
+ * possibly making parts of the window completely or partially transparent.
+ * This is also subject to the underlying system supporting it, like for
+ * example, running under a compositing manager. If no compositing is
+ * available, enabling this option will instead fallback to using shaped
+ * windows, with elm_win_shaped_set().
*
- * @note This flag is ignored if a custom layout function is set.
+ * @param obj The window object
+ * @param alpha If true, the window has an alpha channel
*
- * @param obj The box object
- * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
- * EINA_FALSE = vertical)
+ * @see elm_win_alpha_set()
*/
- EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
/**
- * Get the horizontal orientation
+ * Get the transparency state of a window.
*
- * @param obj The box object
- * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
+ * @param obj The window object
+ * @return If true, the window is transparent
+ *
+ * @see elm_win_transparent_set()
*/
- EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the box to arrange its children homogeneously
+ * Set the transparency state of a window.
*
- * If enabled, homogeneous layout makes all items the same size, according
- * to the size of the largest of its children.
+ * Use elm_win_alpha_set() instead.
*
- * @note This flag is ignored if a custom layout function is set.
+ * @param obj The window object
+ * @param transparent If true, the window is transparent
*
- * @param obj The box object
- * @param homogeneous The homogeneous flag
+ * @see elm_win_alpha_set()
*/
- EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
/**
- * Get whether the box is using homogeneous mode or not
+ * Get the alpha channel state of a window.
*
- * @param obj The box object
- * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
+ * @param obj The window object
+ * @return If true, the window has an alpha channel
*/
- EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
- EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Add an object to the beginning of the pack list
+ * Set the override state of a window.
*
- * Pack @p subobj into the box @p obj, placing it first in the list of
- * children objects. The actual position the object will get on screen
- * depends on the layout used. If no custom layout is set, it will be at
- * the top or left, depending if the box is vertical or horizontal,
- * respectively.
+ * A window with @p override set to EINA_TRUE will not be managed by the
+ * Window Manager. This means that no decorations of any kind will be shown
+ * for it, moving and resizing must be handled by the application, as well
+ * as the window visibility.
*
- * @param obj The box object
- * @param subobj The object to add to the box
+ * This should not be used for normal windows, and even for not so normal
+ * ones, it should only be used when there's a good reason and with a lot
+ * of care. Mishandling override windows may result situations that
+ * disrupt the normal workflow of the end user.
*
- * @see elm_box_pack_end()
- * @see elm_box_pack_before()
- * @see elm_box_pack_after()
- * @see elm_box_unpack()
- * @see elm_box_unpack_all()
- * @see elm_box_clear()
+ * @param obj The window object
+ * @param override If true, the window is overridden
*/
- EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
/**
- * Add an object at the end of the pack list
- *
- * Pack @p subobj into the box @p obj, placing it last in the list of
- * children objects. The actual position the object will get on screen
- * depends on the layout used. If no custom layout is set, it will be at
- * the bottom or right, depending if the box is vertical or horizontal,
- * respectively.
+ * Get the override state of a window.
*
- * @param obj The box object
- * @param subobj The object to add to the box
+ * @param obj The window object
+ * @return If true, the window is overridden
*
- * @see elm_box_pack_start()
- * @see elm_box_pack_before()
- * @see elm_box_pack_after()
- * @see elm_box_unpack()
- * @see elm_box_unpack_all()
- * @see elm_box_clear()
+ * @see elm_win_override_set()
*/
- EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Adds an object to the box before the indicated object
- *
- * This will add the @p subobj to the box indicated before the object
- * indicated with @p before. If @p before is not already in the box, results
- * are undefined. Before means either to the left of the indicated object or
- * above it depending on orientation.
- *
- * @param obj The box object
- * @param subobj The object to add to the box
- * @param before The object before which to add it
+ * Set the fullscreen state of a window.
*
- * @see elm_box_pack_start()
- * @see elm_box_pack_end()
- * @see elm_box_pack_after()
- * @see elm_box_unpack()
- * @see elm_box_unpack_all()
- * @see elm_box_clear()
+ * @param obj The window object
+ * @param fullscreen If true, the window is fullscreen
*/
- EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
/**
- * Adds an object to the box after the indicated object
- *
- * This will add the @p subobj to the box indicated after the object
- * indicated with @p after. If @p after is not already in the box, results
- * are undefined. After means either to the right of the indicated object or
- * below it depending on orientation.
+ * Get the fullscreen state of a window.
*
- * @param obj The box object
- * @param subobj The object to add to the box
- * @param after The object after which to add it
+ * @param obj The window object
+ * @return If true, the window is fullscreen
+ */
+ EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the maximized state of a window.
*
- * @see elm_box_pack_start()
- * @see elm_box_pack_end()
- * @see elm_box_pack_before()
- * @see elm_box_unpack()
- * @see elm_box_unpack_all()
- * @see elm_box_clear()
+ * @param obj The window object
+ * @param maximized If true, the window is maximized
*/
- EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
/**
- * Clear the box of all children
+ * Get the maximized state of a window.
*
- * Remove all the elements contained by the box, deleting the respective
- * objects.
+ * @param obj The window object
+ * @return If true, the window is maximized
+ */
+ EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the iconified state of a window.
*
- * @param obj The box object
+ * @param obj The window object
+ * @param iconified If true, the window is iconified
+ */
+ EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
+ /**
+ * Get the iconified state of a window.
*
- * @see elm_box_unpack()
- * @see elm_box_unpack_all()
+ * @param obj The window object
+ * @return If true, the window is iconified
*/
- EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Unpack a box item
+ * Set the layer of the window.
*
- * Remove the object given by @p subobj from the box @p obj without
- * deleting it.
+ * What this means exactly will depend on the underlying engine used.
*
- * @param obj The box object
+ * In the case of X11 backed engines, the value in @p layer has the
+ * following meanings:
+ * @li < 3: The window will be placed below all others.
+ * @li > 5: The window will be placed above all others.
+ * @li other: The window will be placed in the default layer.
*
- * @see elm_box_unpack_all()
- * @see elm_box_clear()
+ * @param obj The window object
+ * @param layer The layer of the window
*/
- EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
/**
- * Remove all items from the box, without deleting them
- *
- * Clear the box from all children, but don't delete the respective objects.
- * If no other references of the box children exist, the objects will never
- * be deleted, and thus the application will leak the memory. Make sure
- * when using this function that you hold a reference to all the objects
- * in the box @p obj.
+ * Get the layer of the window.
*
- * @param obj The box object
+ * @param obj The window object
+ * @return The layer of the window
*
- * @see elm_box_clear()
- * @see elm_box_unpack()
+ * @see elm_win_layer_set()
*/
- EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Retrieve a list of the objects packed into the box
+ * Set the rotation of the window.
*
- * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
- * The order of the list corresponds to the packing order the box uses.
+ * Most engines only work with multiples of 90.
*
- * You must free this list with eina_list_free() once you are done with it.
+ * This function is used to set the orientation of the window @p obj to
+ * match that of the screen. The window itself will be resized to adjust
+ * to the new geometry of its contents. If you want to keep the window size,
+ * see elm_win_rotation_with_resize_set().
*
- * @param obj The box object
+ * @param obj The window object
+ * @param rotation The rotation of the window, in degrees (0-360),
+ * counter-clockwise.
*/
- EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
/**
- * Set the space (padding) between the box's elements.
+ * Rotates the window and resizes it.
*
- * Extra space in pixels that will be added between a box child and its
- * neighbors after its containing cell has been calculated. This padding
- * is set for all elements in the box, besides any possible padding that
- * individual elements may have through their size hints.
+ * Like elm_win_rotation_set(), but it also resizes the window's contents so
+ * that they fit inside the current window geometry.
*
- * @param obj The box object
- * @param horizontal The horizontal space between elements
- * @param vertical The vertical space between elements
+ * @param obj The window object
+ * @param layer The rotation of the window in degrees (0-360),
+ * counter-clockwise.
*/
- EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
/**
- * Get the space (padding) between the box's elements.
+ * Get the rotation of the window.
*
- * @param obj The box object
- * @param horizontal The horizontal space between elements
- * @param vertical The vertical space between elements
+ * @param obj The window object
+ * @return The rotation of the window in degrees (0-360)
*
- * @see elm_box_padding_set()
+ * @see elm_win_rotation_set()
+ * @see elm_win_rotation_with_resize_set()
*/
- EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
+ EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the alignment of the whole bouding box of contents.
+ * Set the sticky state of the window.
*
- * Sets how the bounding box containing all the elements of the box, after
- * their sizes and position has been calculated, will be aligned within
- * the space given for the whole box widget.
+ * Hints the Window Manager that the window in @p obj should be left fixed
+ * at its position even when the virtual desktop it's on moves or changes.
*
- * @param obj The box object
- * @param horizontal The horizontal alignment of elements
- * @param vertical The vertical alignment of elements
+ * @param obj The window object
+ * @param sticky If true, the window's sticky state is enabled
*/
- EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
/**
- * Get the alignment of the whole bouding box of contents.
+ * Get the sticky state of the window.
*
- * @param obj The box object
- * @param horizontal The horizontal alignment of elements
- * @param vertical The vertical alignment of elements
+ * @param obj The window object
+ * @return If true, the window's sticky state is enabled
*
- * @see elm_box_align_set()
+ * @see elm_win_sticky_set()
*/
- EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the layout defining function to be used by the box
- *
- * Whenever anything changes that requires the box in @p obj to recalculate
- * the size and position of its elements, the function @p cb will be called
- * to determine what the layout of the children will be.
- *
- * Once a custom function is set, everything about the children layout
- * is defined by it. The flags set by elm_box_horizontal_set() and
- * elm_box_homogeneous_set() no longer have any meaning, and the values
- * given by elm_box_padding_set() and elm_box_align_set() are up to this
- * layout function to decide if they are used and how. These last two
- * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
- * passed to @p cb. The @c Evas_Object the function receives is not the
- * Elementary widget, but the internal Evas Box it uses, so none of the
- * functions described here can be used on it.
- *
- * Any of the layout functions in @c Evas can be used here, as well as the
- * special elm_box_layout_transition().
- *
- * The final @p data argument received by @p cb is the same @p data passed
- * here, and the @p free_data function will be called to free it
- * whenever the box is destroyed or another layout function is set.
- *
- * Setting @p cb to NULL will revert back to the default layout function.
- *
- * @param obj The box object
- * @param cb The callback function used for layout
- * @param data Data that will be passed to layout function
- * @param free_data Function called to free @p data
+ * Set if this window is an illume conformant window
*
- * @see elm_box_layout_transition()
+ * @param obj The window object
+ * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
*/
- 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);
+ EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
/**
- * Special layout function that animates the transition from one layout to another
- *
- * Normally, when switching the layout function for a box, this will be
- * reflected immediately on screen on the next render, but it's also
- * possible to do this through an animated transition.
- *
- * This is done by creating an ::Elm_Box_Transition and setting the box
- * layout to this function.
- *
- * For example:
- * @code
- * Elm_Box_Transition *t = elm_box_transition_new(1.0,
- * evas_object_box_layout_vertical, // start
- * NULL, // data for initial layout
- * NULL, // free function for initial data
- * evas_object_box_layout_horizontal, // end
- * NULL, // data for final layout
- * NULL, // free function for final data
- * anim_end, // will be called when animation ends
- * NULL); // data for anim_end function\
- * elm_box_layout_set(box, elm_box_layout_transition, t,
- * elm_box_transition_free);
- * @endcode
- *
- * @note This function can only be used with elm_box_layout_set(). Calling
- * it directly will not have the expected results.
+ * Get if this window is an illume conformant window
*
- * @see elm_box_transition_new
- * @see elm_box_transition_free
- * @see elm_box_layout_set
+ * @param obj The window object
+ * @return A boolean if this window is illume conformant or not
*/
- EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
+ EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Create a new ::Elm_Box_Transition to animate the switch of layouts
- *
- * If you want to animate the change from one layout to another, you need
- * to set the layout function of the box to elm_box_layout_transition(),
- * passing as user data to it an instance of ::Elm_Box_Transition with the
- * necessary information to perform this animation. The free function to
- * set for the layout is elm_box_transition_free().
- *
- * The parameters to create an ::Elm_Box_Transition sum up to how long
- * will it be, in seconds, a layout function to describe the initial point,
- * another for the final position of the children and one function to be
- * called when the whole animation ends. This last function is useful to
- * set the definitive layout for the box, usually the same as the end
- * layout for the animation, but could be used to start another transition.
+ * Set a window to be an illume quickpanel window
*
- * @param start_layout The layout function that will be used to start the animation
- * @param start_layout_data The data to be passed the @p start_layout function
- * @param start_layout_free_data Function to free @p start_layout_data
- * @param end_layout The layout function that will be used to end the animation
- * @param end_layout_free_data The data to be passed the @p end_layout function
- * @param end_layout_free_data Function to free @p end_layout_data
- * @param transition_end_cb Callback function called when animation ends
- * @param transition_end_data Data to be passed to @p transition_end_cb
- * @return An instance of ::Elm_Box_Transition
+ * By default window objects are not quickpanel windows.
*
- * @see elm_box_transition_new
- * @see elm_box_layout_transition
+ * @param obj The window object
+ * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
*/
- 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);
+ EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
/**
- * Free a Elm_Box_Transition instance created with elm_box_transition_new().
- *
- * This function is mostly useful as the @c free_data parameter in
- * elm_box_layout_set() when elm_box_layout_transition().
- *
- * @param data The Elm_Box_Transition instance to be freed.
+ * Get if this window is a quickpanel or not
*
- * @see elm_box_transition_new
- * @see elm_box_layout_transition
+ * @param obj The window object
+ * @return A boolean if this window is a quickpanel or not
*/
- EAPI void elm_box_transition_free(void *data);
+ EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @}
+ * Set the major priority of a quickpanel window
+ *
+ * @param obj The window object
+ * @param priority The major priority for this quickpanel
*/
-
- /* button */
+ EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
/**
- * @defgroup Button Button
- *
- * @image html img/widget/button/preview-00.png
- * @image html img/widget/button/preview-01.png
- * @image html img/widget/button/preview-02.png
- *
- * This is a push-button. Press it and run some function. It can contain
- * a simple label and icon object and it also has an autorepeat feature.
- *
- * This widgets emits the following signals:
- * @li "clicked": the user clicked the button (press/release).
- * @li "repeated": the user pressed the button without releasing it.
- * @li "pressed": button was pressed.
- * @li "unpressed": button was released after being pressed.
- * In all three cases, the @c event parameter of the callback will be
- * @c NULL.
- *
- * Also, defined in the default theme, the button has the following styles
- * available:
- * @li default: a normal button.
- * @li anchor: Like default, but the button fades away when the mouse is not
- * over it, leaving only the text or icon.
- * @li hoversel_vertical: Internally used by @ref Hoversel to give a
- * continuous look across its options.
- * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
+ * Get the major priority of a quickpanel window
*
- * Follow through a complete example @ref button_example_01 "here".
- * @{
+ * @param obj The window object
+ * @return The major priority of this quickpanel
*/
+ EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Add a new button to the parent's canvas
+ * Set the minor priority of a quickpanel window
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @param obj The window object
+ * @param priority The minor priority for this quickpanel
*/
- EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
/**
- * Set the label used in the button
- *
- * The passed @p label can be NULL to clean any existing text in it and
- * leave the button as an icon only object.
+ * Get the minor priority of a quickpanel window
*
- * @param obj The button object
- * @param label The text will be written on the button
- * @deprecated use elm_object_text_set() instead.
+ * @param obj The window object
+ * @return The minor priority of this quickpanel
*/
- EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+ EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the label set for the button
- *
- * The string returned is an internal pointer and should not be freed or
- * altered. It will also become invalid when the button is destroyed.
- * The string returned, if not NULL, is a stringshare, so if you need to
- * keep it around even after the button is destroyed, you can use
- * eina_stringshare_ref().
+ * Set which zone this quickpanel should appear in
*
- * @param obj The button object
- * @return The text set to the label, or NULL if nothing is set
- * @deprecated use elm_object_text_set() instead.
+ * @param obj The window object
+ * @param zone The requested zone for this quickpanel
*/
- EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
/**
- * Set the icon used for the button
- *
- * Setting a new icon will delete any other that was previously set, making
- * any reference to them invalid. If you need to maintain the previous
- * object alive, unset it first with elm_button_icon_unset().
+ * Get which zone this quickpanel should appear in
*
- * @param obj The button object
- * @param icon The icon object for the button
+ * @param obj The window object
+ * @return The requested zone for this quickpanel
*/
- EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+ EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the icon used for the button
+ * Set the window to be skipped by keyboard focus
*
- * Return the icon object which is set for this widget. If the button is
- * destroyed or another icon is set, the returned object will be deleted
- * and any reference to it will be invalid.
+ * This sets the window to be skipped by normal keyboard input. This means
+ * a window manager will be asked to not focus this window as well as omit
+ * it from things like the taskbar, pager, "alt-tab" list etc. etc.
*
- * @param obj The button object
- * @return The icon object that is being used
+ * Call this and enable it on a window BEFORE you show it for the first time,
+ * otherwise it may have no effect.
*
- * @see elm_button_icon_unset()
+ * Use this for windows that have only output information or might only be
+ * interacted with by the mouse or fingers, and never for typing input.
+ * Be careful that this may have side-effects like making the window
+ * non-accessible in some cases unless the window is specially handled. Use
+ * this with care.
+ *
+ * @param obj The window object
+ * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
*/
- EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
/**
- * Remove the icon set without deleting it and return the object
+ * Send a command to the windowing environment
*
- * This function drops the reference the button holds of the icon object
- * and returns this last object. It is used in case you want to remove any
- * icon, or set another one, without deleting the actual object. The button
- * will be left without an icon set.
+ * This is intended to work in touchscreen or small screen device
+ * environments where there is a more simplistic window management policy in
+ * place. This uses the window object indicated to select which part of the
+ * environment to control (the part that this window lives in), and provides
+ * a command and an optional parameter structure (use NULL for this if not
+ * needed).
*
- * @param obj The button object
- * @return The icon object that was being used
+ * @param obj The window object that lives in the environment to control
+ * @param command The command to send
+ * @param params Optional parameters for the command
*/
- EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
/**
- * Turn on/off the autorepeat event generated when the button is kept pressed
- *
- * When off, no autorepeat is performed and buttons emit a normal @c clicked
- * signal when they are clicked.
+ * Get the inlined image object handle
*
- * When on, keeping a button pressed will continuously emit a @c repeated
- * signal until the button is released. The time it takes until it starts
- * emitting the signal is given by
- * elm_button_autorepeat_initial_timeout_set(), and the time between each
- * new emission by elm_button_autorepeat_gap_timeout_set().
+ * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
+ * then the window is in fact an evas image object inlined in the parent
+ * canvas. You can get this object (be careful to not manipulate it as it
+ * is under control of elementary), and use it to do things like get pixel
+ * data, save the image to a file, etc.
*
- * @param obj The button object
- * @param on A bool to turn on/off the event
+ * @param obj The window object to get the inlined image from
+ * @return The inlined image object, or NULL if none exists
*/
- EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
/**
- * Get whether the autorepeat feature is enabled
+ * Set the enabled status for the focus highlight in a window
*
- * @param obj The button object
- * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
+ * This function will enable or disable the focus highlight only for the
+ * given window, regardless of the global setting for it
*
- * @see elm_button_autorepeat_set()
+ * @param obj The window where to enable the highlight
+ * @param enabled The enabled value for the highlight
*/
- EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
/**
- * Set the initial timeout before the autorepeat event is generated
+ * Get the enabled value of the focus highlight for this window
*
- * Sets the timeout, in seconds, since the button is pressed until the
- * first @c repeated signal is emitted. If @p t is 0.0 or less, there
- * won't be any delay and the even will be fired the moment the button is
- * pressed.
+ * @param obj The window in which to check if the focus highlight is enabled
*
- * @param obj The button object
- * @param t Timeout in seconds
+ * @return EINA_TRUE if enabled, EINA_FALSE otherwise
+ */
+ EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the style for the focus highlight on this window
*
- * @see elm_button_autorepeat_set()
- * @see elm_button_autorepeat_gap_timeout_set()
+ * Sets the style to use for theming the highlight of focused objects on
+ * the given window. If @p style is NULL, the default will be used.
+ *
+ * @param obj The window where to set the style
+ * @param style The style to set
*/
- EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
/**
- * Get the initial timeout before the autorepeat event is generated
+ * Get the style set for the focus highlight object
*
- * @param obj The button object
- * @return Timeout in seconds
+ * Gets the style set for this windows highilght object, or NULL if none
+ * is set.
+ *
+ * @param obj The window to retrieve the highlights style from
+ *
+ * @return The style set or NULL if none was. Default is used in that case.
+ */
+ EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /*...
+ * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
+ * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
+ * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
+ * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
+ * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
+ * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
+ * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
+ *
+ * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
+ * (blank mouse, private mouse obj, defaultmouse)
*
- * @see elm_button_autorepeat_initial_timeout_set()
*/
- EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the interval between each generated autorepeat event
+ * Sets the keyboard mode of the window.
*
- * After the first @c repeated event is fired, all subsequent ones will
- * follow after a delay of @p t seconds for each.
+ * @param obj The window object
+ * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
+ */
+ EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
+ /**
+ * Gets the keyboard mode of the window.
*
- * @param obj The button object
- * @param t Interval in seconds
+ * @param obj The window object
+ * @return The mode, one of #Elm_Win_Keyboard_Mode
+ */
+ EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Sets whether the window is a keyboard.
*
- * @see elm_button_autorepeat_initial_timeout_set()
+ * @param obj The window object
+ * @param is_keyboard If true, the window is a virtual keyboard
*/
- EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
+ EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
/**
- * Get the interval between each generated autorepeat event
+ * Gets whether the window is a keyboard.
*
- * @param obj The button object
- * @return Interval in seconds
+ * @param obj The window object
+ * @return If the window is a virtual keyboard
*/
- EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the screen position of a window.
+ *
+ * @param obj The window object
+ * @param x The int to store the x coordinate to
+ * @param y The int to store the y coordinate to
+ */
+ EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
/**
* @}
*/
/**
- * @defgroup File_Selector_Button File Selector Button
- *
- * @image html img/widget/fileselector_button/preview-00.png
- * @image html img/widget/fileselector_button/preview-01.png
- * @image html img/widget/fileselector_button/preview-02.png
+ * @defgroup Inwin Inwin
*
- * This is a button that, when clicked, creates an Elementary
- * window (or inner window) <b> with a @ref Fileselector "file
- * selector widget" within</b>. When a file is chosen, the (inner)
- * window is closed and the button emits a signal having the
- * selected file as it's @c event_info.
+ * @image html img/widget/inwin/preview-00.png
+ * @image latex img/widget/inwin/preview-00.eps
+ * @image html img/widget/inwin/preview-01.png
+ * @image latex img/widget/inwin/preview-01.eps
+ * @image html img/widget/inwin/preview-02.png
+ * @image latex img/widget/inwin/preview-02.eps
*
- * This widget encapsulates operations on its internal file
- * selector on its own API. There is less control over its file
- * selector than that one would have instatiating one directly.
+ * An inwin is a window inside a window that is useful for a quick popup.
+ * It does not hover.
*
- * The following styles are available for this button:
- * @li @c "default"
- * @li @c "anchor"
- * @li @c "hoversel_vertical"
- * @li @c "hoversel_vertical_entry"
+ * It works by creating an object that will occupy the entire window, so it
+ * must be created using an @ref Win "elm_win" as parent only. The inwin
+ * object can be hidden or restacked below every other object if it's
+ * needed to show what's behind it without destroying it. If this is done,
+ * the elm_win_inwin_activate() function can be used to bring it back to
+ * full visibility again.
*
- * Smart callbacks one can register to:
- * - @c "file,chosen" - the user has selected a path, whose string
- * pointer comes as the @c event_info data (a stringshared
- * string)
+ * There are three styles available in the default theme. These are:
+ * @li default: The inwin is sized to take over most of the window it's
+ * placed in.
+ * @li minimal: The size of the inwin will be the minimum necessary to show
+ * its contents.
+ * @li minimal_vertical: Horizontally, the inwin takes as much space as
+ * possible, but it's sized vertically the most it needs to fit its\
+ * contents.
*
- * Here is an example on its usage:
- * @li @ref fileselector_button_example
+ * Some examples of Inwin can be found in the following:
+ * @li @ref inwin_example_01
*
- * @see @ref File_Selector_Entry for a similar widget.
* @{
*/
-
/**
- * Add a new file selector button widget to the given parent
- * Elementary (container) object
+ * Adds an inwin to the current window
+ *
+ * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
+ * Never call this function with anything other than the top-most window
+ * as its parameter, unless you are fond of undefined behavior.
+ *
+ * After creating the object, the widget will set itself as resize object
+ * for the window with elm_win_resize_object_add(), so when shown it will
+ * appear to cover almost the entire window (how much of it depends on its
+ * content and the style used). It must not be added into other container
+ * objects and it needs not be moved or resized manually.
*
* @param parent The parent object
- * @return a new file selector button widget handle or @c NULL, on
- * errors
+ * @return The new object or NULL if it cannot be created
*/
- EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
-
+ EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the label for a given file selector button widget
+ * Activates an inwin object, ensuring its visibility
*
- * @param obj The file selector button widget
- * @param label The text label to be displayed on @p obj
+ * This function will make sure that the inwin @p obj is completely visible
+ * by calling evas_object_show() and evas_object_raise() on it, to bring it
+ * to the front. It also sets the keyboard focus to it, which will be passed
+ * onto its content.
*
- * @deprecated use elm_object_text_set() instead.
+ * The object's theme will also receive the signal "elm,action,show" with
+ * source "elm".
+ *
+ * @param obj The inwin to activate
*/
- EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the label set for a given file selector button widget
+ * Set the content of an inwin object.
*
- * @param obj The file selector button widget
- * @return The button label
+ * Once the content object is set, a previously set one will be deleted.
+ * If you want to keep that old content object, use the
+ * elm_win_inwin_content_unset() function.
*
- * @deprecated use elm_object_text_set() instead.
+ * @param obj The inwin object
+ * @param content The object to set as content
*/
- EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
/**
- * Set the icon on a given file selector button widget
+ * Get the content of an inwin object.
*
- * @param obj The file selector button widget
- * @param icon The icon object for the button
+ * Return the content object which is set for this widget.
*
- * Once the icon object is set, a previously set one will be
- * deleted. If you want to keep the latter, use the
- * elm_fileselector_button_icon_unset() function.
+ * The returned object is valid as long as the inwin is still alive and no
+ * other content is set on it. Deleting the object will notify the inwin
+ * about it and this one will be left empty.
*
- * @see elm_fileselector_button_icon_get()
+ * If you need to remove an inwin's content to be reused somewhere else,
+ * see elm_win_inwin_content_unset().
+ *
+ * @param obj The inwin object
+ * @return The content that is being used
*/
- EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
-
+ EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the icon set for a given file selector button widget
+ * Unset the content of an inwin object.
*
- * @param obj The file selector button widget
- * @return The icon object currently set on @p obj or @c NULL, if
- * none is
+ * Unparent and return the content object which was set for this widget.
*
- * @see elm_fileselector_button_icon_set()
+ * @param obj The inwin object
+ * @return The content that was being used
*/
- EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @}
+ */
+ /* X specific calls - won't work on non-x engines (return 0) */
/**
- * Unset the icon used in a given file selector button widget
+ * Get the Ecore_X_Window of an Evas_Object
*
- * @param obj The file selector button widget
- * @return The icon object that was being used on @p obj or @c
- * NULL, on errors
+ * @param obj The object
*
- * Unparent and return the icon object which was set for this
- * widget.
+ * @return The Ecore_X_Window of @p obj
*
- * @see elm_fileselector_button_icon_set()
+ * @ingroup Win
+ */
+ EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /* smart callbacks called:
+ * "delete,request" - the user requested to delete the window
+ * "focus,in" - window got focus
+ * "focus,out" - window lost focus
+ * "moved" - window that holds the canvas was moved
*/
- EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the title for a given file selector button widget's window
+ * @defgroup Bg Bg
*
- * @param obj The file selector button widget
- * @param title The title string
+ * @image html img/widget/bg/preview-00.png
+ * @image latex img/widget/bg/preview-00.eps
*
- * This will change the window's title, when the file selector pops
- * out after a click on the button. Those windows have the default
- * (unlocalized) value of @c "Select a file" as titles.
+ * @brief Background object, used for setting a solid color, image or Edje
+ * group as background to a window or any container object.
*
- * @note It will only take any effect if the file selector
- * button widget is @b not under "inwin mode".
+ * The bg object is used for setting a solid background to a window or
+ * packing into any container object. It works just like an image, but has
+ * some properties useful to a background, like setting it to tiled,
+ * centered, scaled or stretched.
*
- * @see elm_fileselector_button_window_title_get()
+ * Here is some sample code using it:
+ * @li @ref bg_01_example_page
+ * @li @ref bg_02_example_page
+ * @li @ref bg_03_example_page
*/
- EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
+
+ /* bg */
+ typedef enum _Elm_Bg_Option
+ {
+ ELM_BG_OPTION_CENTER, /**< center the background */
+ ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
+ ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
+ ELM_BG_OPTION_TILE /**< tile background at its original size */
+ } Elm_Bg_Option;
/**
- * Get the title set for a given file selector button widget's
- * window
+ * Add a new background to the parent
*
- * @param obj The file selector button widget
- * @return Title of the file selector button's window
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
*
- * @see elm_fileselector_button_window_title_get() for more details
+ * @ingroup Bg
*/
- EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Set the size of a given file selector button widget's window,
- * holding the file selector itself.
+ * Set the file (image or edje) used for the background
*
- * @param obj The file selector button widget
- * @param width The window's width
- * @param height The window's height
+ * @param obj The bg object
+ * @param file The file path
+ * @param group Optional key (group in Edje) within the file
*
- * @note it will only take any effect if the file selector button
- * widget is @b not under "inwin mode". The default size for the
- * window (when applicable) is 400x400 pixels.
+ * This sets the image file used in the background object. The image (or edje)
+ * will be stretched (retaining aspect if its an image file) to completely fill
+ * the bg object. This may mean some parts are not visible.
*
- * @see elm_fileselector_button_window_size_get()
+ * @note Once the image of @p obj is set, a previously set one will be deleted,
+ * even if @p file is NULL.
+ *
+ * @ingroup Bg
*/
- EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
+ EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
/**
- * Get the size of a given file selector button widget's window,
- * holding the file selector itself.
- *
- * @param obj The file selector button widget
- * @param width Pointer into which to store the width value
- * @param height Pointer into which to store the height value
+ * Get the file (image or edje) used for the background
*
- * @note Use @c NULL pointers on the size values you're not
- * interested in: they'll be ignored by the function.
+ * @param obj The bg object
+ * @param file The file path
+ * @param group Optional key (group in Edje) within the file
*
- * @see elm_fileselector_button_window_size_set(), for more details
+ * @ingroup Bg
*/
- EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
+ EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
/**
- * Set the initial file system path for a given file selector
- * button widget
+ * Set the option used for the background image
*
- * @param obj The file selector button widget
- * @param path The path string
+ * @param obj The bg object
+ * @param option The desired background option (TILE, SCALE)
*
- * It must be a <b>directory</b> path, which will have the contents
- * displayed initially in the file selector's view, when invoked
- * from @p obj. The default initial path is the @c "HOME"
- * environment variable's value.
+ * This sets the option used for manipulating the display of the background
+ * image. The image can be tiled or scaled.
*
- * @see elm_fileselector_button_path_get()
+ * @ingroup Bg
*/
- EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
+ EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
/**
- * Get the initial file system path set for a given file selector
- * button widget
+ * Get the option used for the background image
*
- * @param obj The file selector button widget
- * @return path The path string
+ * @param obj The bg object
+ * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
*
- * @see elm_fileselector_button_path_set() for more details
+ * @ingroup Bg
*/
- EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Enable/disable a tree view in the given file selector button
- * widget's internal file selector
- *
- * @param obj The file selector button widget
- * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
- * disable
+ * Set the option used for the background color
*
- * This has the same effect as elm_fileselector_expandable_set(),
- * but now applied to a file selector button's internal file
- * selector.
+ * @param obj The bg object
+ * @param r
+ * @param g
+ * @param b
*
- * @note There's no way to put a file selector button's internal
- * file selector in "grid mode", as one may do with "pure" file
- * selectors.
+ * This sets the color used for the background rectangle. Its range goes
+ * from 0 to 255.
*
- * @see elm_fileselector_expandable_get()
+ * @ingroup Bg
*/
- EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
/**
- * Get whether tree view is enabled for the given file selector
- * button widget's internal file selector
+ * Get the option used for the background color
*
- * @param obj The file selector button widget
- * @return @c EINA_TRUE if @p obj widget's internal file selector
- * is in tree view, @c EINA_FALSE otherwise (and or errors)
+ * @param obj The bg object
+ * @param r
+ * @param g
+ * @param b
*
- * @see elm_fileselector_expandable_set() for more details
+ * @ingroup Bg
*/
- EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
/**
- * Set whether a given file selector button widget's internal file
- * selector is to display folders only or the directory contents,
- * as well.
+ * Set the overlay object used for the background object.
*
- * @param obj The file selector button widget
- * @param only @c EINA_TRUE to make @p obj widget's internal file
- * selector only display directories, @c EINA_FALSE to make files
- * to be displayed in it too
+ * @param obj The bg object
+ * @param overlay The overlay object
*
- * This has the same effect as elm_fileselector_folder_only_set(),
- * but now applied to a file selector button's internal file
- * selector.
+ * This provides a way for elm_bg to have an 'overlay' that will be on top
+ * of the bg. Once the over object is set, a previously set one will be
+ * deleted, even if you set the new one to NULL. If you want to keep that
+ * old content object, use the elm_bg_overlay_unset() function.
*
- * @see elm_fileselector_folder_only_get()
+ * @ingroup Bg
*/
- EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
- /**
- * Get whether a given file selector button widget's internal file
- * selector is displaying folders only or the directory contents,
- * as well.
- *
- * @param obj The file selector button widget
- * @return @c EINA_TRUE if @p obj widget's internal file
- * selector is only displaying directories, @c EINA_FALSE if files
- * are being displayed in it too (and on errors)
- *
- * @see elm_fileselector_button_folder_only_set() for more details
- */
- EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
/**
- * Enable/disable the file name entry box where the user can type
- * in a name for a file, in a given file selector button widget's
- * internal file selector.
+ * Get the overlay object used for the background object.
*
- * @param obj The file selector button widget
- * @param is_save @c EINA_TRUE to make @p obj widget's internal
- * file selector a "saving dialog", @c EINA_FALSE otherwise
+ * @param obj The bg object
+ * @return The content that is being used
*
- * This has the same effect as elm_fileselector_is_save_set(),
- * but now applied to a file selector button's internal file
- * selector.
+ * Return the content object which is set for this widget
*
- * @see elm_fileselector_is_save_get()
+ * @ingroup Bg
*/
- EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get whether the given file selector button widget's internal
- * file selector is in "saving dialog" mode
+ * Get the overlay object used for the background object.
*
- * @param obj The file selector button widget
- * @return @c EINA_TRUE, if @p obj widget's internal file selector
- * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
- * errors)
+ * @param obj The bg object
+ * @return The content that was being used
*
- * @see elm_fileselector_button_is_save_set() for more details
+ * Unparent and return the overlay object which was set for this widget
+ *
+ * @ingroup Bg
*/
- EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set whether a given file selector button widget's internal file
- * selector will raise an Elementary "inner window", instead of a
- * dedicated Elementary window. By default, it won't.
+ * Set the size of the pixmap representation of the image.
*
- * @param obj The file selector button widget
- * @param value @c EINA_TRUE to make it use an inner window, @c
- * EINA_TRUE to make it use a dedicated window
+ * This option just makes sense if an image is going to be set in the bg.
*
- * @see elm_win_inwin_add() for more information on inner windows
- * @see elm_fileselector_button_inwin_mode_get()
- */
- EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
-
- /**
- * Get whether a given file selector button widget's internal file
- * selector will raise an Elementary "inner window", instead of a
- * dedicated Elementary window.
+ * @param obj The bg object
+ * @param w The new width of the image pixmap representation.
+ * @param h The new height of the image pixmap representation.
*
- * @param obj The file selector button widget
- * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
- * if it will use a dedicated window
+ * This function sets a new size for pixmap representation of the given bg
+ * image. It allows the image to be loaded already in the specified size,
+ * reducing the memory usage and load time when loading a big image with load
+ * size set to a smaller size.
*
- * @see elm_fileselector_button_inwin_mode_set() for more details
+ * NOTE: this is just a hint, the real size of the pixmap may differ
+ * depending on the type of image being loaded, being bigger than requested.
+ *
+ * @ingroup Bg
*/
- EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /**
- * @}
+ EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
+ /* smart callbacks called:
*/
- /**
- * @defgroup File_Selector_Entry File Selector Entry
+ /**
+ * @defgroup Icon Icon
*
- * @image html img/widget/fileselector_entry/preview-00.png
- * @image latex img/widget/fileselector_entry/preview-00.eps
+ * @image html img/widget/icon/preview-00.png
+ * @image latex img/widget/icon/preview-00.eps
*
- * This is an entry made to be filled with or display a <b>file
- * system path string</b>. Besides the entry itself, the widget has
- * a @ref File_Selector_Button "file selector button" on its side,
- * which will raise an internal @ref Fileselector "file selector widget",
- * when clicked, for path selection aided by file system
- * navigation.
+ * An object that provides standard icon images (delete, edit, arrows, etc.)
+ * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
*
- * This file selector may appear in an Elementary window or in an
- * inner window. When a file is chosen from it, the (inner) window
- * is closed and the selected file's path string is exposed both as
- * an smart event and as the new text on the entry.
+ * The icon image requested can be in the elementary theme, or in the
+ * freedesktop.org paths. It's possible to set the order of preference from
+ * where the image will be used.
*
- * This widget encapsulates operations on its internal file
- * selector on its own API. There is less control over its file
- * selector than that one would have instatiating one directly.
+ * This API is very similar to @ref Image, but with ready to use images.
*
- * Smart callbacks one can register to:
- * - @c "changed" - The text within the entry was changed
- * - @c "activated" - The entry has had editing finished and
- * changes are to be "committed"
- * - @c "press" - The entry has been clicked
- * - @c "longpressed" - The entry has been clicked (and held) for a
- * couple seconds
- * - @c "clicked" - The entry has been clicked
- * - @c "clicked,double" - The entry has been double clicked
- * - @c "focused" - The entry has received focus
- * - @c "unfocused" - The entry has lost focus
- * - @c "selection,paste" - A paste action has occurred on the
- * entry
- * - @c "selection,copy" - A copy action has occurred on the entry
- * - @c "selection,cut" - A cut action has occurred on the entry
- * - @c "unpressed" - The file selector entry's button was released
- * after being pressed.
- * - @c "file,chosen" - The user has selected a path via the file
- * selector entry's internal file selector, whose string pointer
- * comes as the @c event_info data (a stringshared string)
+ * Default images provided by the theme are described below.
*
- * Here is an example on its usage:
- * @li @ref fileselector_entry_example
+ * The first list contains icons that were first intended to be used in
+ * toolbars, but can be used in many other places too:
+ * @li home
+ * @li close
+ * @li apps
+ * @li arrow_up
+ * @li arrow_down
+ * @li arrow_left
+ * @li arrow_right
+ * @li chat
+ * @li clock
+ * @li delete
+ * @li edit
+ * @li refresh
+ * @li folder
+ * @li file
*
- * @see @ref File_Selector_Button for a similar widget.
- * @{
- */
-
- /**
- * Add a new file selector entry widget to the given parent
- * Elementary (container) object
+ * Now some icons that were designed to be used in menus (but again, you can
+ * use them anywhere else):
+ * @li menu/home
+ * @li menu/close
+ * @li menu/apps
+ * @li menu/arrow_up
+ * @li menu/arrow_down
+ * @li menu/arrow_left
+ * @li menu/arrow_right
+ * @li menu/chat
+ * @li menu/clock
+ * @li menu/delete
+ * @li menu/edit
+ * @li menu/refresh
+ * @li menu/folder
+ * @li menu/file
*
- * @param parent The parent object
- * @return a new file selector entry widget handle or @c NULL, on
- * errors
+ * And here we have some media player specific icons:
+ * @li media_player/forward
+ * @li media_player/info
+ * @li media_player/next
+ * @li media_player/pause
+ * @li media_player/play
+ * @li media_player/prev
+ * @li media_player/rewind
+ * @li media_player/stop
+ *
+ * Signals that you can add callbacks for are:
+ *
+ * "clicked" - This is called when a user has clicked the icon
+ *
+ * An example of usage for this API follows:
+ * @li @ref tutorial_icon
*/
- EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Set the label for a given file selector entry widget's button
- *
- * @param obj The file selector entry widget
- * @param label The text label to be displayed on @p obj widget's
- * button
- *
- * @deprecated use elm_object_text_set() instead.
+ * @addtogroup Icon
+ * @{
*/
- EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Icon_Type
+ {
+ ELM_ICON_NONE,
+ ELM_ICON_FILE,
+ ELM_ICON_STANDARD
+ } Elm_Icon_Type;
/**
- * Get the label set for a given file selector entry widget's button
+ * @enum _Elm_Icon_Lookup_Order
+ * @typedef Elm_Icon_Lookup_Order
*
- * @param obj The file selector entry widget
- * @return The widget button's label
+ * Lookup order used by elm_icon_standard_set(). Should look for icons in the
+ * theme, FDO paths, or both?
*
- * @deprecated use elm_object_text_set() instead.
+ * @ingroup Icon
*/
- EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Icon_Lookup_Order
+ {
+ ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
+ ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
+ ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
+ ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
+ } Elm_Icon_Lookup_Order;
/**
- * Set the icon on a given file selector entry widget's button
+ * Add a new icon object to the parent.
*
- * @param obj The file selector entry widget
- * @param icon The icon object for the entry's button
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
*
- * Once the icon object is set, a previously set one will be
- * deleted. If you want to keep the latter, use the
- * elm_fileselector_entry_button_icon_unset() function.
+ * @see elm_icon_file_set()
*
- * @see elm_fileselector_entry_button_icon_get()
+ * @ingroup Icon
*/
- EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
-
+ EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Get the icon set for a given file selector entry widget's button
+ * Set the file that will be used as icon.
*
- * @param obj The file selector entry widget
- * @return The icon object currently set on @p obj widget's button
- * or @c NULL, if none is
+ * @param obj The icon object
+ * @param file The path to file that will be used as icon image
+ * @param group The group that the icon belongs to in edje file
*
- * @see elm_fileselector_entry_button_icon_set()
- */
- EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /**
- * Unset the icon used in a given file selector entry widget's
- * button
+ * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
*
- * @param obj The file selector entry widget
- * @return The icon object that was being used on @p obj widget's
- * button or @c NULL, on errors
+ * @note The icon image set by this function can be changed by
+ * elm_icon_standard_set().
*
- * Unparent and return the icon object which was set for this
- * widget's button.
+ * @see elm_icon_file_get()
*
- * @see elm_fileselector_entry_button_icon_set()
+ * @ingroup Icon
*/
- EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
/**
- * Set the title for a given file selector entry widget's window
+ * Set a location in memory to be used as an icon
*
- * @param obj The file selector entry widget
- * @param title The title string
+ * @param obj The icon object
+ * @param img The binary data that will be used as an image
+ * @param size The size of binary data @p img
+ * @param format Optional format of @p img to pass to the image loader
+ * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
*
- * This will change the window's title, when the file selector pops
- * out after a click on the entry's button. Those windows have the
- * default (unlocalized) value of @c "Select a file" as titles.
+ * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
*
- * @note It will only take any effect if the file selector
- * entry widget is @b not under "inwin mode".
+ * @note The icon image set by this function can be changed by
+ * elm_icon_standard_set().
*
- * @see elm_fileselector_entry_window_title_get()
+ * @ingroup Icon
*/
- EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_Bool elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key); EINA_ARG_NONNULL(1, 2);
/**
- * Get the title set for a given file selector entry widget's
- * window
+ * Get the file that will be used as icon.
*
- * @param obj The file selector entry widget
- * @return Title of the file selector entry's window
+ * @param obj The icon object
+ * @param file The path to file that will be used as icon icon image
+ * @param group The group that the icon belongs to in edje file
*
- * @see elm_fileselector_entry_window_title_get() for more details
+ * @see elm_icon_file_set()
+ *
+ * @ingroup Icon
*/
- EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
+ EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
/**
- * Set the size of a given file selector entry widget's window,
- * holding the file selector itself.
+ * Set the icon by icon standards names.
*
- * @param obj The file selector entry widget
- * @param width The window's width
- * @param height The window's height
+ * @param obj The icon object
+ * @param name The icon name
*
- * @note it will only take any effect if the file selector entry
- * widget is @b not under "inwin mode". The default size for the
- * window (when applicable) is 400x400 pixels.
+ * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
*
- * @see elm_fileselector_entry_window_size_get()
- */
- EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
-
- /**
- * Get the size of a given file selector entry widget's window,
- * holding the file selector itself.
+ * For example, freedesktop.org defines standard icon names such as "home",
+ * "network", etc. There can be different icon sets to match those icon
+ * keys. The @p name given as parameter is one of these "keys", and will be
+ * used to look in the freedesktop.org paths and elementary theme. One can
+ * change the lookup order with elm_icon_order_lookup_set().
*
- * @param obj The file selector entry widget
- * @param width Pointer into which to store the width value
- * @param height Pointer into which to store the height value
+ * If name is not found in any of the expected locations and it is the
+ * absolute path of an image file, this image will be used.
*
- * @note Use @c NULL pointers on the size values you're not
- * interested in: they'll be ignored by the function.
+ * @note The icon image set by this function can be changed by
+ * elm_icon_file_set().
*
- * @see elm_fileselector_entry_window_size_set(), for more details
+ * @see elm_icon_standard_get()
+ * @see elm_icon_file_set()
+ *
+ * @ingroup Icon
*/
- EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
/**
- * Set the initial file system path and the entry's path string for
- * a given file selector entry widget
- *
- * @param obj The file selector entry widget
- * @param path The path string
+ * Get the icon name set by icon standard names.
*
- * It must be a <b>directory</b> path, which will have the contents
- * displayed initially in the file selector's view, when invoked
- * from @p obj. The default initial path is the @c "HOME"
- * environment variable's value.
+ * @param obj The icon object
+ * @return The icon name
*
- * @see elm_fileselector_entry_path_get()
- */
- EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
-
- /**
- * Get the entry's path string for a given file selector entry
- * widget
+ * If the icon image was set using elm_icon_file_set() instead of
+ * elm_icon_standard_set(), then this function will return @c NULL.
*
- * @param obj The file selector entry widget
- * @return path The path string
+ * @see elm_icon_standard_set()
*
- * @see elm_fileselector_entry_path_set() for more details
+ * @ingroup Icon
*/
- EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Enable/disable a tree view in the given file selector entry
- * widget's internal file selector
+ * Set the smooth effect for an icon object.
*
- * @param obj The file selector entry widget
- * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
- * disable
+ * @param obj The icon object
+ * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
+ * otherwise. Default is @c EINA_TRUE.
*
- * This has the same effect as elm_fileselector_expandable_set(),
- * but now applied to a file selector entry's internal file
- * selector.
+ * Set the scaling algorithm to be used when scaling the icon image. Smooth
+ * scaling provides a better resulting image, but is slower.
*
- * @note There's no way to put a file selector entry's internal
- * file selector in "grid mode", as one may do with "pure" file
- * selectors.
+ * The smooth scaling should be disabled when making animations that change
+ * the icon size, since they will be faster. Animations that don't require
+ * resizing of the icon can keep the smooth scaling enabled (even if the icon
+ * is already scaled, since the scaled icon image will be cached).
*
- * @see elm_fileselector_expandable_get()
+ * @see elm_icon_smooth_get()
+ *
+ * @ingroup Icon
*/
- EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
/**
- * Get whether tree view is enabled for the given file selector
- * entry widget's internal file selector
+ * Get the smooth effect for an icon object.
*
- * @param obj The file selector entry widget
- * @return @c EINA_TRUE if @p obj widget's internal file selector
- * is in tree view, @c EINA_FALSE otherwise (and or errors)
+ * @param obj The icon object
+ * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
*
- * @see elm_fileselector_expandable_set() for more details
+ * @see elm_icon_smooth_set()
+ *
+ * @ingroup Icon
*/
- EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set whether a given file selector entry widget's internal file
- * selector is to display folders only or the directory contents,
- * as well.
+ * Disable scaling of this object.
*
- * @param obj The file selector entry widget
- * @param only @c EINA_TRUE to make @p obj widget's internal file
- * selector only display directories, @c EINA_FALSE to make files
- * to be displayed in it too
+ * @param obj The icon object.
+ * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
+ * otherwise. Default is @c EINA_FALSE.
*
- * This has the same effect as elm_fileselector_folder_only_set(),
- * but now applied to a file selector entry's internal file
- * selector.
+ * This function disables scaling of the icon object through the function
+ * elm_object_scale_set(). However, this does not affect the object
+ * size/resize in any way. For that effect, take a look at
+ * elm_icon_scale_set().
*
- * @see elm_fileselector_folder_only_get()
+ * @see elm_icon_no_scale_get()
+ * @see elm_icon_scale_set()
+ * @see elm_object_scale_set()
+ *
+ * @ingroup Icon
*/
- EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
/**
- * Get whether a given file selector entry widget's internal file
- * selector is displaying folders only or the directory contents,
- * as well.
+ * Get whether scaling is disabled on the object.
*
- * @param obj The file selector entry widget
- * @return @c EINA_TRUE if @p obj widget's internal file
- * selector is only displaying directories, @c EINA_FALSE if files
- * are being displayed in it too (and on errors)
+ * @param obj The icon object
+ * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
*
- * @see elm_fileselector_entry_folder_only_set() for more details
+ * @see elm_icon_no_scale_set()
+ *
+ * @ingroup Icon
*/
- EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Enable/disable the file name entry box where the user can type
- * in a name for a file, in a given file selector entry widget's
- * internal file selector.
+ * Set if the object is (up/down) resizable.
*
- * @param obj The file selector entry widget
- * @param is_save @c EINA_TRUE to make @p obj widget's internal
- * file selector a "saving dialog", @c EINA_FALSE otherwise
+ * @param obj The icon object
+ * @param scale_up A bool to set if the object is resizable up. Default is
+ * @c EINA_TRUE.
+ * @param scale_down A bool to set if the object is resizable down. Default
+ * is @c EINA_TRUE.
*
- * This has the same effect as elm_fileselector_is_save_set(),
- * but now applied to a file selector entry's internal file
- * selector.
+ * This function limits the icon object resize ability. If @p scale_up is set to
+ * @c EINA_FALSE, the object can't have its height or width resized to a value
+ * higher than the original icon size. Same is valid for @p scale_down.
*
- * @see elm_fileselector_is_save_get()
+ * @see elm_icon_scale_get()
+ *
+ * @ingroup Icon
*/
- EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
/**
- * Get whether the given file selector entry widget's internal
- * file selector is in "saving dialog" mode
+ * Get if the object is (up/down) resizable.
*
- * @param obj The file selector entry widget
- * @return @c EINA_TRUE, if @p obj widget's internal file selector
- * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
- * errors)
+ * @param obj The icon object
+ * @param scale_up A bool to set if the object is resizable up
+ * @param scale_down A bool to set if the object is resizable down
*
- * @see elm_fileselector_entry_is_save_set() for more details
+ * @see elm_icon_scale_set()
+ *
+ * @ingroup Icon
*/
- EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
/**
- * Set whether a given file selector entry widget's internal file
- * selector will raise an Elementary "inner window", instead of a
- * dedicated Elementary window. By default, it won't.
+ * Get the object's image size
*
- * @param obj The file selector entry widget
- * @param value @c EINA_TRUE to make it use an inner window, @c
- * EINA_TRUE to make it use a dedicated window
+ * @param obj The icon object
+ * @param w A pointer to store the width in
+ * @param h A pointer to store the height in
*
- * @see elm_win_inwin_add() for more information on inner windows
- * @see elm_fileselector_entry_inwin_mode_get()
+ * @ingroup Icon
*/
- EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
/**
- * Get whether a given file selector entry widget's internal file
- * selector will raise an Elementary "inner window", instead of a
- * dedicated Elementary window.
+ * Set if the icon fill the entire object area.
*
- * @param obj The file selector entry widget
- * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
- * if it will use a dedicated window
+ * @param obj The icon object
+ * @param fill_outside @c EINA_TRUE if the object is filled outside,
+ * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
*
- * @see elm_fileselector_entry_inwin_mode_set() for more details
- */
- EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /**
- * Set the initial file system path for a given file selector entry
- * widget
+ * When the icon object is resized to a different aspect ratio from the
+ * original icon image, the icon image will still keep its aspect. This flag
+ * tells how the image should fill the object's area. They are: keep the
+ * entire icon inside the limits of height and width of the object (@p
+ * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
+ * of the object, and the icon will fill the entire object (@p fill_outside
+ * is @c EINA_TRUE).
*
- * @param obj The file selector entry widget
- * @param path The path string
+ * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
+ * retain property to false. Thus, the icon image will always keep its
+ * original aspect ratio.
*
- * It must be a <b>directory</b> path, which will have the contents
- * displayed initially in the file selector's view, when invoked
- * from @p obj. The default initial path is the @c "HOME"
- * environment variable's value.
+ * @see elm_icon_fill_outside_get()
+ * @see elm_image_fill_outside_set()
*
- * @see elm_fileselector_entry_path_get()
+ * @ingroup Icon
*/
- EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
/**
- * Get the parent directory's path to the latest file selection on
- * a given filer selector entry widget
+ * Get if the object is filled outside.
*
- * @param obj The file selector object
- * @return The (full) path of the directory of the last selection
- * on @p obj widget, a @b stringshared string
+ * @param obj The icon object
+ * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
*
- * @see elm_fileselector_entry_path_set()
+ * @see elm_icon_fill_outside_set()
+ *
+ * @ingroup Icon
*/
- EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /**
- * @}
- */
-
+ EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @defgroup Scroller Scroller
+ * Set the prescale size for the icon.
*
- * A scroller holds a single object and "scrolls it around". This means that
- * it allows the user to use a scrollbar (or a finger) to drag the viewable
- * region around, allowing to move through a much larger object that is
- * contained in the scroller. The scroiller will always have a small minimum
- * size by default as it won't be limited by the contents of the scroller.
+ * @param obj The icon object
+ * @param size The prescale size. This value is used for both width and
+ * height.
*
- * Signals that you can add callbacks for are:
- * @li "edge,left" - the left edge of the content has been reached
- * @li "edge,right" - the right edge of the content has been reached
- * @li "edge,top" - the top edge of the content has been reached
- * @li "edge,bottom" - the bottom edge of the content has been reached
- * @li "scroll" - the content has been scrolled (moved)
- * @li "scroll,anim,start" - scrolling animation has started
- * @li "scroll,anim,stop" - scrolling animation has stopped
- * @li "scroll,drag,start" - dragging the contents around has started
- * @li "scroll,drag,stop" - dragging the contents around has stopped
- * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
- * user intervetion.
+ * This function sets a new size for pixmap representation of the given
+ * icon. It allows the icon to be loaded already in the specified size,
+ * reducing the memory usage and load time when loading a big icon with load
+ * size set to a smaller size.
*
- * @note When Elemementary is in embedded mode the scrollbars will not be
- * dragable, they appear merely as indicators of how much has been scrolled.
- * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
- * fingerscroll) won't work.
+ * It's equivalent to the elm_bg_load_size_set() function for bg.
*
- * In @ref tutorial_scroller you'll find an example of how to use most of
- * this API.
- * @{
- */
- /**
- * @brief Type that controls when scrollbars should appear.
+ * @note this is just a hint, the real size of the pixmap may differ
+ * depending on the type of icon being loaded, being bigger than requested.
*
- * @see elm_scroller_policy_set()
- */
- typedef enum _Elm_Scroller_Policy
- {
- ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
- ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
- ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
- ELM_SCROLLER_POLICY_LAST
- } Elm_Scroller_Policy;
- /**
- * @brief Add a new scroller to the parent
+ * @see elm_icon_prescale_get()
+ * @see elm_bg_load_size_set()
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @ingroup Icon
*/
- EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
/**
- * @brief Set the content of the scroller widget (the object to be scrolled around).
+ * Get the prescale size for the icon.
*
- * @param obj The scroller object
- * @param content The new content object
+ * @param obj The icon object
+ * @return The prescale size
*
- * Once the content object is set, a previously set one will be deleted.
- * If you want to keep that old content object, use the
- * elm_scroller_content_unset() function.
+ * @see elm_icon_prescale_set()
+ *
+ * @ingroup Icon
*/
- EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
+ EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Get the content of the scroller widget
+ * Sets the icon lookup order used by elm_icon_standard_set().
*
- * @param obj The slider object
- * @return The content that is being used
+ * @param obj The icon object
+ * @param order The icon lookup order (can be one of
+ * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
+ * or ELM_ICON_LOOKUP_THEME)
*
- * Return the content object which is set for this widget
+ * @see elm_icon_order_lookup_get()
+ * @see Elm_Icon_Lookup_Order
*
- * @see elm_scroller_content_set()
+ * @ingroup Icon
*/
- EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
/**
- * @brief Unset the content of the scroller widget
+ * Gets the icon lookup order.
*
- * @param obj The slider object
- * @return The content that was being used
+ * @param obj The icon object
+ * @return The icon lookup order
*
- * Unparent and return the content object which was set for this widget
+ * @see elm_icon_order_lookup_set()
+ * @see Elm_Icon_Lookup_Order
*
- * @see elm_scroller_content_set()
+ * @ingroup Icon
*/
- EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Set custom theme elements for the scroller
+ * Get if the icon supports animation or not.
*
- * @param obj The scroller object
- * @param widget The widget name to use (default is "scroller")
- * @param base The base name to use (default is "base")
+ * @param obj The icon object
+ * @return @c EINA_TRUE if the icon supports animation,
+ * @c EINA_FALSE otherwise.
+ *
+ * Return if this elm icon's image can be animated. Currently Evas only
+ * supports gif animation. If the return value is EINA_FALSE, other
+ * elm_icon_animated_XXX APIs won't work.
+ * @ingroup Icon
*/
- EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
+ EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Make the scroller minimum size limited to the minimum size of the content
+ * Set animation mode of the icon.
*
- * @param obj The scroller object
- * @param w Enable limiting minimum size horizontally
- * @param h Enable limiting minimum size vertically
+ * @param obj The icon object
+ * @param anim @c EINA_TRUE if the object do animation job,
+ * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
*
- * By default the scroller will be as small as its design allows,
- * irrespective of its content. This will make the scroller minimum size the
- * right size horizontally and/or vertically to perfectly fit its content in
- * that direction.
+ * Even though elm icon's file can be animated,
+ * sometimes appication developer want to just first page of image.
+ * In that time, don't call this function, because default value is EINA_FALSE
+ * Only when you want icon support anition,
+ * use this function and set animated to EINA_TURE
+ * @ingroup Icon
*/
- EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
+ EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
/**
- * @brief Show a specific virtual region within the scroller content object
- *
- * @param obj The scroller object
- * @param x X coordinate of the region
- * @param y Y coordinate of the region
- * @param w Width of the region
- * @param h Height of the region
+ * Get animation mode of the icon.
*
- * This will ensure all (or part if it does not fit) of the designated
- * region in the virtual content object (0, 0 starting at the top-left of the
- * virtual content object) is shown within the scroller.
+ * @param obj The icon object
+ * @return The animation mode of the icon object
+ * @see elm_icon_animated_set
+ * @ingroup Icon
*/
- 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);
+ EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Set the scrollbar visibility policy
+ * Set animation play mode of the icon.
*
- * @param obj The scroller object
- * @param policy_h Horizontal scrollbar policy
- * @param policy_v Vertical scrollbar policy
+ * @param obj The icon object
+ * @param play @c EINA_TRUE the object play animation images,
+ * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
*
- * This sets the scrollbar visibility policy for the given scroller.
- * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
- * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
- * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
- * respectively for the horizontal and vertical scrollbars.
+ * If you want to play elm icon's animation, you set play to EINA_TURE.
+ * For example, you make gif player using this set/get API and click event.
+ *
+ * 1. Click event occurs
+ * 2. Check play flag using elm_icon_animaged_play_get
+ * 3. If elm icon was playing, set play to EINA_FALSE.
+ * Then animation will be stopped and vice versa
+ * @ingroup Icon
*/
- EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
+ EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
/**
- * @brief Gets scrollbar visibility policy
+ * Get animation play mode of the icon.
*
- * @param obj The scroller object
- * @param policy_h Horizontal scrollbar policy
- * @param policy_v Vertical scrollbar policy
+ * @param obj The icon object
+ * @return The play mode of the icon object
*
- * @see elm_scroller_policy_set()
+ * @see elm_icon_animated_lay_get
+ * @ingroup Icon
*/
- EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the currently visible content region
+ * @}
+ */
+
+ /**
+ * @defgroup Image Image
*
- * @param obj The scroller object
- * @param x X coordinate of the region
- * @param y Y coordinate of the region
- * @param w Width of the region
- * @param h Height of the region
+ * @image html img/widget/image/preview-00.png
+ * @image latex img/widget/image/preview-00.eps
+
*
- * This gets the current region in the content object that is visible through
- * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
- * w, @p h values pointed to.
+ * An object that allows one to load an image file to it. It can be used
+ * anywhere like any other elementary widget.
*
- * @note All coordinates are relative to the content.
+ * This widget provides most of the functionality provided from @ref Bg or @ref
+ * Icon, but with a slightly different API (use the one that fits better your
+ * needs).
*
- * @see elm_scroller_region_show()
- */
- 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);
- /**
- * @brief Get the size of the content object
+ * The features not provided by those two other image widgets are:
+ * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
+ * @li change the object orientation with elm_image_orient_set();
+ * @li and turning the image editable with elm_image_editable_set().
*
- * @param obj The scroller object
- * @param w Width return
- * @param h Height return
+ * Signals that you can add callbacks for are:
*
- * This gets the size of the content object of the scroller.
+ * @li @c "clicked" - This is called when a user has clicked the image
+ *
+ * An example of usage for this API follows:
+ * @li @ref tutorial_image
*/
- EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set bouncing behavior
+ * @addtogroup Image
+ * @{
+ */
+
+ /**
+ * @enum _Elm_Image_Orient
+ * @typedef Elm_Image_Orient
*
- * @param obj The scroller object
- * @param h_bounce Will the scroller bounce horizontally or not
- * @param v_bounce Will the scroller bounce vertically or not
+ * Possible orientation options for elm_image_orient_set().
*
- * When scrolling, the scroller may "bounce" when reaching an edge of the
- * content object. This is a visual way to indicate the end has been reached.
- * This is enabled by default for both axis. This will set if it is enabled
- * for that axis with the boolean parameters for each axis.
+ * @image html elm_image_orient_set.png
+ * @image latex elm_image_orient_set.eps width=\textwidth
+ *
+ * @ingroup Image
*/
- EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Image_Orient
+ {
+ ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
+ ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
+ ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
+ ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
+ ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
+ ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
+ ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
+ ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
+ } Elm_Image_Orient;
+
/**
- * @brief Get the bounce mode
+ * Add a new image to the parent.
*
- * @param obj The Scroller object
- * @param h_bounce Allow bounce horizontally
- * @param v_bounce Allow bounce vertically
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
*
- * @see elm_scroller_bounce_set()
+ * @see elm_image_file_set()
+ *
+ * @ingroup Image
*/
- EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * @brief Set scroll page size relative to viewport size.
- *
- * @param obj The scroller object
- * @param h_pagerel The horizontal page relative size
- * @param v_pagerel The vertical page relative size
+ * Set the file that will be used as image.
*
- * The scroller is capable of limiting scrolling by the user to "pages". That
- * is to jump by and only show a "whole page" at a time as if the continuous
- * area of the scroller content is split into page sized pieces. This sets
- * the size of a page relative to the viewport of the scroller. 1.0 is "1
- * viewport" is size (horizontally or vertically). 0.0 turns it off in that
- * axis. This is mutually exclusive with page size
- * (see elm_scroller_page_size_set() for more information). Likewise 0.5
- * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
- * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
- * the other axis.
- */
- EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
- /**
- * @brief Set scroll page size.
+ * @param obj The image object
+ * @param file The path to file that will be used as image
+ * @param group The group that the image belongs in edje file (if it's an
+ * edje image)
*
- * @param obj The scroller object
- * @param h_pagesize The horizontal page size
- * @param v_pagesize The vertical page size
+ * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
*
- * This sets the page size to an absolute fixed value, with 0 turning it off
- * for that axis.
+ * @see elm_image_file_get()
*
- * @see elm_scroller_page_relative_set()
+ * @ingroup Image
*/
- EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
/**
- * @brief Show a specific virtual region within the scroller content object.
+ * Get the file that will be used as image.
*
- * @param obj The scroller object
- * @param x X coordinate of the region
- * @param y Y coordinate of the region
- * @param w Width of the region
- * @param h Height of the region
+ * @param obj The image object
+ * @param file The path to file
+ * @param group The group that the image belongs in edje file
*
- * This will ensure all (or part if it does not fit) of the designated
- * region in the virtual content object (0, 0 starting at the top-left of the
- * virtual content object) is shown within the scroller. Unlike
- * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
- * to this location (if configuration in general calls for transitions). It
- * may not jump immediately to the new location and make take a while and
- * show other content along the way.
+ * @see elm_image_file_set()
*
- * @see elm_scroller_region_show()
+ * @ingroup Image
*/
- 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);
+ EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
/**
- * @brief Set event propagation on a scroller
+ * Set the smooth effect for an image.
*
- * @param obj The scroller object
- * @param propagation If propagation is enabled or not
+ * @param obj The image object
+ * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
+ * otherwise. Default is @c EINA_TRUE.
*
- * This enables or disabled event propagation from the scroller content to
- * the scroller and its parent. By default event propagation is disabled.
- */
- EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
- /**
- * @brief Get event propagation for a scroller
+ * Set the scaling algorithm to be used when scaling the image. Smooth
+ * scaling provides a better resulting image, but is slower.
*
- * @param obj The scroller object
- * @return The propagation state
+ * The smooth scaling should be disabled when making animations that change
+ * the image size, since it will be faster. Animations that don't require
+ * resizing of the image can keep the smooth scaling enabled (even if the
+ * image is already scaled, since the scaled image will be cached).
*
- * This gets the event propagation for a scroller.
+ * @see elm_image_smooth_get()
*
- * @see elm_scroller_propagate_events_set()
- */
- EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
- /**
- * @}
+ * @ingroup Image
*/
-
+ EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
/**
- * @defgroup Label Label
- *
- * @image html img/widget/label/preview-00.png
- * @image latex img/widget/label/preview-00.eps
- *
- * @brief Widget to display text, with simple html-like markup.
+ * Get the smooth effect for an image.
*
- * The Label widget @b doesn't allow text to overflow its boundaries, if the
- * text doesn't fit the geometry of the label it will be ellipsized or be
- * cut. Elementary provides several themes for this widget:
- * @li default - No animation
- * @li marker - Centers the text in the label and make it bold by default
- * @li slide_long - The entire text appears from the right of the screen and
- * slides until it disappears in the left of the screen(reappering on the
- * right again).
- * @li slide_short - The text appears in the left of the label and slides to
- * the right to show the overflow. When all of the text has been shown the
- * position is reset.
- * @li slide_bounce - The text appears in the left of the label and slides to
- * the right to show the overflow. When all of the text has been shown the
- * animation reverses, moving the text to the left.
+ * @param obj The image object
+ * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
*
- * Custom themes can of course invent new markup tags and style them any way
- * they like.
+ * @see elm_image_smooth_get()
*
- * See @ref tutorial_label for a demonstration of how to use a label widget.
- * @{
+ * @ingroup Image
*/
+ EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Add a new label to the parent
+ * Gets the current size of the image.
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
- */
- EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the label on the label object
+ * @param obj The image object.
+ * @param w Pointer to store width, or NULL.
+ * @param h Pointer to store height, or NULL.
*
- * @param obj The label object
- * @param label The label will be used on the label object
- * @deprecated See elm_object_text_set()
- */
- EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_set instead */
- /**
- * @brief Get the label used on the label object
+ * This is the real size of the image, not the size of the object.
*
- * @param obj The label object
- * @return The string inside the label
- * @deprecated See elm_object_text_get()
+ * On error, neither w or h will be written.
+ *
+ * @ingroup Image
*/
- EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
+ EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
/**
- * @brief Set the wrapping behavior of the label
+ * Disable scaling of this object.
*
- * @param obj The label object
- * @param wrap To wrap text or not
+ * @param obj The image object.
+ * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
+ * otherwise. Default is @c EINA_FALSE.
*
- * By default no wrapping is done. Possible values for @p wrap are:
- * @li ELM_WRAP_NONE - No wrapping
- * @li ELM_WRAP_CHAR - wrap between characters
- * @li ELM_WRAP_WORD - wrap between words
- * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
- */
- EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
- /**
- * @brief Get the wrapping behavior of the label
+ * This function disables scaling of the elm_image widget through the
+ * function elm_object_scale_set(). However, this does not affect the widget
+ * size/resize in any way. For that effect, take a look at
+ * elm_image_scale_set().
*
- * @param obj The label object
- * @return Wrap type
+ * @see elm_image_no_scale_get()
+ * @see elm_image_scale_set()
+ * @see elm_object_scale_set()
*
- * @see elm_label_line_wrap_set()
+ * @ingroup Image
*/
- EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
/**
- * @brief Set wrap width of the label
+ * Get whether scaling is disabled on the object.
*
- * @param obj The label object
- * @param w The wrap width in pixels at a minimum where words need to wrap
+ * @param obj The image object
+ * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
*
- * This function sets the maximum width size hint of the label.
+ * @see elm_image_no_scale_set()
*
- * @warning This is only relevant if the label is inside a container.
+ * @ingroup Image
*/
- EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Get wrap width of the label
+ * Set if the object is (up/down) resizable.
*
- * @param obj The label object
- * @return The wrap width in pixels at a minimum where words need to wrap
+ * @param obj The image object
+ * @param scale_up A bool to set if the object is resizable up. Default is
+ * @c EINA_TRUE.
+ * @param scale_down A bool to set if the object is resizable down. Default
+ * is @c EINA_TRUE.
*
- * @see elm_label_wrap_width_set()
+ * This function limits the image resize ability. If @p scale_up is set to
+ * @c EINA_FALSE, the object can't have its height or width resized to a value
+ * higher than the original image size. Same is valid for @p scale_down.
+ *
+ * @see elm_image_scale_get()
+ *
+ * @ingroup Image
*/
- EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
/**
- * @brief Set wrap height of the label
+ * Get if the object is (up/down) resizable.
*
- * @param obj The label object
- * @param h The wrap height in pixels at a minimum where words need to wrap
+ * @param obj The image object
+ * @param scale_up A bool to set if the object is resizable up
+ * @param scale_down A bool to set if the object is resizable down
*
- * This function sets the maximum height size hint of the label.
+ * @see elm_image_scale_set()
*
- * @warning This is only relevant if the label is inside a container.
+ * @ingroup Image
*/
- EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
+ EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
/**
- * @brief get wrap width of the label
+ * Set if the image fill the entire object area when keeping the aspect ratio.
*
- * @param obj The label object
- * @return The wrap height in pixels at a minimum where words need to wrap
- */
- EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the font size on the label object.
+ * @param obj The image object
+ * @param fill_outside @c EINA_TRUE if the object is filled outside,
+ * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
*
- * @param obj The label object
- * @param size font size
+ * When the image should keep its aspect ratio even if resized to another
+ * aspect ratio, there are two possibilities to resize it: keep the entire
+ * image inside the limits of height and width of the object (@p fill_outside
+ * is @c EINA_FALSE) or let the extra width or height go outside of the object,
+ * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
*
- * @warning NEVER use this. It is for hyper-special cases only. use styles
- * instead. e.g. "big", "medium", "small" - or better name them by use:
- * "title", "footnote", "quote" etc.
+ * @note This option will have no effect if
+ * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
+ *
+ * @see elm_image_fill_outside_get()
+ * @see elm_image_aspect_ratio_retained_set()
+ *
+ * @ingroup Image
*/
- EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
+ EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
/**
- * @brief Set the text color on the label object
+ * Get if the object is filled outside
*
- * @param obj The label object
- * @param r Red property background color of The label object
- * @param g Green property background color of The label object
- * @param b Blue property background color of The label object
- * @param a Alpha property background color of The label object
+ * @param obj The image object
+ * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
*
- * @warning NEVER use this. It is for hyper-special cases only. use styles
- * instead. e.g. "big", "medium", "small" - or better name them by use:
- * "title", "footnote", "quote" etc.
+ * @see elm_image_fill_outside_set()
+ *
+ * @ingroup Image
*/
- 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);
+ EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Set the text align on the label object
+ * Set the prescale size for the image
*
- * @param obj The label object
- * @param align align mode ("left", "center", "right")
+ * @param obj The image object
+ * @param size The prescale size. This value is used for both width and
+ * height.
*
- * @warning NEVER use this. It is for hyper-special cases only. use styles
- * instead. e.g. "big", "medium", "small" - or better name them by use:
- * "title", "footnote", "quote" etc.
+ * This function sets a new size for pixmap representation of the given
+ * image. It allows the image to be loaded already in the specified size,
+ * reducing the memory usage and load time when loading a big image with load
+ * size set to a smaller size.
+ *
+ * It's equivalent to the elm_bg_load_size_set() function for bg.
+ *
+ * @note this is just a hint, the real size of the pixmap may differ
+ * depending on the type of image being loaded, being bigger than requested.
+ *
+ * @see elm_image_prescale_get()
+ * @see elm_bg_load_size_set()
+ *
+ * @ingroup Image
*/
- EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
+ EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
/**
- * @brief Set background color of the label
+ * Get the prescale size for the image
*
- * @param obj The label object
- * @param r Red property background color of The label object
- * @param g Green property background color of The label object
- * @param b Blue property background color of The label object
- * @param a Alpha property background alpha of The label object
+ * @param obj The image object
+ * @return The prescale size
*
- * @warning NEVER use this. It is for hyper-special cases only. use styles
- * instead. e.g. "big", "medium", "small" - or better name them by use:
- * "title", "footnote", "quote" etc.
+ * @see elm_image_prescale_set()
+ *
+ * @ingroup Image
*/
- 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);
+ EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Set the ellipsis behavior of the label
+ * Set the image orientation.
*
- * @param obj The label object
- * @param ellipsis To ellipsis text or not
+ * @param obj The image object
+ * @param orient The image orientation
+ * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
+ * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
+ * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
+ * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
+ * Default is #ELM_IMAGE_ORIENT_NONE.
*
- * If set to true and the text doesn't fit in the label an ellipsis("...")
- * will be shown at the end of the widget.
+ * This function allows to rotate or flip the given image.
*
- * @warning This doesn't work with slide(elm_label_slide_set()) or if the
- * choosen wrap method was ELM_WRAP_WORD.
+ * @see elm_image_orient_get()
+ * @see @ref Elm_Image_Orient
+ *
+ * @ingroup Image
*/
- EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
+ EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
/**
- * @brief Set the text slide of the label
+ * Get the image orientation.
*
- * @param obj The label object
- * @param slide To start slide or stop
+ * @param obj The image object
+ * @return The image orientation
+ * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
+ * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
+ * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
+ * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
*
- * If set to true the text of the label will slide throught the length of
- * label.
+ * @see elm_image_orient_set()
+ * @see @ref Elm_Image_Orient
*
- * @warning This only work with the themes "slide_short", "slide_long" and
- * "slide_bounce".
+ * @ingroup Image
*/
- EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
+ EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Get the text slide mode of the label
+ * Make the image 'editable'.
*
- * @param obj The label object
- * @return slide slide mode value
+ * @param obj Image object.
+ * @param set Turn on or off editability. Default is @c EINA_FALSE.
*
- * @see elm_label_slide_set()
+ * This means the image is a valid drag target for drag and drop, and can be
+ * cut or pasted too.
+ *
+ * @ingroup Image
*/
- EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
/**
- * @brief Set the slide duration(speed) of the label
+ * Make the image 'editable'.
*
- * @param obj The label object
- * @return The duration in seconds in moving text from slide begin position
- * to slide end position
+ * @param obj Image object.
+ * @return Editability.
+ *
+ * This means the image is a valid drag target for drag and drop, and can be
+ * cut or pasted too.
+ *
+ * @ingroup Image
*/
- EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Get the slide duration(speed) of the label
+ * Get the basic Evas_Image object from this object (widget).
*
- * @param obj The label object
- * @return The duration time in moving text from slide begin position to slide end position
+ * @param obj The image object to get the inlined image from
+ * @return The inlined image object, or NULL if none exists
*
- * @see elm_label_slide_duration_set()
+ * This function allows one to get the underlying @c Evas_Object of type
+ * Image from this elementary widget. It can be useful to do things like get
+ * the pixel data, save the image to a file, etc.
+ *
+ * @note Be careful to not manipulate it, as it is under control of
+ * elementary.
+ *
+ * @ingroup Image
*/
- EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set whether the original aspect ratio of the image should be kept on resize.
+ *
+ * @param obj The image object.
+ * @param retained @c EINA_TRUE if the image should retain the aspect,
+ * @c EINA_FALSE otherwise.
+ *
+ * The original aspect ratio (width / height) of the image is usually
+ * distorted to match the object's size. Enabling this option will retain
+ * this original aspect, and the way that the image is fit into the object's
+ * area depends on the option set by elm_image_fill_outside_set().
+ *
+ * @see elm_image_aspect_ratio_retained_get()
+ * @see elm_image_fill_outside_set()
+ *
+ * @ingroup Image
+ */
+ EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
+ /**
+ * Get if the object retains the original aspect ratio.
+ *
+ * @param obj The image object.
+ * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
+ * otherwise.
+ *
+ * @ingroup Image
+ */
+ EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
+ /* glview */
+ typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
+
+ typedef enum _Elm_GLView_Mode
+ {
+ ELM_GLVIEW_ALPHA = 1,
+ ELM_GLVIEW_DEPTH = 2,
+ ELM_GLVIEW_STENCIL = 4
+ } Elm_GLView_Mode;
+
/**
- * @defgroup Toggle
+ * Defines a policy for the glview resizing.
*
- * @image html img/widget/toggle/preview-00.png
- * @image latex img/widget/toggle/preview-00.eps
+ * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
+ */
+ typedef enum _Elm_GLView_Resize_Policy
+ {
+ ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
+ ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
+ } Elm_GLView_Resize_Policy;
+
+ typedef enum _Elm_GLView_Render_Policy
+ {
+ ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
+ ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
+ } Elm_GLView_Render_Policy;
+
+ /**
+ * @defgroup GLView
*
- * @brief A toggle is a slider which can be used to toggle between
- * two values. It has two states: on and off.
+ * A simple GLView widget that allows GL rendering.
*
* Signals that you can add callbacks for are:
- * @li "changed" - Whenever the toggle value has been changed. Is not called
- * until the toggle is released by the cursor (assuming it
- * has been triggered by the cursor in the first place).
*
- * @ref tutorial_toggle show how to use a toggle.
* @{
*/
+
/**
- * @brief Add a toggle to @p parent.
+ * Add a new glview to the parent
*
* @param parent The parent object
+ * @return The new object or NULL if it cannot be created
*
- * @return The toggle object
+ * @ingroup GLView
*/
- EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
- * @brief Sets the label to be displayed with the toggle.
+ * Sets the size of the glview
*
- * @param obj The toggle object
- * @param label The label to be displayed
+ * @param obj The glview object
+ * @param width width of the glview object
+ * @param height height of the glview object
*
- * @deprecated use elm_object_text_set() instead.
+ * @ingroup GLView
*/
- EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+ EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
+
/**
- * @brief Gets the label of the toggle
+ * Gets the size of the glview.
*
- * @param obj toggle object
- * @return The label of the toggle
+ * @param obj The glview object
+ * @param width width of the glview object
+ * @param height height of the glview object
*
- * @deprecated use elm_object_text_get() instead.
+ * Note that this function returns the actual image size of the
+ * glview. This means that when the scale policy is set to
+ * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
+ * size.
+ *
+ * @ingroup GLView
*/
- EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the icon used for the toggle
+ * Gets the gl api struct for gl rendering
*
- * @param obj The toggle object
- * @param icon The icon object for the button
+ * @param obj The glview object
+ * @return The api object or NULL if it cannot be created
*
- * Once the icon object is set, a previously set one will be deleted
- * If you want to keep that old content object, use the
- * elm_toggle_icon_unset() function.
+ * @ingroup GLView
*/
- EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+ EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the icon used for the toggle
+ * Set the mode of the GLView. Supports Three simple modes.
*
- * @param obj The toggle object
- * @return The icon object that is being used
- *
- * Return the icon object which is set for this widget.
+ * @param obj The glview object
+ * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
+ * @return True if set properly.
*
- * @see elm_toggle_icon_set()
+ * @ingroup GLView
*/
- EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
+
/**
- * @brief Unset the icon used for the toggle
+ * Set the resize policy for the glview object.
*
- * @param obj The toggle object
- * @return The icon object that was being used
+ * @param obj The glview object.
+ * @param policy The scaling policy.
*
- * Unparent and return the icon object which was set for this widget.
+ * By default, the resize policy is set to
+ * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
+ * destroys the previous surface and recreates the newly specified
+ * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
+ * however, glview only scales the image object and not the underlying
+ * GL Surface.
*
- * @see elm_toggle_icon_set()
+ * @ingroup GLView
*/
- EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
+
/**
- * @brief Sets the labels to be associated with the on and off states of the toggle.
+ * Set the render policy for the glview object.
*
- * @param obj The toggle object
- * @param onlabel The label displayed when the toggle is in the "on" state
- * @param offlabel The label displayed when the toggle is in the "off" state
+ * @param obj The glview object.
+ * @param policy The render policy.
+ *
+ * By default, the render policy is set to
+ * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
+ * that during the render loop, glview is only redrawn if it needs
+ * to be redrawn. (i.e. When it is visible) If the policy is set to
+ * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
+ * whether it is visible/need redrawing or not.
+ *
+ * @ingroup GLView
*/
- EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
+
/**
- * @brief Gets the labels associated with the on and off states of the toggle.
+ * Set the init function that runs once in the main loop.
*
- * @param obj The toggle object
- * @param onlabel A char** to place the onlabel of @p obj into
- * @param offlabel A char** to place the offlabel of @p obj into
+ * @param obj The glview object.
+ * @param func The init function to be registered.
+ *
+ * The registered init function gets called once during the render loop.
+ *
+ * @ingroup GLView
*/
- EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
+ EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
+
/**
- * @brief Sets the state of the toggle to @p state.
+ * Set the render function that runs in the main loop.
*
- * @param obj The toggle object
- * @param state The state of @p obj
+ * @param obj The glview object.
+ * @param func The delete function to be registered.
+ *
+ * The registered del function gets called when GLView object is deleted.
+ *
+ * @ingroup GLView
*/
- EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
+ EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
+
/**
- * @brief Gets the state of the toggle to @p state.
+ * Set the resize function that gets called when resize happens.
*
- * @param obj The toggle object
- * @return The state of @p obj
+ * @param obj The glview object.
+ * @param func The resize function to be registered.
+ *
+ * @ingroup GLView
*/
- EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
+
/**
- * @brief Sets the state pointer of the toggle to @p statep.
+ * Set the render function that runs in the main loop.
*
- * @param obj The toggle object
- * @param statep The state pointer of @p obj
+ * @param obj The glview object.
+ * @param func The render function to be registered.
+ *
+ * @ingroup GLView
*/
- EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
+ EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
+
+ /**
+ * Notifies that there has been changes in the GLView.
+ *
+ * @param obj The glview object.
+ *
+ * @ingroup GLView
+ */
+ EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
+ /* box */
/**
- * @defgroup Frame Frame
+ * @defgroup Box Box
*
- * @image html img/widget/frame/preview-00.png
- * @image latex img/widget/frame/preview-00.eps
+ * @image html img/widget/box/preview-00.png
+ * @image latex img/widget/box/preview-00.eps width=\textwidth
*
- * @brief Frame is a widget that holds some content and has a title.
+ * @image html img/box.png
+ * @image latex img/box.eps width=\textwidth
*
- * The default look is a frame with a title, but Frame supports multple
- * styles:
- * @li default
- * @li pad_small
- * @li pad_medium
- * @li pad_large
- * @li pad_huge
- * @li outdent_top
- * @li outdent_bottom
+ * A box arranges objects in a linear fashion, governed by a layout function
+ * that defines the details of this arrangement.
*
- * Of all this styles only default shows the title. Frame emits no signals.
+ * By default, the box will use an internal function to set the layout to
+ * a single row, either vertical or horizontal. This layout is affected
+ * by a number of parameters, such as the homogeneous flag set by
+ * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
+ * elm_box_align_set() and the hints set to each object in the box.
*
- * For a detailed example see the @ref tutorial_frame.
+ * For this default layout, it's possible to change the orientation with
+ * elm_box_horizontal_set(). The box will start in the vertical orientation,
+ * placing its elements ordered from top to bottom. When horizontal is set,
+ * the order will go from left to right. If the box is set to be
+ * homogeneous, every object in it will be assigned the same space, that
+ * of the largest object. Padding can be used to set some spacing between
+ * the cell given to each object. The alignment of the box, set with
+ * elm_box_align_set(), determines how the bounding box of all the elements
+ * will be placed within the space given to the box widget itself.
*
- * @{
- */
- /**
- * @brief Add a new frame to the parent
+ * The size hints of each object also affect how they are placed and sized
+ * within the box. evas_object_size_hint_min_set() will give the minimum
+ * size the object can have, and the box will use it as the basis for all
+ * latter calculations. Elementary widgets set their own minimum size as
+ * needed, so there's rarely any need to use it manually.
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
- */
- EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the frame label
+ * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
+ * used to tell whether the object will be allocated the minimum size it
+ * needs or if the space given to it should be expanded. It's important
+ * to realize that expanding the size given to the object is not the same
+ * thing as resizing the object. It could very well end being a small
+ * widget floating in a much larger empty space. If not set, the weight
+ * for objects will normally be 0.0 for both axis, meaning the widget will
+ * not be expanded. To take as much space possible, set the weight to
+ * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
*
- * @param obj The frame object
- * @param label The label of this frame object
+ * Besides how much space each object is allocated, it's possible to control
+ * how the widget will be placed within that space using
+ * evas_object_size_hint_align_set(). By default, this value will be 0.5
+ * for both axis, meaning the object will be centered, but any value from
+ * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
+ * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
+ * is -1.0, means the object will be resized to fill the entire space it
+ * was allocated.
*
- * @deprecated use elm_object_text_set() instead.
- */
- EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
- /**
- * @brief Get the frame label
+ * In addition, customized functions to define the layout can be set, which
+ * allow the application developer to organize the objects within the box
+ * in any number of ways.
*
- * @param obj The frame object
+ * The special elm_box_layout_transition() function can be used
+ * to switch from one layout to another, animating the motion of the
+ * children of the box.
*
- * @return The label of this frame objet or NULL if unable to get frame
+ * @note Objects should not be added to box objects using _add() calls.
*
- * @deprecated use elm_object_text_get() instead.
+ * Some examples on how to use boxes follow:
+ * @li @ref box_example_01
+ * @li @ref box_example_02
+ *
+ * @{
*/
- EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Set the content of the frame widget
+ * @typedef Elm_Box_Transition
*
- * Once the content object is set, a previously set one will be deleted.
- * If you want to keep that old content object, use the
- * elm_frame_content_unset() function.
+ * Opaque handler containing the parameters to perform an animated
+ * transition of the layout the box uses.
*
- * @param obj The frame object
- * @param content The content will be filled in this frame object
+ * @see elm_box_transition_new()
+ * @see elm_box_layout_set()
+ * @see elm_box_layout_transition()
*/
- EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+ typedef struct _Elm_Box_Transition Elm_Box_Transition;
+
/**
- * @brief Get the content of the frame widget
+ * Add a new box to the parent
*
- * Return the content object which is set for this widget
+ * By default, the box will be in vertical mode and non-homogeneous.
*
- * @param obj The frame object
- * @return The content that is being used
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
*/
- EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * @brief Unset the content of the frame widget
+ * Set the horizontal orientation
*
- * Unparent and return the content object which was set for this widget
+ * By default, box object arranges their contents vertically from top to
+ * bottom.
+ * By calling this function with @p horizontal as EINA_TRUE, the box will
+ * become horizontal, arranging contents from left to right.
*
- * @param obj The frame object
- * @return The content that was being used
+ * @note This flag is ignored if a custom layout function is set.
+ *
+ * @param obj The box object
+ * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
+ * EINA_FALSE = vertical)
*/
- EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
/**
- * @}
+ * Get the horizontal orientation
+ *
+ * @param obj The box object
+ * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
*/
-
+ EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @defgroup Table Table
+ * Set the box to arrange its children homogeneously
*
- * A container widget to arrange other widgets in a table where items can
- * also span multiple columns or rows - even overlap (and then be raised or
- * lowered accordingly to adjust stacking if they do overlap).
+ * If enabled, homogeneous layout makes all items the same size, according
+ * to the size of the largest of its children.
*
- * The followin are examples of how to use a table:
- * @li @ref tutorial_table_01
- * @li @ref tutorial_table_02
+ * @note This flag is ignored if a custom layout function is set.
*
- * @{
+ * @param obj The box object
+ * @param homogeneous The homogeneous flag
*/
+ EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
/**
- * @brief Add a new table to the parent
+ * Get whether the box is using homogeneous mode or not
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @param obj The box object
+ * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
*/
- EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Set the homogeneous layout in the table
+ * Add an object to the beginning of the pack list
*
- * @param obj The layout object
- * @param homogeneous A boolean to set if the layout is homogeneous in the
- * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
- */
- EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
- /**
- * @brief Get the current table homogeneous mode.
+ * Pack @p subobj into the box @p obj, placing it first in the list of
+ * children objects. The actual position the object will get on screen
+ * depends on the layout used. If no custom layout is set, it will be at
+ * the top or left, depending if the box is vertical or horizontal,
+ * respectively.
*
- * @param obj The table object
- * @return A boolean to indicating if the layout is homogeneous in the table
- * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
- */
- EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @warning <b>Use elm_table_homogeneous_set() instead</b>
- */
- EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
- /**
- * @warning <b>Use elm_table_homogeneous_get() instead</b>
+ * @param obj The box object
+ * @param subobj The object to add to the box
+ *
+ * @see elm_box_pack_end()
+ * @see elm_box_pack_before()
+ * @see elm_box_pack_after()
+ * @see elm_box_unpack()
+ * @see elm_box_unpack_all()
+ * @see elm_box_clear()
*/
- EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
/**
- * @brief Set padding between cells.
+ * Add an object at the end of the pack list
*
- * @param obj The layout object.
- * @param horizontal set the horizontal padding.
- * @param vertical set the vertical padding.
+ * Pack @p subobj into the box @p obj, placing it last in the list of
+ * children objects. The actual position the object will get on screen
+ * depends on the layout used. If no custom layout is set, it will be at
+ * the bottom or right, depending if the box is vertical or horizontal,
+ * respectively.
*
- * Default value is 0.
- */
- EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
- /**
- * @brief Get padding between cells.
+ * @param obj The box object
+ * @param subobj The object to add to the box
*
- * @param obj The layout object.
- * @param horizontal set the horizontal padding.
- * @param vertical set the vertical padding.
+ * @see elm_box_pack_start()
+ * @see elm_box_pack_before()
+ * @see elm_box_pack_after()
+ * @see elm_box_unpack()
+ * @see elm_box_unpack_all()
+ * @see elm_box_clear()
*/
- EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
+ EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
/**
- * @brief Add a subobject on the table with the coordinates passed
+ * Adds an object to the box before the indicated object
*
- * @param obj The table object
- * @param subobj The subobject to be added to the table
- * @param x Row number
- * @param y Column number
- * @param w rowspan
- * @param h colspan
+ * This will add the @p subobj to the box indicated before the object
+ * indicated with @p before. If @p before is not already in the box, results
+ * are undefined. Before means either to the left of the indicated object or
+ * above it depending on orientation.
*
- * @note All positioning inside the table is relative to rows and columns, so
- * a value of 0 for x and y, means the top left cell of the table, and a
- * value of 1 for w and h means @p subobj only takes that 1 cell.
+ * @param obj The box object
+ * @param subobj The object to add to the box
+ * @param before The object before which to add it
+ *
+ * @see elm_box_pack_start()
+ * @see elm_box_pack_end()
+ * @see elm_box_pack_after()
+ * @see elm_box_unpack()
+ * @see elm_box_unpack_all()
+ * @see elm_box_clear()
*/
- EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
+ EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
/**
- * @brief Remove child from table.
+ * Adds an object to the box after the indicated object
*
- * @param obj The table object
- * @param subobj The subobject
+ * This will add the @p subobj to the box indicated after the object
+ * indicated with @p after. If @p after is not already in the box, results
+ * are undefined. After means either to the right of the indicated object or
+ * below it depending on orientation.
+ *
+ * @param obj The box object
+ * @param subobj The object to add to the box
+ * @param after The object after which to add it
+ *
+ * @see elm_box_pack_start()
+ * @see elm_box_pack_end()
+ * @see elm_box_pack_before()
+ * @see elm_box_unpack()
+ * @see elm_box_unpack_all()
+ * @see elm_box_clear()
*/
- EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+ EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
/**
- * @brief Faster way to remove all child objects from a table object.
+ * Clear the box of all children
*
- * @param obj The table object
- * @param clear If true, will delete children, else just remove from table.
+ * Remove all the elements contained by the box, deleting the respective
+ * objects.
+ *
+ * @param obj The box object
+ *
+ * @see elm_box_unpack()
+ * @see elm_box_unpack_all()
*/
- EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
+ EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Set the packing location of an existing child of the table
+ * Unpack a box item
*
- * @param subobj The subobject to be modified in the table
- * @param x Row number
- * @param y Column number
- * @param w rowspan
- * @param h colspan
+ * Remove the object given by @p subobj from the box @p obj without
+ * deleting it.
*
- * Modifies the position of an object already in the table.
+ * @param obj The box object
*
- * @note All positioning inside the table is relative to rows and columns, so
- * a value of 0 for x and y, means the top left cell of the table, and a
- * value of 1 for w and h means @p subobj only takes that 1 cell.
+ * @see elm_box_unpack_all()
+ * @see elm_box_clear()
*/
- EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
+ EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
/**
- * @brief Get the packing location of an existing child of the table
+ * Remove all items from the box, without deleting them
*
- * @param subobj The subobject to be modified in the table
- * @param x Row number
- * @param y Column number
- * @param w rowspan
- * @param h colspan
+ * Clear the box from all children, but don't delete the respective objects.
+ * If no other references of the box children exist, the objects will never
+ * be deleted, and thus the application will leak the memory. Make sure
+ * when using this function that you hold a reference to all the objects
+ * in the box @p obj.
*
- * @see elm_table_pack_set()
+ * @param obj The box object
+ *
+ * @see elm_box_clear()
+ * @see elm_box_unpack()
*/
- EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
+ EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @}
+ * Retrieve a list of the objects packed into the box
+ *
+ * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
+ * The order of the list corresponds to the packing order the box uses.
+ *
+ * You must free this list with eina_list_free() once you are done with it.
+ *
+ * @param obj The box object
*/
-
+ EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @defgroup Gengrid Gengrid (Generic grid)
+ * Set the space (padding) between the box's elements.
*
- * This widget aims to position objects in a grid layout while
- * actually creating and rendering only the visible ones, using the
- * same idea as the @ref Genlist "genlist": the user defines a @b
- * class for each item, specifying functions that will be called at
- * object creation, deletion, etc. When those items are selected by
- * the user, a callback function is issued. Users may interact with
- * a gengrid via the mouse (by clicking on items to select them and
- * clicking on the grid's viewport and swiping to pan the whole
- * view) or via the keyboard, navigating through item with the
- * arrow keys.
+ * Extra space in pixels that will be added between a box child and its
+ * neighbors after its containing cell has been calculated. This padding
+ * is set for all elements in the box, besides any possible padding that
+ * individual elements may have through their size hints.
*
- * @section Gengrid_Layouts Gengrid layouts
+ * @param obj The box object
+ * @param horizontal The horizontal space between elements
+ * @param vertical The vertical space between elements
+ */
+ EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
+ /**
+ * Get the space (padding) between the box's elements.
*
- * Gengrids may layout its items in one of two possible layouts:
- * - horizontal or
- * - vertical.
+ * @param obj The box object
+ * @param horizontal The horizontal space between elements
+ * @param vertical The vertical space between elements
*
- * When in "horizontal mode", items will be placed in @b columns,
- * from top to bottom and, when the space for a column is filled,
- * another one is started on the right, thus expanding the grid
- * horizontally, making for horizontal scrolling. When in "vertical
- * mode" , though, items will be placed in @b rows, from left to
- * right and, when the space for a row is filled, another one is
- * started below, thus expanding the grid vertically (and making
- * for vertical scrolling).
+ * @see elm_box_padding_set()
+ */
+ EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
+ /**
+ * Set the alignment of the whole bouding box of contents.
*
- * @section Gengrid_Items Gengrid items
+ * Sets how the bounding box containing all the elements of the box, after
+ * their sizes and position has been calculated, will be aligned within
+ * the space given for the whole box widget.
*
- * An item in a gengrid can have 0 or more text labels (they can be
- * regular text or textblock Evas objects - that's up to the style
- * to determine), 0 or more icons (which are simply objects
- * swallowed into the gengrid item's theming Edje object) and 0 or
- * more <b>boolean states</b>, which have the behavior left to the
- * user to define. The Edje part names for each of these properties
- * will be looked up, in the theme file for the gengrid, under the
- * Edje (string) data items named @c "labels", @c "icons" and @c
- * "states", respectively. For each of those properties, if more
- * than one part is provided, they must have names listed separated
- * by spaces in the data fields. For the default gengrid item
- * theme, we have @b one label part (@c "elm.text"), @b two icon
- * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
- * no state parts.
+ * @param obj The box object
+ * @param horizontal The horizontal alignment of elements
+ * @param vertical The vertical alignment of elements
+ */
+ EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
+ /**
+ * Get the alignment of the whole bouding box of contents.
*
- * A gengrid item may be at one of several styles. Elementary
- * provides one by default - "default", but this can be extended by
- * system or application custom themes/overlays/extensions (see
- * @ref Theme "themes" for more details).
+ * @param obj The box object
+ * @param horizontal The horizontal alignment of elements
+ * @param vertical The vertical alignment of elements
*
- * @section Gengrid_Item_Class Gengrid item classes
+ * @see elm_box_align_set()
+ */
+ EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
+
+ /**
+ * Force the box to recalculate its children packing.
*
- * In order to have the ability to add and delete items on the fly,
- * gengrid implements a class (callback) system where the
- * application provides a structure with information about that
- * type of item (gengrid may contain multiple different items with
- * different classes, states and styles). Gengrid will call the
- * functions in this struct (methods) when an item is "realized"
- * (i.e., created dynamically, while the user is scrolling the
- * grid). All objects will simply be deleted when no longer needed
- * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
- * contains the following members:
- * - @c item_style - This is a constant string and simply defines
- * the name of the item style. It @b must be specified and the
- * default should be @c "default".
- * - @c func.label_get - This function is called when an item
- * object is actually created. The @c data parameter will point to
- * the same data passed to elm_gengrid_item_append() and related
- * item creation functions. The @c obj parameter is the gengrid
- * object itself, while the @c part one is the name string of one
- * of the existing text parts in the Edje group implementing the
- * item's theme. This function @b must return a strdup'()ed string,
- * as the caller will free() it when done. See
- * #GridItemLabelGetFunc.
- * - @c func.icon_get - This function is called when an item object
- * is actually created. The @c data parameter will point to the
- * same data passed to elm_gengrid_item_append() and related item
- * creation functions. The @c obj parameter is the gengrid object
- * itself, while the @c part one is the name string of one of the
- * existing (icon) swallow parts in the Edje group implementing the
- * item's theme. It must return @c NULL, when no icon is desired,
- * or a valid object handle, otherwise. The object will be deleted
- * by the gengrid on its deletion or when the item is "unrealized".
- * See #GridItemIconGetFunc.
- * - @c func.state_get - This function is called when an item
- * object is actually created. The @c data parameter will point to
- * the same data passed to elm_gengrid_item_append() and related
- * item creation functions. The @c obj parameter is the gengrid
- * object itself, while the @c part one is the name string of one
- * of the state parts in the Edje group implementing the item's
- * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
- * true/on. Gengrids will emit a signal to its theming Edje object
- * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
- * "source" arguments, respectively, when the state is true (the
- * default is false), where @c XXX is the name of the (state) part.
- * See #GridItemStateGetFunc.
- * - @c func.del - This is called when elm_gengrid_item_del() is
- * called on an item or elm_gengrid_clear() is called on the
- * gengrid. This is intended for use when gengrid items are
- * deleted, so any data attached to the item (e.g. its data
- * parameter on creation) can be deleted. See #GridItemDelFunc.
+ * If any children was added or removed, box will not calculate the
+ * values immediately rather leaving it to the next main loop
+ * iteration. While this is great as it would save lots of
+ * recalculation, whenever you need to get the position of a just
+ * added item you must force recalculate before doing so.
*
- * @section Gengrid_Usage_Hints Usage hints
+ * @param obj The box object.
+ */
+ EAPI void elm_box_recalculate(Evas_Object *obj);
+
+ /**
+ * Set the layout defining function to be used by the box
*
- * If the user wants to have multiple items selected at the same
- * time, elm_gengrid_multi_select_set() will permit it. If the
- * gengrid is single-selection only (the default), then
- * elm_gengrid_select_item_get() will return the selected item or
- * @c NULL, if none is selected. If the gengrid is under
- * multi-selection, then elm_gengrid_selected_items_get() will
- * return a list (that is only valid as long as no items are
- * modified (added, deleted, selected or unselected) of child items
- * on a gengrid.
+ * Whenever anything changes that requires the box in @p obj to recalculate
+ * the size and position of its elements, the function @p cb will be called
+ * to determine what the layout of the children will be.
*
- * If an item changes (internal (boolean) state, label or icon
- * changes), then use elm_gengrid_item_update() to have gengrid
- * update the item with the new state. A gengrid will re-"realize"
- * the item, thus calling the functions in the
- * #Elm_Gengrid_Item_Class set for that item.
- *
- * To programmatically (un)select an item, use
- * elm_gengrid_item_selected_set(). To get its selected state use
- * elm_gengrid_item_selected_get(). To make an item disabled
- * (unable to be selected and appear differently) use
- * elm_gengrid_item_disabled_set() to set this and
- * elm_gengrid_item_disabled_get() to get the disabled state.
+ * Once a custom function is set, everything about the children layout
+ * is defined by it. The flags set by elm_box_horizontal_set() and
+ * elm_box_homogeneous_set() no longer have any meaning, and the values
+ * given by elm_box_padding_set() and elm_box_align_set() are up to this
+ * layout function to decide if they are used and how. These last two
+ * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
+ * passed to @p cb. The @c Evas_Object the function receives is not the
+ * Elementary widget, but the internal Evas Box it uses, so none of the
+ * functions described here can be used on it.
*
- * Grid cells will only have their selection smart callbacks called
- * when firstly getting selected. Any further clicks will do
- * nothing, unless you enable the "always select mode", with
- * elm_gengrid_always_select_mode_set(), thus making every click to
- * issue selection callbacks. elm_gengrid_no_select_mode_set() will
- * turn off the ability to select items entirely in the widget and
- * they will neither appear selected nor call the selection smart
- * callbacks.
+ * Any of the layout functions in @c Evas can be used here, as well as the
+ * special elm_box_layout_transition().
*
- * Remember that you can create new styles and add your own theme
- * augmentation per application with elm_theme_extension_add(). If
- * you absolutely must have a specific style that overrides any
- * theme the user or system sets up you can use
- * elm_theme_overlay_add() to add such a file.
+ * The final @p data argument received by @p cb is the same @p data passed
+ * here, and the @p free_data function will be called to free it
+ * whenever the box is destroyed or another layout function is set.
*
- * @section Gengrid_Smart_Events Gengrid smart events
+ * Setting @p cb to NULL will revert back to the default layout function.
*
- * Smart events that you can add callbacks for are:
- * - @c "activated" - The user has double-clicked or pressed
- * (enter|return|spacebar) on an item. The @c event_info parameter
- * is the gengrid item that was activated.
- * - @c "clicked,double" - The user has double-clicked an item.
- * The @c event_info parameter is the gengrid item that was double-clicked.
- * - @c "selected" - The user has made an item selected. The
- * @c event_info parameter is the gengrid item that was selected.
- * - @c "unselected" - The user has made an item unselected. The
- * @c event_info parameter is the gengrid item that was unselected.
- * - @c "realized" - This is called when the item in the gengrid
- * has its implementing Evas object instantiated, de facto. @c
- * event_info is the gengrid item that was created. The object
- * may be deleted at any time, so it is highly advised to the
- * caller @b not to use the object pointer returned from
- * elm_gengrid_item_object_get(), because it may point to freed
- * objects.
- * - @c "unrealized" - This is called when the implementing Evas
- * object for this item is deleted. @c event_info is the gengrid
- * item that was deleted.
- * - @c "changed" - Called when an item is added, removed, resized
- * or moved and when the gengrid is resized or gets "horizontal"
- * property changes.
- * - @c "drag,start,up" - Called when the item in the gengrid has
- * been dragged (not scrolled) up.
- * - @c "drag,start,down" - Called when the item in the gengrid has
- * been dragged (not scrolled) down.
- * - @c "drag,start,left" - Called when the item in the gengrid has
- * been dragged (not scrolled) left.
- * - @c "drag,start,right" - Called when the item in the gengrid has
- * been dragged (not scrolled) right.
- * - @c "drag,stop" - Called when the item in the gengrid has
- * stopped being dragged.
- * - @c "drag" - Called when the item in the gengrid is being
- * dragged.
- * - @c "scroll" - called when the content has been scrolled
- * (moved).
- * - @c "scroll,drag,start" - called when dragging the content has
- * started.
- * - @c "scroll,drag,stop" - called when dragging the content has
- * stopped.
+ * @param obj The box object
+ * @param cb The callback function used for layout
+ * @param data Data that will be passed to layout function
+ * @param free_data Function called to free @p data
*
- * List of gendrid examples:
- * @li @ref gengrid_example
- */
-
- /**
- * @addtogroup Gengrid
- * @{
+ * @see elm_box_layout_transition()
*/
-
- typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
- typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
- typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
- typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
- typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
- typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
- typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
-
+ 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);
/**
- * @struct _Elm_Gengrid_Item_Class
+ * Special layout function that animates the transition from one layout to another
*
- * Gengrid item class definition. See @ref Gengrid_Item_Class for
- * field details.
- */
- struct _Elm_Gengrid_Item_Class
- {
- const char *item_style;
- struct _Elm_Gengrid_Item_Class_Func
- {
- GridItemLabelGetFunc label_get;
- GridItemIconGetFunc icon_get;
- GridItemStateGetFunc state_get;
- GridItemDelFunc del;
- } func;
- }; /**< #Elm_Gengrid_Item_Class member definitions */
-
- /**
- * Add a new gengrid widget to the given parent Elementary
- * (container) object
+ * Normally, when switching the layout function for a box, this will be
+ * reflected immediately on screen on the next render, but it's also
+ * possible to do this through an animated transition.
*
- * @param parent The parent object
- * @return a new gengrid widget handle or @c NULL, on errors
+ * This is done by creating an ::Elm_Box_Transition and setting the box
+ * layout to this function.
*
- * This function inserts a new gengrid widget on the canvas.
+ * For example:
+ * @code
+ * Elm_Box_Transition *t = elm_box_transition_new(1.0,
+ * evas_object_box_layout_vertical, // start
+ * NULL, // data for initial layout
+ * NULL, // free function for initial data
+ * evas_object_box_layout_horizontal, // end
+ * NULL, // data for final layout
+ * NULL, // free function for final data
+ * anim_end, // will be called when animation ends
+ * NULL); // data for anim_end function\
+ * elm_box_layout_set(box, elm_box_layout_transition, t,
+ * elm_box_transition_free);
+ * @endcode
*
- * @see elm_gengrid_item_size_set()
- * @see elm_gengrid_horizontal_set()
- * @see elm_gengrid_item_append()
- * @see elm_gengrid_item_del()
- * @see elm_gengrid_clear()
+ * @note This function can only be used with elm_box_layout_set(). Calling
+ * it directly will not have the expected results.
*
- * @ingroup Gengrid
+ * @see elm_box_transition_new
+ * @see elm_box_transition_free
+ * @see elm_box_layout_set
*/
- EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
/**
- * Set the size for the items of a given gengrid widget
+ * Create a new ::Elm_Box_Transition to animate the switch of layouts
*
- * @param obj The gengrid object.
- * @param w The items' width.
- * @param h The items' height;
+ * If you want to animate the change from one layout to another, you need
+ * to set the layout function of the box to elm_box_layout_transition(),
+ * passing as user data to it an instance of ::Elm_Box_Transition with the
+ * necessary information to perform this animation. The free function to
+ * set for the layout is elm_box_transition_free().
*
- * A gengrid, after creation, has still no information on the size
- * to give to each of its cells. So, you most probably will end up
- * with squares one @ref Fingers "finger" wide, the default
- * size. Use this function to force a custom size for you items,
- * making them as big as you wish.
+ * The parameters to create an ::Elm_Box_Transition sum up to how long
+ * will it be, in seconds, a layout function to describe the initial point,
+ * another for the final position of the children and one function to be
+ * called when the whole animation ends. This last function is useful to
+ * set the definitive layout for the box, usually the same as the end
+ * layout for the animation, but could be used to start another transition.
*
- * @see elm_gengrid_item_size_get()
+ * @param start_layout The layout function that will be used to start the animation
+ * @param start_layout_data The data to be passed the @p start_layout function
+ * @param start_layout_free_data Function to free @p start_layout_data
+ * @param end_layout The layout function that will be used to end the animation
+ * @param end_layout_free_data The data to be passed the @p end_layout function
+ * @param end_layout_free_data Function to free @p end_layout_data
+ * @param transition_end_cb Callback function called when animation ends
+ * @param transition_end_data Data to be passed to @p transition_end_cb
+ * @return An instance of ::Elm_Box_Transition
*
- * @ingroup Gengrid
+ * @see elm_box_transition_new
+ * @see elm_box_layout_transition
*/
- EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
-
+ 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);
/**
- * Get the size set for the items of a given gengrid widget
- *
- * @param obj The gengrid object.
- * @param w Pointer to a variable where to store the items' width.
- * @param h Pointer to a variable where to store the items' height.
+ * Free a Elm_Box_Transition instance created with elm_box_transition_new().
*
- * @note Use @c NULL pointers on the size values you're not
- * interested in: they'll be ignored by the function.
+ * This function is mostly useful as the @c free_data parameter in
+ * elm_box_layout_set() when elm_box_layout_transition().
*
- * @see elm_gengrid_item_size_get() for more details
+ * @param data The Elm_Box_Transition instance to be freed.
*
- * @ingroup Gengrid
+ * @see elm_box_transition_new
+ * @see elm_box_layout_transition
+ */
+ EAPI void elm_box_transition_free(void *data);
+ /**
+ * @}
*/
- EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
+ /* button */
/**
- * Set the items grid's alignment within a given gengrid widget
+ * @defgroup Button Button
*
- * @param obj The gengrid object.
- * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
- * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
+ * @image html img/widget/button/preview-00.png
+ * @image latex img/widget/button/preview-00.eps
+ * @image html img/widget/button/preview-01.png
+ * @image latex img/widget/button/preview-01.eps
+ * @image html img/widget/button/preview-02.png
+ * @image latex img/widget/button/preview-02.eps
*
- * This sets the alignment of the whole grid of items of a gengrid
- * within its given viewport. By default, those values are both
- * 0.5, meaning that the gengrid will have its items grid placed
- * exactly in the middle of its viewport.
+ * This is a push-button. Press it and run some function. It can contain
+ * a simple label and icon object and it also has an autorepeat feature.
*
- * @note If given alignment values are out of the cited ranges,
- * they'll be changed to the nearest boundary values on the valid
- * ranges.
+ * This widgets emits the following signals:
+ * @li "clicked": the user clicked the button (press/release).
+ * @li "repeated": the user pressed the button without releasing it.
+ * @li "pressed": button was pressed.
+ * @li "unpressed": button was released after being pressed.
+ * In all three cases, the @c event parameter of the callback will be
+ * @c NULL.
*
- * @see elm_gengrid_align_get()
+ * Also, defined in the default theme, the button has the following styles
+ * available:
+ * @li default: a normal button.
+ * @li anchor: Like default, but the button fades away when the mouse is not
+ * over it, leaving only the text or icon.
+ * @li hoversel_vertical: Internally used by @ref Hoversel to give a
+ * continuous look across its options.
+ * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
*
- * @ingroup Gengrid
+ * Follow through a complete example @ref button_example_01 "here".
+ * @{
*/
- EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
-
/**
- * Get the items grid's alignment values within a given gengrid
- * widget
+ * Add a new button to the parent's canvas
*
- * @param obj The gengrid object.
- * @param align_x Pointer to a variable where to store the
- * horizontal alignment.
- * @param align_y Pointer to a variable where to store the vertical
- * alignment.
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ */
+ EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * Set the label used in the button
*
- * @note Use @c NULL pointers on the alignment values you're not
- * interested in: they'll be ignored by the function.
- *
- * @see elm_gengrid_align_set() for more details
+ * The passed @p label can be NULL to clean any existing text in it and
+ * leave the button as an icon only object.
*
- * @ingroup Gengrid
+ * @param obj The button object
+ * @param label The text will be written on the button
+ * @deprecated use elm_object_text_set() instead.
*/
- EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
-
+ EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
/**
- * Set whether a given gengrid widget is or not able have items
- * @b reordered
- *
- * @param obj The gengrid object
- * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
- * @c EINA_FALSE to turn it off
- *
- * If a gengrid is set to allow reordering, a click held for more
- * than 0.5 over a given item will highlight it specially,
- * signalling the gengrid has entered the reordering state. From
- * that time on, the user will be able to, while still holding the
- * mouse button down, move the item freely in the gengrid's
- * viewport, replacing to said item to the locations it goes to.
- * The replacements will be animated and, whenever the user
- * releases the mouse button, the item being replaced gets a new
- * definitive place in the grid.
+ * Get the label set for the button
*
- * @see elm_gengrid_reorder_mode_get()
+ * The string returned is an internal pointer and should not be freed or
+ * altered. It will also become invalid when the button is destroyed.
+ * The string returned, if not NULL, is a stringshare, so if you need to
+ * keep it around even after the button is destroyed, you can use
+ * eina_stringshare_ref().
*
- * @ingroup Gengrid
+ * @param obj The button object
+ * @return The text set to the label, or NULL if nothing is set
+ * @deprecated use elm_object_text_set() instead.
*/
- EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
-
+ EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get whether a given gengrid widget is or not able have items
- * @b reordered
- *
- * @param obj The gengrid object
- * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
- * off
+ * Set the icon used for the button
*
- * @see elm_gengrid_reorder_mode_set() for more details
+ * Setting a new icon will delete any other that was previously set, making
+ * any reference to them invalid. If you need to maintain the previous
+ * object alive, unset it first with elm_button_icon_unset().
*
- * @ingroup Gengrid
+ * @param obj The button object
+ * @param icon The icon object for the button
*/
- EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
/**
- * Append a new item in a given gengrid widget.
- *
- * @param obj The gengrid object.
- * @param gic The item class for the item.
- * @param data The item data.
- * @param func Convenience function called when the item is
- * selected.
- * @param func_data Data to be passed to @p func.
- * @return A handle to the item added or @c NULL, on errors.
+ * Get the icon used for the button
*
- * This adds an item to the beginning of the gengrid.
+ * Return the icon object which is set for this widget. If the button is
+ * destroyed or another icon is set, the returned object will be deleted
+ * and any reference to it will be invalid.
*
- * @see elm_gengrid_item_prepend()
- * @see elm_gengrid_item_insert_before()
- * @see elm_gengrid_item_insert_after()
- * @see elm_gengrid_item_del()
+ * @param obj The button object
+ * @return The icon object that is being used
*
- * @ingroup Gengrid
+ * @see elm_button_icon_unset()
*/
- 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);
-
+ EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Prepend a new item in a given gengrid widget.
- *
- * @param obj The gengrid object.
- * @param gic The item class for the item.
- * @param data The item data.
- * @param func Convenience function called when the item is
- * selected.
- * @param func_data Data to be passed to @p func.
- * @return A handle to the item added or @c NULL, on errors.
- *
- * This adds an item to the end of the gengrid.
+ * Remove the icon set without deleting it and return the object
*
- * @see elm_gengrid_item_append()
- * @see elm_gengrid_item_insert_before()
- * @see elm_gengrid_item_insert_after()
- * @see elm_gengrid_item_del()
+ * This function drops the reference the button holds of the icon object
+ * and returns this last object. It is used in case you want to remove any
+ * icon, or set another one, without deleting the actual object. The button
+ * will be left without an icon set.
*
- * @ingroup Gengrid
+ * @param obj The button object
+ * @return The icon object that was being used
*/
- 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);
-
+ EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Insert an item before another in a gengrid widget
- *
- * @param obj The gengrid object.
- * @param gic The item class for the item.
- * @param data The item data.
- * @param relative The item to place this new one before.
- * @param func Convenience function called when the item is
- * selected.
- * @param func_data Data to be passed to @p func.
- * @return A handle to the item added or @c NULL, on errors.
+ * Turn on/off the autorepeat event generated when the button is kept pressed
*
- * This inserts an item before another in the gengrid.
+ * When off, no autorepeat is performed and buttons emit a normal @c clicked
+ * signal when they are clicked.
*
- * @see elm_gengrid_item_append()
- * @see elm_gengrid_item_prepend()
- * @see elm_gengrid_item_insert_after()
- * @see elm_gengrid_item_del()
+ * When on, keeping a button pressed will continuously emit a @c repeated
+ * signal until the button is released. The time it takes until it starts
+ * emitting the signal is given by
+ * elm_button_autorepeat_initial_timeout_set(), and the time between each
+ * new emission by elm_button_autorepeat_gap_timeout_set().
*
- * @ingroup Gengrid
+ * @param obj The button object
+ * @param on A bool to turn on/off the event
*/
- 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);
-
+ EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
/**
- * Insert an item after another in a gengrid widget
- *
- * @param obj The gengrid object.
- * @param gic The item class for the item.
- * @param data The item data.
- * @param relative The item to place this new one after.
- * @param func Convenience function called when the item is
- * selected.
- * @param func_data Data to be passed to @p func.
- * @return A handle to the item added or @c NULL, on errors.
- *
- * This inserts an item after another in the gengrid.
+ * Get whether the autorepeat feature is enabled
*
- * @see elm_gengrid_item_append()
- * @see elm_gengrid_item_prepend()
- * @see elm_gengrid_item_insert_after()
- * @see elm_gengrid_item_del()
+ * @param obj The button object
+ * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
*
- * @ingroup Gengrid
+ * @see elm_button_autorepeat_set()
*/
- 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);
-
- EAPI Elm_Gengrid_Item *elm_gengrid_item_sorted_insert(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
-
- EAPI Elm_Gengrid_Item *elm_gengrid_item_direct_sorted_insert(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
-
+ EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set whether items on a given gengrid widget are to get their
- * selection callbacks issued for @b every subsequent selection
- * click on them or just for the first click.
- *
- * @param obj The gengrid object
- * @param always_select @c EINA_TRUE to make items "always
- * selected", @c EINA_FALSE, otherwise
- *
- * By default, grid items will only call their selection callback
- * function when firstly getting selected, any subsequent further
- * clicks will do nothing. With this call, you make those
- * subsequent clicks also to issue the selection callbacks.
+ * Set the initial timeout before the autorepeat event is generated
*
- * @note <b>Double clicks</b> will @b always be reported on items.
+ * Sets the timeout, in seconds, since the button is pressed until the
+ * first @c repeated signal is emitted. If @p t is 0.0 or less, there
+ * won't be any delay and the even will be fired the moment the button is
+ * pressed.
*
- * @see elm_gengrid_always_select_mode_get()
+ * @param obj The button object
+ * @param t Timeout in seconds
*
- * @ingroup Gengrid
+ * @see elm_button_autorepeat_set()
+ * @see elm_button_autorepeat_gap_timeout_set()
*/
- EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
/**
- * Get whether items on a given gengrid widget have their selection
- * callbacks issued for @b every subsequent selection click on them
- * or just for the first click.
- *
- * @param obj The gengrid object.
- * @return @c EINA_TRUE if the gengrid items are "always selected",
- * @c EINA_FALSE, otherwise
+ * Get the initial timeout before the autorepeat event is generated
*
- * @see elm_gengrid_always_select_mode_set() for more details
+ * @param obj The button object
+ * @return Timeout in seconds
*
- * @ingroup Gengrid
+ * @see elm_button_autorepeat_initial_timeout_set()
*/
- EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set whether items on a given gengrid widget can be selected or not.
- *
- * @param obj The gengrid object
- * @param no_select @c EINA_TRUE to make items selectable,
- * @c EINA_FALSE otherwise
+ * Set the interval between each generated autorepeat event
*
- * This will make items in @obj selectable or not. In the latter
- * case, any user interacion on the gendrid items will neither make
- * them appear selected nor them call their selection callback
- * functions.
+ * After the first @c repeated event is fired, all subsequent ones will
+ * follow after a delay of @p t seconds for each.
*
- * @see elm_gengrid_no_select_mode_get()
+ * @param obj The button object
+ * @param t Interval in seconds
*
- * @ingroup Gengrid
+ * @see elm_button_autorepeat_initial_timeout_set()
*/
- EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
/**
- * Get whether items on a given gengrid widget can be selected or
- * not.
- *
- * @param obj The gengrid object
- * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
- * otherwise
- *
- * @see elm_gengrid_no_select_mode_set() for more details
+ * Get the interval between each generated autorepeat event
*
- * @ingroup Gengrid
+ * @param obj The button object
+ * @return Interval in seconds
+ */
+ EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @}
*/
- EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Enable or disable multi-selection in a given gengrid widget
+ * @defgroup File_Selector_Button File Selector Button
*
- * @param obj The gengrid object.
- * @param multi @c EINA_TRUE, to enable multi-selection,
- * @c EINA_FALSE to disable it.
+ * @image html img/widget/fileselector_button/preview-00.png
+ * @image latex img/widget/fileselector_button/preview-00.eps
+ * @image html img/widget/fileselector_button/preview-01.png
+ * @image latex img/widget/fileselector_button/preview-01.eps
+ * @image html img/widget/fileselector_button/preview-02.png
+ * @image latex img/widget/fileselector_button/preview-02.eps
*
- * Multi-selection is the ability for one to have @b more than one
- * item selected, on a given gengrid, simultaneously. When it is
- * enabled, a sequence of clicks on different items will make them
- * all selected, progressively. A click on an already selected item
- * will unselect it. If interecting via the keyboard,
- * multi-selection is enabled while holding the "Shift" key.
+ * This is a button that, when clicked, creates an Elementary
+ * window (or inner window) <b> with a @ref Fileselector "file
+ * selector widget" within</b>. When a file is chosen, the (inner)
+ * window is closed and the button emits a signal having the
+ * selected file as it's @c event_info.
*
- * @note By default, multi-selection is @b disabled on gengrids
+ * This widget encapsulates operations on its internal file
+ * selector on its own API. There is less control over its file
+ * selector than that one would have instatiating one directly.
*
- * @see elm_gengrid_multi_select_get()
+ * The following styles are available for this button:
+ * @li @c "default"
+ * @li @c "anchor"
+ * @li @c "hoversel_vertical"
+ * @li @c "hoversel_vertical_entry"
*
- * @ingroup Gengrid
+ * Smart callbacks one can register to:
+ * - @c "file,chosen" - the user has selected a path, whose string
+ * pointer comes as the @c event_info data (a stringshared
+ * string)
+ *
+ * Here is an example on its usage:
+ * @li @ref fileselector_button_example
+ *
+ * @see @ref File_Selector_Entry for a similar widget.
+ * @{
*/
- EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
/**
- * Get whether multi-selection is enabled or disabled for a given
- * gengrid widget
- *
- * @param obj The gengrid object.
- * @return @c EINA_TRUE, if multi-selection is enabled, @c
- * EINA_FALSE otherwise
- *
- * @see elm_gengrid_multi_select_set() for more details
+ * Add a new file selector button widget to the given parent
+ * Elementary (container) object
*
- * @ingroup Gengrid
+ * @param parent The parent object
+ * @return a new file selector button widget handle or @c NULL, on
+ * errors
*/
- EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Enable or disable bouncing effect for a given gengrid widget
- *
- * @param obj The gengrid object
- * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
- * @c EINA_FALSE to disable it
- * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
- * @c EINA_FALSE to disable it
- *
- * The bouncing effect occurs whenever one reaches the gengrid's
- * edge's while panning it -- it will scroll past its limits a
- * little bit and return to the edge again, in a animated for,
- * automatically.
- *
- * @note By default, gengrids have bouncing enabled on both axis
+ * Set the label for a given file selector button widget
*
- * @see elm_gengrid_bounce_get()
+ * @param obj The file selector button widget
+ * @param label The text label to be displayed on @p obj
*
- * @ingroup Gengrid
+ * @deprecated use elm_object_text_set() instead.
*/
- EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
/**
- * Get whether bouncing effects are enabled or disabled, for a
- * given gengrid widget, on each axis
- *
- * @param obj The gengrid object
- * @param h_bounce Pointer to a variable where to store the
- * horizontal bouncing flag.
- * @param v_bounce Pointer to a variable where to store the
- * vertical bouncing flag.
+ * Get the label set for a given file selector button widget
*
- * @see elm_gengrid_bounce_set() for more details
+ * @param obj The file selector button widget
+ * @return The button label
*
- * @ingroup Gengrid
+ * @deprecated use elm_object_text_set() instead.
*/
- EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set a given gengrid widget's scrolling page size, relative to
- * its viewport size.
- *
- * @param obj The gengrid object
- * @param h_pagerel The horizontal page (relative) size
- * @param v_pagerel The vertical page (relative) size
- *
- * The gengrid's scroller is capable of binding scrolling by the
- * user to "pages". It means that, while scrolling and, specially
- * after releasing the mouse button, the grid will @b snap to the
- * nearest displaying page's area. When page sizes are set, the
- * grid's continuous content area is split into (equal) page sized
- * pieces.
- *
- * This function sets the size of a page <b>relatively to the
- * viewport dimensions</b> of the gengrid, for each axis. A value
- * @c 1.0 means "the exact viewport's size", in that axis, while @c
- * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
- * a viewport". Sane usable values are, than, between @c 0.0 and @c
- * 1.0. Values beyond those will make it behave behave
- * inconsistently. If you only want one axis to snap to pages, use
- * the value @c 0.0 for the other one.
+ * Set the icon on a given file selector button widget
*
- * There is a function setting page size values in @b absolute
- * values, too -- elm_gengrid_page_size_set(). Naturally, its use
- * is mutually exclusive to this one.
+ * @param obj The file selector button widget
+ * @param icon The icon object for the button
*
- * @see elm_gengrid_page_relative_get()
+ * Once the icon object is set, a previously set one will be
+ * deleted. If you want to keep the latter, use the
+ * elm_fileselector_button_icon_unset() function.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_button_icon_get()
*/
- EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
/**
- * Get a given gengrid widget's scrolling page size, relative to
- * its viewport size.
- *
- * @param obj The gengrid object
- * @param h_pagerel Pointer to a variable where to store the
- * horizontal page (relative) size
- * @param v_pagerel Pointer to a variable where to store the
- * vertical page (relative) size
+ * Get the icon set for a given file selector button widget
*
- * @see elm_gengrid_page_relative_set() for more details
+ * @param obj The file selector button widget
+ * @return The icon object currently set on @p obj or @c NULL, if
+ * none is
*
- * @ingroup Gengrid
+ * @see elm_fileselector_button_icon_set()
*/
- EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set a given gengrid widget's scrolling page size
- *
- * @param obj The gengrid object
- * @param h_pagerel The horizontal page size, in pixels
- * @param v_pagerel The vertical page size, in pixels
- *
- * The gengrid's scroller is capable of binding scrolling by the
- * user to "pages". It means that, while scrolling and, specially
- * after releasing the mouse button, the grid will @b snap to the
- * nearest displaying page's area. When page sizes are set, the
- * grid's continuous content area is split into (equal) page sized
- * pieces.
+ * Unset the icon used in a given file selector button widget
*
- * This function sets the size of a page of the gengrid, in pixels,
- * for each axis. Sane usable values are, between @c 0 and the
- * dimensions of @p obj, for each axis. Values beyond those will
- * make it behave behave inconsistently. If you only want one axis
- * to snap to pages, use the value @c 0 for the other one.
+ * @param obj The file selector button widget
+ * @return The icon object that was being used on @p obj or @c
+ * NULL, on errors
*
- * There is a function setting page size values in @b relative
- * values, too -- elm_gengrid_page_relative_set(). Naturally, its
- * use is mutually exclusive to this one.
+ * Unparent and return the icon object which was set for this
+ * widget.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_button_icon_set()
*/
- EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set for what direction a given gengrid widget will expand while
- * placing its items.
+ * Set the title for a given file selector button widget's window
*
- * @param obj The gengrid object.
- * @param setting @c EINA_TRUE to make the gengrid expand
- * horizontally, @c EINA_FALSE to expand vertically.
+ * @param obj The file selector button widget
+ * @param title The title string
*
- * When in "horizontal mode" (@c EINA_TRUE), items will be placed
- * in @b columns, from top to bottom and, when the space for a
- * column is filled, another one is started on the right, thus
- * expanding the grid horizontally. When in "vertical mode"
- * (@c EINA_FALSE), though, items will be placed in @b rows, from left
- * to right and, when the space for a row is filled, another one is
- * started below, thus expanding the grid vertically.
+ * This will change the window's title, when the file selector pops
+ * out after a click on the button. Those windows have the default
+ * (unlocalized) value of @c "Select a file" as titles.
*
- * @see elm_gengrid_horizontal_get()
+ * @note It will only take any effect if the file selector
+ * button widget is @b not under "inwin mode".
*
- * @ingroup Gengrid
+ * @see elm_fileselector_button_window_title_get()
*/
- EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
/**
- * Get for what direction a given gengrid widget will expand while
- * placing its items.
- *
- * @param obj The gengrid object.
- * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
- * @c EINA_FALSE if it's set to expand vertically.
+ * Get the title set for a given file selector button widget's
+ * window
*
- * @see elm_gengrid_horizontal_set() for more detais
+ * @param obj The file selector button widget
+ * @return Title of the file selector button's window
*
- * @ingroup Gengrid
+ * @see elm_fileselector_button_window_title_get() for more details
*/
- EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the first item in a given gengrid widget
- *
- * @param obj The gengrid object
- * @return The first item's handle or @c NULL, if there are no
- * items in @p obj (and on errors)
+ * Set the size of a given file selector button widget's window,
+ * holding the file selector itself.
*
- * This returns the first item in the @p obj's internal list of
- * items.
+ * @param obj The file selector button widget
+ * @param width The window's width
+ * @param height The window's height
*
- * @see elm_gengrid_last_item_get()
+ * @note it will only take any effect if the file selector button
+ * widget is @b not under "inwin mode". The default size for the
+ * window (when applicable) is 400x400 pixels.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_button_window_size_get()
*/
- EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
/**
- * Get the last item in a given gengrid widget
- *
- * @param obj The gengrid object
- * @return The last item's handle or @c NULL, if there are no
- * items in @p obj (and on errors)
+ * Get the size of a given file selector button widget's window,
+ * holding the file selector itself.
*
- * This returns the last item in the @p obj's internal list of
- * items.
+ * @param obj The file selector button widget
+ * @param width Pointer into which to store the width value
+ * @param height Pointer into which to store the height value
*
- * @see elm_gengrid_first_item_get()
+ * @note Use @c NULL pointers on the size values you're not
+ * interested in: they'll be ignored by the function.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_button_window_size_set(), for more details
*/
- EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
/**
- * Get the @b next item in a gengrid widget's internal list of items,
- * given a handle to one of those items.
+ * Set the initial file system path for a given file selector
+ * button widget
*
- * @param item The gengrid item to fetch next from
- * @return The item after @p item, or @c NULL if there's none (and
- * on errors)
+ * @param obj The file selector button widget
+ * @param path The path string
*
- * This returns the item placed after the @p item, on the container
- * gengrid.
- *
- * @see elm_gengrid_item_prev_get()
+ * It must be a <b>directory</b> path, which will have the contents
+ * displayed initially in the file selector's view, when invoked
+ * from @p obj. The default initial path is the @c "HOME"
+ * environment variable's value.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_button_path_get()
*/
- EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
/**
- * Get the @b previous item in a gengrid widget's internal list of items,
- * given a handle to one of those items.
- *
- * @param item The gengrid item to fetch previous from
- * @return The item before @p item, or @c NULL if there's none (and
- * on errors)
- *
- * This returns the item placed before the @p item, on the container
- * gengrid.
+ * Get the initial file system path set for a given file selector
+ * button widget
*
- * @see elm_gengrid_item_next_get()
+ * @param obj The file selector button widget
+ * @return path The path string
*
- * @ingroup Gengrid
+ * @see elm_fileselector_button_path_set() for more details
*/
- EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the gengrid object's handle which contains a given gengrid
- * item
- *
- * @param item The item to fetch the container from
- * @return The gengrid (parent) object
- *
- * This returns the gengrid object itself that an item belongs to.
+ * Enable/disable a tree view in the given file selector button
+ * widget's internal file selector
*
- * @ingroup Gengrid
- */
- EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
-
- /**
- * Remove a gengrid item from the its parent, deleting it.
+ * @param obj The file selector button widget
+ * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
+ * disable
*
- * @param item The item to be removed.
- * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
+ * This has the same effect as elm_fileselector_expandable_set(),
+ * but now applied to a file selector button's internal file
+ * selector.
*
- * @see elm_gengrid_clear(), to remove all items in a gengrid at
- * once.
+ * @note There's no way to put a file selector button's internal
+ * file selector in "grid mode", as one may do with "pure" file
+ * selectors.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_expandable_get()
*/
- EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
/**
- * Update the contents of a given gengrid item
- *
- * @param item The gengrid item
+ * Get whether tree view is enabled for the given file selector
+ * button widget's internal file selector
*
- * This updates an item by calling all the item class functions
- * again to get the icons, labels and states. Use this when the
- * original item data has changed and you want thta changes to be
- * reflected.
+ * @param obj The file selector button widget
+ * @return @c EINA_TRUE if @p obj widget's internal file selector
+ * is in tree view, @c EINA_FALSE otherwise (and or errors)
*
- * @ingroup Gengrid
+ * @see elm_fileselector_expandable_set() for more details
*/
- EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
- EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
- EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
+ EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Return the data associated to a given gengrid item
- *
- * @param item The gengrid item.
- * @return the data associated to this item.
+ * Set whether a given file selector button widget's internal file
+ * selector is to display folders only or the directory contents,
+ * as well.
*
- * This returns the @c data value passed on the
- * elm_gengrid_item_append() and related item addition calls.
+ * @param obj The file selector button widget
+ * @param only @c EINA_TRUE to make @p obj widget's internal file
+ * selector only display directories, @c EINA_FALSE to make files
+ * to be displayed in it too
*
- * @see elm_gengrid_item_append()
- * @see elm_gengrid_item_data_set()
+ * This has the same effect as elm_fileselector_folder_only_set(),
+ * but now applied to a file selector button's internal file
+ * selector.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_folder_only_get()
*/
- EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
/**
- * Set the data associated to a given gengrid item
- *
- * @param item The gengrid item
- * @param data The new data pointer to set on it
- *
- * This @b overrides the @c data value passed on the
- * elm_gengrid_item_append() and related item addition calls. This
- * function @b won't call elm_gengrid_item_update() automatically,
- * so you'd issue it afterwards if you want to hove the item
- * updated to reflect the that new data.
+ * Get whether a given file selector button widget's internal file
+ * selector is displaying folders only or the directory contents,
+ * as well.
*
- * @see elm_gengrid_item_data_get()
+ * @param obj The file selector button widget
+ * @return @c EINA_TRUE if @p obj widget's internal file
+ * selector is only displaying directories, @c EINA_FALSE if files
+ * are being displayed in it too (and on errors)
*
- * @ingroup Gengrid
+ * @see elm_fileselector_button_folder_only_set() for more details
*/
- EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get a given gengrid item's position, relative to the whole
- * gengrid's grid area.
+ * Enable/disable the file name entry box where the user can type
+ * in a name for a file, in a given file selector button widget's
+ * internal file selector.
*
- * @param item The Gengrid item.
- * @param x Pointer to variable where to store the item's <b>row
- * number</b>.
- * @param y Pointer to variable where to store the item's <b>column
- * number</b>.
+ * @param obj The file selector button widget
+ * @param is_save @c EINA_TRUE to make @p obj widget's internal
+ * file selector a "saving dialog", @c EINA_FALSE otherwise
*
- * This returns the "logical" position of the item whithin the
- * gengrid. For example, @c (0, 1) would stand for first row,
- * second column.
+ * This has the same effect as elm_fileselector_is_save_set(),
+ * but now applied to a file selector button's internal file
+ * selector.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_is_save_get()
*/
- EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
/**
- * Set whether a given gengrid item is selected or not
- *
- * @param item The gengrid item
- * @param selected Use @c EINA_TRUE, to make it selected, @c
- * EINA_FALSE to make it unselected
- *
- * This sets the selected state of an item. If multi selection is
- * not enabled on the containing gengrid and @p selected is @c
- * EINA_TRUE, any other previously selected items will get
- * unselected in favor of this new one.
+ * Get whether the given file selector button widget's internal
+ * file selector is in "saving dialog" mode
*
- * @see elm_gengrid_item_selected_get()
+ * @param obj The file selector button widget
+ * @return @c EINA_TRUE, if @p obj widget's internal file selector
+ * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
+ * errors)
*
- * @ingroup Gengrid
+ * @see elm_fileselector_button_is_save_set() for more details
*/
- EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get whether a given gengrid item is selected or not
- *
- * @param item The gengrid item
- * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
+ * Set whether a given file selector button widget's internal file
+ * selector will raise an Elementary "inner window", instead of a
+ * dedicated Elementary window. By default, it won't.
*
- * @see elm_gengrid_item_selected_set() for more details
+ * @param obj The file selector button widget
+ * @param value @c EINA_TRUE to make it use an inner window, @c
+ * EINA_TRUE to make it use a dedicated window
*
- * @ingroup Gengrid
+ * @see elm_win_inwin_add() for more information on inner windows
+ * @see elm_fileselector_button_inwin_mode_get()
*/
- EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
/**
- * Get the real Evas object created to implement the view of a
- * given gengrid item
- *
- * @param item The gengrid item.
- * @return the Evas object implementing this item's view.
- *
- * This returns the actual Evas object used to implement the
- * specified gengrid item's view. This may be @c NULL, as it may
- * not have been created or may have been deleted, at any time, by
- * the gengrid. <b>Do not modify this object</b> (move, resize,
- * show, hide, etc.), as the gengrid is controlling it. This
- * function is for querying, emitting custom signals or hooking
- * lower level callbacks for events on that object. Do not delete
- * this object under any circumstances.
+ * Get whether a given file selector button widget's internal file
+ * selector will raise an Elementary "inner window", instead of a
+ * dedicated Elementary window.
*
- * @see elm_gengrid_item_data_get()
+ * @param obj The file selector button widget
+ * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
+ * if it will use a dedicated window
*
- * @ingroup Gengrid
+ * @see elm_fileselector_button_inwin_mode_set() for more details
*/
- EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Show the portion of a gengrid's internal grid containing a given
- * item, @b immediately.
- *
- * @param item The item to display
- *
- * This causes gengrid to @b redraw its viewport's contents to the
- * region contining the given @p item item, if it is not fully
- * visible.
- *
- * @see elm_gengrid_item_bring_in()
- *
- * @ingroup Gengrid
+ * @}
*/
- EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
- /**
- * Animatedly bring in, to the visible are of a gengrid, a given
- * item on it.
+ /**
+ * @defgroup File_Selector_Entry File Selector Entry
*
- * @param item The gengrid item to display
+ * @image html img/widget/fileselector_entry/preview-00.png
+ * @image latex img/widget/fileselector_entry/preview-00.eps
*
- * This causes gengrig to jump to the given @p item item and show
- * it (by scrolling), if it is not fully visible. This will use
- * animation to do so and take a period of time to complete.
+ * This is an entry made to be filled with or display a <b>file
+ * system path string</b>. Besides the entry itself, the widget has
+ * a @ref File_Selector_Button "file selector button" on its side,
+ * which will raise an internal @ref Fileselector "file selector widget",
+ * when clicked, for path selection aided by file system
+ * navigation.
*
- * @see elm_gengrid_item_show()
+ * This file selector may appear in an Elementary window or in an
+ * inner window. When a file is chosen from it, the (inner) window
+ * is closed and the selected file's path string is exposed both as
+ * an smart event and as the new text on the entry.
*
- * @ingroup Gengrid
- */
- EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
-
- /**
- * Set whether a given gengrid item is disabled or not.
+ * This widget encapsulates operations on its internal file
+ * selector on its own API. There is less control over its file
+ * selector than that one would have instatiating one directly.
*
- * @param item The gengrid item
- * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
- * to enable it back.
- *
- * A disabled item cannot be selected or unselected. It will also
- * change its appearance, to signal the user it's disabled.
+ * Smart callbacks one can register to:
+ * - @c "changed" - The text within the entry was changed
+ * - @c "activated" - The entry has had editing finished and
+ * changes are to be "committed"
+ * - @c "press" - The entry has been clicked
+ * - @c "longpressed" - The entry has been clicked (and held) for a
+ * couple seconds
+ * - @c "clicked" - The entry has been clicked
+ * - @c "clicked,double" - The entry has been double clicked
+ * - @c "focused" - The entry has received focus
+ * - @c "unfocused" - The entry has lost focus
+ * - @c "selection,paste" - A paste action has occurred on the
+ * entry
+ * - @c "selection,copy" - A copy action has occurred on the entry
+ * - @c "selection,cut" - A cut action has occurred on the entry
+ * - @c "unpressed" - The file selector entry's button was released
+ * after being pressed.
+ * - @c "file,chosen" - The user has selected a path via the file
+ * selector entry's internal file selector, whose string pointer
+ * comes as the @c event_info data (a stringshared string)
*
- * @see elm_gengrid_item_disabled_get()
+ * Here is an example on its usage:
+ * @li @ref fileselector_entry_example
*
- * @ingroup Gengrid
+ * @see @ref File_Selector_Button for a similar widget.
+ * @{
*/
- EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
/**
- * Get whether a given gengrid item is disabled or not.
- *
- * @param item The gengrid item
- * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
- * (and on errors).
- *
- * @see elm_gengrid_item_disabled_set() for more details
+ * Add a new file selector entry widget to the given parent
+ * Elementary (container) object
*
- * @ingroup Gengrid
+ * @param parent The parent object
+ * @return a new file selector entry widget handle or @c NULL, on
+ * errors
*/
- EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Set the text to be shown in a given gengrid item's tooltips.
- *
- * @param item The gengrid item
- * @param text The text to set in the content
+ * Set the label for a given file selector entry widget's button
*
- * This call will setup the text to be used as tooltip to that item
- * (analogous to elm_object_tooltip_text_set(), but being item
- * tooltips with higher precedence than object tooltips). It can
- * have only one tooltip at a time, so any previous tooltip data
- * will get removed.
+ * @param obj The file selector entry widget
+ * @param label The text label to be displayed on @p obj widget's
+ * button
*
- * @ingroup Gengrid
+ * @deprecated use elm_object_text_set() instead.
*/
- EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
/**
- * Set the content to be shown in a given gengrid item's tooltips
- *
- * @param item The gengrid item.
- * @param func The function returning the tooltip contents.
- * @param data What to provide to @a func as callback data/context.
- * @param del_cb Called when data is not needed anymore, either when
- * another callback replaces @func, the tooltip is unset with
- * elm_gengrid_item_tooltip_unset() or the owner @p item
- * dies. This callback receives as its first parameter the
- * given @p data, being @c event_info the item handle.
+ * Get the label set for a given file selector entry widget's button
*
- * This call will setup the tooltip's contents to @p item
- * (analogous to elm_object_tooltip_content_cb_set(), but being
- * item tooltips with higher precedence than object tooltips). It
- * can have only one tooltip at a time, so any previous tooltip
- * content will get removed. @p func (with @p data) will be called
- * every time Elementary needs to show the tooltip and it should
- * return a valid Evas object, which will be fully managed by the
- * tooltip system, getting deleted when the tooltip is gone.
+ * @param obj The file selector entry widget
+ * @return The widget button's label
*
- * @ingroup Gengrid
+ * @deprecated use elm_object_text_set() instead.
*/
- 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);
+ EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Unset a tooltip from a given gengrid item
- *
- * @param item gengrid item to remove a previously set tooltip from.
+ * Set the icon on a given file selector entry widget's button
*
- * This call removes any tooltip set on @p item. The callback
- * provided as @c del_cb to
- * elm_gengrid_item_tooltip_content_cb_set() will be called to
- * notify it is not used anymore (and have resources cleaned, if
- * need be).
+ * @param obj The file selector entry widget
+ * @param icon The icon object for the entry's button
*
- * @see elm_gengrid_item_tooltip_content_cb_set()
+ * Once the icon object is set, a previously set one will be
+ * deleted. If you want to keep the latter, use the
+ * elm_fileselector_entry_button_icon_unset() function.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_entry_button_icon_get()
*/
- EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
/**
- * Set a different @b style for a given gengrid item's tooltip.
+ * Get the icon set for a given file selector entry widget's button
*
- * @param item gengrid item with tooltip set
- * @param style the <b>theme style</b> to use on tooltips (e.g. @c
- * "default", @c "transparent", etc)
+ * @param obj The file selector entry widget
+ * @return The icon object currently set on @p obj widget's button
+ * or @c NULL, if none is
*
- * Tooltips can have <b>alternate styles</b> to be displayed on,
- * which are defined by the theme set on Elementary. This function
- * works analogously as elm_object_tooltip_style_set(), but here
- * applied only to gengrid item objects. The default style for
- * tooltips is @c "default".
+ * @see elm_fileselector_entry_button_icon_set()
+ */
+ EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Unset the icon used in a given file selector entry widget's
+ * button
*
- * @note before you set a style you should define a tooltip with
- * elm_gengrid_item_tooltip_content_cb_set() or
- * elm_gengrid_item_tooltip_text_set()
+ * @param obj The file selector entry widget
+ * @return The icon object that was being used on @p obj widget's
+ * button or @c NULL, on errors
*
- * @see elm_gengrid_item_tooltip_style_get()
+ * Unparent and return the icon object which was set for this
+ * widget's button.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_entry_button_icon_set()
*/
- EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the style set a given gengrid item's tooltip.
+ * Set the title for a given file selector entry widget's window
*
- * @param item gengrid item with tooltip already set on.
- * @return style the theme style in use, which defaults to
- * "default". If the object does not have a tooltip set,
- * then @c NULL is returned.
+ * @param obj The file selector entry widget
+ * @param title The title string
*
- * @see elm_gengrid_item_tooltip_style_set() for more details
+ * This will change the window's title, when the file selector pops
+ * out after a click on the entry's button. Those windows have the
+ * default (unlocalized) value of @c "Select a file" as titles.
*
- * @ingroup Gengrid
- */
- EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
- /**
- * @brief Disable size restrictions on an object's tooltip
- * @param item The tooltip's anchor object
- * @param disable If EINA_TRUE, size restrictions are disabled
- * @return EINA_FALSE on failure, EINA_TRUE on success
+ * @note It will only take any effect if the file selector
+ * entry widget is @b not under "inwin mode".
*
- * This function allows a tooltip to expand beyond its parant window's canvas.
- * It will instead be limited only by the size of the display.
+ * @see elm_fileselector_entry_window_title_get()
*/
- EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
+ EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
+
/**
- * @brief Retrieve size restriction state of an object's tooltip
- * @param item The tooltip's anchor object
- * @return If EINA_TRUE, size restrictions are disabled
+ * Get the title set for a given file selector entry widget's
+ * window
*
- * This function returns whether a tooltip is allowed to expand beyond
- * its parant window's canvas.
- * It will instead be limited only by the size of the display.
+ * @param obj The file selector entry widget
+ * @return Title of the file selector entry's window
+ *
+ * @see elm_fileselector_entry_window_title_get() for more details
*/
- EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
+ EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set the type of mouse pointer/cursor decoration to be shown,
- * when the mouse pointer is over the given gengrid widget item
- *
- * @param item gengrid item to customize cursor on
- * @param cursor the cursor type's name
- *
- * This function works analogously as elm_object_cursor_set(), but
- * here the cursor's changing area is restricted to the item's
- * area, and not the whole widget's. Note that that item cursors
- * have precedence over widget cursors, so that a mouse over @p
- * item will always show cursor @p type.
+ * Set the size of a given file selector entry widget's window,
+ * holding the file selector itself.
*
- * If this function is called twice for an object, a previously set
- * cursor will be unset on the second call.
+ * @param obj The file selector entry widget
+ * @param width The window's width
+ * @param height The window's height
*
- * @see elm_object_cursor_set()
- * @see elm_gengrid_item_cursor_get()
- * @see elm_gengrid_item_cursor_unset()
+ * @note it will only take any effect if the file selector entry
+ * widget is @b not under "inwin mode". The default size for the
+ * window (when applicable) is 400x400 pixels.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_entry_window_size_get()
*/
- EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
/**
- * Get the type of mouse pointer/cursor decoration set to be shown,
- * when the mouse pointer is over the given gengrid widget item
+ * Get the size of a given file selector entry widget's window,
+ * holding the file selector itself.
*
- * @param item gengrid item with custom cursor set
- * @return the cursor type's name or @c NULL, if no custom cursors
- * were set to @p item (and on errors)
+ * @param obj The file selector entry widget
+ * @param width Pointer into which to store the width value
+ * @param height Pointer into which to store the height value
*
- * @see elm_object_cursor_get()
- * @see elm_gengrid_item_cursor_set() for more details
- * @see elm_gengrid_item_cursor_unset()
+ * @note Use @c NULL pointers on the size values you're not
+ * interested in: they'll be ignored by the function.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_entry_window_size_set(), for more details
*/
- EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
/**
- * Unset any custom mouse pointer/cursor decoration set to be
- * shown, when the mouse pointer is over the given gengrid widget
- * item, thus making it show the @b default cursor again.
- *
- * @param item a gengrid item
+ * Set the initial file system path and the entry's path string for
+ * a given file selector entry widget
*
- * Use this call to undo any custom settings on this item's cursor
- * decoration, bringing it back to defaults (no custom style set).
+ * @param obj The file selector entry widget
+ * @param path The path string
*
- * @see elm_object_cursor_unset()
- * @see elm_gengrid_item_cursor_set() for more details
+ * It must be a <b>directory</b> path, which will have the contents
+ * displayed initially in the file selector's view, when invoked
+ * from @p obj. The default initial path is the @c "HOME"
+ * environment variable's value.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_entry_path_get()
*/
- EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
/**
- * Set a different @b style for a given custom cursor set for a
- * gengrid item.
+ * Get the entry's path string for a given file selector entry
+ * widget
*
- * @param item gengrid item with custom cursor set
- * @param style the <b>theme style</b> to use (e.g. @c "default",
- * @c "transparent", etc)
+ * @param obj The file selector entry widget
+ * @return path The path string
*
- * This function only makes sense when one is using custom mouse
- * cursor decorations <b>defined in a theme file</b> , which can
- * have, given a cursor name/type, <b>alternate styles</b> on
- * it. It works analogously as elm_object_cursor_style_set(), but
- * here applied only to gengrid item objects.
+ * @see elm_fileselector_entry_path_set() for more details
+ */
+ EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Enable/disable a tree view in the given file selector entry
+ * widget's internal file selector
*
- * @warning Before you set a cursor style you should have defined a
- * custom cursor previously on the item, with
- * elm_gengrid_item_cursor_set()
+ * @param obj The file selector entry widget
+ * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
+ * disable
*
- * @see elm_gengrid_item_cursor_engine_only_set()
- * @see elm_gengrid_item_cursor_style_get()
+ * This has the same effect as elm_fileselector_expandable_set(),
+ * but now applied to a file selector entry's internal file
+ * selector.
*
- * @ingroup Gengrid
+ * @note There's no way to put a file selector entry's internal
+ * file selector in "grid mode", as one may do with "pure" file
+ * selectors.
+ *
+ * @see elm_fileselector_expandable_get()
*/
- EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
/**
- * Get the current @b style set for a given gengrid item's custom
- * cursor
- *
- * @param item gengrid item with custom cursor set.
- * @return style the cursor style in use. If the object does not
- * have a cursor set, then @c NULL is returned.
+ * Get whether tree view is enabled for the given file selector
+ * entry widget's internal file selector
*
- * @see elm_gengrid_item_cursor_style_set() for more details
+ * @param obj The file selector entry widget
+ * @return @c EINA_TRUE if @p obj widget's internal file selector
+ * is in tree view, @c EINA_FALSE otherwise (and or errors)
*
- * @ingroup Gengrid
+ * @see elm_fileselector_expandable_set() for more details
*/
- EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set if the (custom) cursor for a given gengrid item should be
- * searched in its theme, also, or should only rely on the
- * rendering engine.
+ * Set whether a given file selector entry widget's internal file
+ * selector is to display folders only or the directory contents,
+ * as well.
*
- * @param item item with custom (custom) cursor already set on
- * @param engine_only Use @c EINA_TRUE to have cursors looked for
- * only on those provided by the rendering engine, @c EINA_FALSE to
- * have them searched on the widget's theme, as well.
+ * @param obj The file selector entry widget
+ * @param only @c EINA_TRUE to make @p obj widget's internal file
+ * selector only display directories, @c EINA_FALSE to make files
+ * to be displayed in it too
*
- * @note This call is of use only if you've set a custom cursor
- * for gengrid items, with elm_gengrid_item_cursor_set().
+ * This has the same effect as elm_fileselector_folder_only_set(),
+ * but now applied to a file selector entry's internal file
+ * selector.
*
- * @note By default, cursors will only be looked for between those
- * provided by the rendering engine.
+ * @see elm_fileselector_folder_only_get()
+ */
+ EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get whether a given file selector entry widget's internal file
+ * selector is displaying folders only or the directory contents,
+ * as well.
*
- * @ingroup Gengrid
+ * @param obj The file selector entry widget
+ * @return @c EINA_TRUE if @p obj widget's internal file
+ * selector is only displaying directories, @c EINA_FALSE if files
+ * are being displayed in it too (and on errors)
+ *
+ * @see elm_fileselector_entry_folder_only_set() for more details
*/
- EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get if the (custom) cursor for a given gengrid item is being
- * searched in its theme, also, or is only relying on the rendering
- * engine.
+ * Enable/disable the file name entry box where the user can type
+ * in a name for a file, in a given file selector entry widget's
+ * internal file selector.
*
- * @param item a gengrid item
- * @return @c EINA_TRUE, if cursors are being looked for only on
- * those provided by the rendering engine, @c EINA_FALSE if they
- * are being searched on the widget's theme, as well.
+ * @param obj The file selector entry widget
+ * @param is_save @c EINA_TRUE to make @p obj widget's internal
+ * file selector a "saving dialog", @c EINA_FALSE otherwise
*
- * @see elm_gengrid_item_cursor_engine_only_set(), for more details
+ * This has the same effect as elm_fileselector_is_save_set(),
+ * but now applied to a file selector entry's internal file
+ * selector.
*
- * @ingroup Gengrid
+ * @see elm_fileselector_is_save_get()
*/
- EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
/**
- * Remove all items from a given gengrid widget
+ * Get whether the given file selector entry widget's internal
+ * file selector is in "saving dialog" mode
*
- * @param obj The gengrid object.
+ * @param obj The file selector entry widget
+ * @return @c EINA_TRUE, if @p obj widget's internal file selector
+ * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
+ * errors)
*
- * This removes (and deletes) all items in @p obj, leaving it
- * empty.
+ * @see elm_fileselector_entry_is_save_set() for more details
+ */
+ EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set whether a given file selector entry widget's internal file
+ * selector will raise an Elementary "inner window", instead of a
+ * dedicated Elementary window. By default, it won't.
*
- * @see elm_gengrid_item_del(), to remove just one item.
+ * @param obj The file selector entry widget
+ * @param value @c EINA_TRUE to make it use an inner window, @c
+ * EINA_TRUE to make it use a dedicated window
*
- * @ingroup Gengrid
+ * @see elm_win_inwin_add() for more information on inner windows
+ * @see elm_fileselector_entry_inwin_mode_get()
*/
- EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
/**
- * Get the selected item in a given gengrid widget
- *
- * @param obj The gengrid object.
- * @return The selected item's handleor @c NULL, if none is
- * selected at the moment (and on errors)
+ * Get whether a given file selector entry widget's internal file
+ * selector will raise an Elementary "inner window", instead of a
+ * dedicated Elementary window.
*
- * This returns the selected item in @p obj. If multi selection is
- * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
- * the first item in the list is selected, which might not be very
- * useful. For that case, see elm_gengrid_selected_items_get().
+ * @param obj The file selector entry widget
+ * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
+ * if it will use a dedicated window
*
- * @ingroup Gengrid
+ * @see elm_fileselector_entry_inwin_mode_set() for more details
*/
- EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get <b>a list</b> of selected items in a given gengrid
+ * Set the initial file system path for a given file selector entry
+ * widget
*
- * @param obj The gengrid object.
- * @return The list of selected items or @c NULL, if none is
- * selected at the moment (and on errors)
+ * @param obj The file selector entry widget
+ * @param path The path string
*
- * This returns a list of the selected items, in the order that
- * they appear in the grid. This list is only valid as long as no
- * more items are selected or unselected (or unselected implictly
- * by deletion). The list contains #Elm_Gengrid_Item pointers as
- * data, naturally.
+ * It must be a <b>directory</b> path, which will have the contents
+ * displayed initially in the file selector's view, when invoked
+ * from @p obj. The default initial path is the @c "HOME"
+ * environment variable's value.
*
- * @see elm_gengrid_selected_item_get()
+ * @see elm_fileselector_entry_path_get()
+ */
+ EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the parent directory's path to the latest file selection on
+ * a given filer selector entry widget
*
- * @ingroup Gengrid
+ * @param obj The file selector object
+ * @return The (full) path of the directory of the last selection
+ * on @p obj widget, a @b stringshared string
+ *
+ * @see elm_fileselector_entry_path_set()
*/
- EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
* @}
*/
/**
- * @defgroup Clock Clock
- *
- * @image html img/widget/clock/preview-00.png
- * @image latex img/widget/clock/preview-00.eps
- *
- * This is a @b digital clock widget. In its default theme, it has a
- * vintage "flipping numbers clock" appearance, which will animate
- * sheets of individual algarisms individually as time goes by.
- *
- * A newly created clock will fetch system's time (already
- * considering local time adjustments) to start with, and will tick
- * accondingly. It may or may not show seconds.
- *
- * Clocks have an @b edition mode. When in it, the sheets will
- * display extra arrow indications on the top and bottom and the
- * user may click on them to raise or lower the time values. After
- * it's told to exit edition mode, it will keep ticking with that
- * new time set (it keeps the difference from local time).
+ * @defgroup Scroller Scroller
*
- * Also, when under edition mode, user clicks on the cited arrows
- * which are @b held for some time will make the clock to flip the
- * sheet, thus editing the time, continuosly and automatically for
- * the user. The interval between sheet flips will keep growing in
- * time, so that it helps the user to reach a time which is distant
- * from the one set.
+ * A scroller holds a single object and "scrolls it around". This means that
+ * it allows the user to use a scrollbar (or a finger) to drag the viewable
+ * region around, allowing to move through a much larger object that is
+ * contained in the scroller. The scroiller will always have a small minimum
+ * size by default as it won't be limited by the contents of the scroller.
*
- * The time display is, by default, in military mode (24h), but an
- * am/pm indicator may be optionally shown, too, when it will
- * switch to 12h.
+ * Signals that you can add callbacks for are:
+ * @li "edge,left" - the left edge of the content has been reached
+ * @li "edge,right" - the right edge of the content has been reached
+ * @li "edge,top" - the top edge of the content has been reached
+ * @li "edge,bottom" - the bottom edge of the content has been reached
+ * @li "scroll" - the content has been scrolled (moved)
+ * @li "scroll,anim,start" - scrolling animation has started
+ * @li "scroll,anim,stop" - scrolling animation has stopped
+ * @li "scroll,drag,start" - dragging the contents around has started
+ * @li "scroll,drag,stop" - dragging the contents around has stopped
+ * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
+ * user intervetion.
*
- * Smart callbacks one can register to:
- * - "changed" - the clock's user changed the time
+ * @note When Elemementary is in embedded mode the scrollbars will not be
+ * dragable, they appear merely as indicators of how much has been scrolled.
+ * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
+ * fingerscroll) won't work.
*
- * Here is an example on its usage:
- * @li @ref clock_example
- */
-
- /**
- * @addtogroup Clock
+ * In @ref tutorial_scroller you'll find an example of how to use most of
+ * this API.
* @{
*/
-
/**
- * Identifiers for which clock digits should be editable, when a
- * clock widget is in edition mode. Values may be ORed together to
- * make a mask, naturally.
+ * @brief Type that controls when scrollbars should appear.
*
- * @see elm_clock_edit_set()
- * @see elm_clock_digit_edit_set()
+ * @see elm_scroller_policy_set()
*/
- typedef enum _Elm_Clock_Digedit
+ typedef enum _Elm_Scroller_Policy
{
- ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
- ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
- ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
- ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
- ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
- ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
- ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
- ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
- } Elm_Clock_Digedit;
-
+ ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
+ ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
+ ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
+ ELM_SCROLLER_POLICY_LAST
+ } Elm_Scroller_Policy;
/**
- * Add a new clock widget to the given parent Elementary
- * (container) object
+ * @brief Add a new scroller to the parent
*
* @param parent The parent object
- * @return a new clock widget handle or @c NULL, on errors
- *
- * This function inserts a new clock widget on the canvas.
- *
- * @ingroup Clock
+ * @return The new object or NULL if it cannot be created
*/
- EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
-
+ EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Set a clock widget's time, programmatically
- *
- * @param obj The clock widget object
- * @param hrs The hours to set
- * @param min The minutes to set
- * @param sec The secondes to set
- *
- * This function updates the time that is showed by the clock
- * widget.
- *
- * Values @b must be set within the following ranges:
- * - 0 - 23, for hours
- * - 0 - 59, for minutes
- * - 0 - 59, for seconds,
- *
- * even if the clock is not in "military" mode.
+ * @brief Set the content of the scroller widget (the object to be scrolled around).
*
- * @warning The behavior for values set out of those ranges is @b
- * indefined.
+ * @param obj The scroller object
+ * @param content The new content object
*
- * @ingroup Clock
+ * Once the content object is set, a previously set one will be deleted.
+ * If you want to keep that old content object, use the
+ * elm_scroller_content_unset() function.
*/
- EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
/**
- * Get a clock widget's time values
- *
- * @param obj The clock object
- * @param[out] hrs Pointer to the variable to get the hours value
- * @param[out] min Pointer to the variable to get the minutes value
- * @param[out] sec Pointer to the variable to get the seconds value
+ * @brief Get the content of the scroller widget
*
- * This function gets the time set for @p obj, returning
- * it on the variables passed as the arguments to function
+ * @param obj The slider object
+ * @return The content that is being used
*
- * @note Use @c NULL pointers on the time values you're not
- * interested in: they'll be ignored by the function.
+ * Return the content object which is set for this widget
*
- * @ingroup Clock
+ * @see elm_scroller_content_set()
*/
- EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
-
+ EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set whether a given clock widget is under <b>edition mode</b> or
- * under (default) displaying-only mode.
- *
- * @param obj The clock object
- * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
- * put it back to "displaying only" mode
- *
- * This function makes a clock's time to be editable or not <b>by
- * user interaction</b>. When in edition mode, clocks @b stop
- * ticking, until one brings them back to canonical mode. The
- * elm_clock_digit_edit_set() function will influence which digits
- * of the clock will be editable. By default, all of them will be
- * (#ELM_CLOCK_NONE).
+ * @brief Unset the content of the scroller widget
*
- * @note am/pm sheets, if being shown, will @b always be editable
- * under edition mode.
+ * @param obj The slider object
+ * @return The content that was being used
*
- * @see elm_clock_edit_get()
+ * Unparent and return the content object which was set for this widget
*
- * @ingroup Clock
+ * @see elm_scroller_content_set()
*/
- EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
-
+ EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Retrieve whether a given clock widget is under <b>edition
- * mode</b> or under (default) displaying-only mode.
- *
- * @param obj The clock object
- * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
- * otherwise
+ * @brief Set custom theme elements for the scroller
*
- * This function retrieves whether the clock's time can be edited
- * or not by user interaction.
+ * @param obj The scroller object
+ * @param widget The widget name to use (default is "scroller")
+ * @param base The base name to use (default is "base")
+ */
+ EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
+ /**
+ * @brief Make the scroller minimum size limited to the minimum size of the content
*
- * @see elm_clock_edit_set() for more details
+ * @param obj The scroller object
+ * @param w Enable limiting minimum size horizontally
+ * @param h Enable limiting minimum size vertically
*
- * @ingroup Clock
+ * By default the scroller will be as small as its design allows,
+ * irrespective of its content. This will make the scroller minimum size the
+ * right size horizontally and/or vertically to perfectly fit its content in
+ * that direction.
*/
- EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
/**
- * Set what digits of the given clock widget should be editable
- * when in edition mode.
+ * @brief Show a specific virtual region within the scroller content object
*
- * @param obj The clock object
- * @param digedit Bit mask indicating the digits to be editable
- * (values in #Elm_Clock_Digedit).
+ * @param obj The scroller object
+ * @param x X coordinate of the region
+ * @param y Y coordinate of the region
+ * @param w Width of the region
+ * @param h Height of the region
*
- * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
- * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
- * EINA_FALSE).
+ * This will ensure all (or part if it does not fit) of the designated
+ * region in the virtual content object (0, 0 starting at the top-left of the
+ * virtual content object) is shown within the scroller.
+ */
+ 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);
+ /**
+ * @brief Set the scrollbar visibility policy
*
- * @see elm_clock_digit_edit_get()
+ * @param obj The scroller object
+ * @param policy_h Horizontal scrollbar policy
+ * @param policy_v Vertical scrollbar policy
*
- * @ingroup Clock
+ * This sets the scrollbar visibility policy for the given scroller.
+ * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
+ * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
+ * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
+ * respectively for the horizontal and vertical scrollbars.
*/
- EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
/**
- * Retrieve what digits of the given clock widget should be
- * editable when in edition mode.
- *
- * @param obj The clock object
- * @return Bit mask indicating the digits to be editable
- * (values in #Elm_Clock_Digedit).
+ * @brief Gets scrollbar visibility policy
*
- * @see elm_clock_digit_edit_set() for more details
+ * @param obj The scroller object
+ * @param policy_h Horizontal scrollbar policy
+ * @param policy_v Vertical scrollbar policy
*
- * @ingroup Clock
+ * @see elm_scroller_policy_set()
*/
- EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
/**
- * Set if the given clock widget must show hours in military or
- * am/pm mode
+ * @brief Get the currently visible content region
*
- * @param obj The clock object
- * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
- * to military mode
+ * @param obj The scroller object
+ * @param x X coordinate of the region
+ * @param y Y coordinate of the region
+ * @param w Width of the region
+ * @param h Height of the region
*
- * This function sets if the clock must show hours in military or
- * am/pm mode. In some countries like Brazil the military mode
- * (00-24h-format) is used, in opposition to the USA, where the
- * am/pm mode is more commonly used.
+ * This gets the current region in the content object that is visible through
+ * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
+ * w, @p h values pointed to.
*
- * @see elm_clock_show_am_pm_get()
+ * @note All coordinates are relative to the content.
*
- * @ingroup Clock
+ * @see elm_scroller_region_show()
*/
- EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
-
+ 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);
/**
- * Get if the given clock widget shows hours in military or am/pm
- * mode
- *
- * @param obj The clock object
- * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
- * military
- *
- * This function gets if the clock shows hours in military or am/pm
- * mode.
+ * @brief Get the size of the content object
*
- * @see elm_clock_show_am_pm_set() for more details
+ * @param obj The scroller object
+ * @param w Width return
+ * @param h Height return
*
- * @ingroup Clock
+ * This gets the size of the content object of the scroller.
*/
- EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
/**
- * Set if the given clock widget must show time with seconds or not
+ * @brief Set bouncing behavior
*
- * @param obj The clock object
- * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
+ * @param obj The scroller object
+ * @param h_bounce Will the scroller bounce horizontally or not
+ * @param v_bounce Will the scroller bounce vertically or not
*
- * This function sets if the given clock must show or not elapsed
- * seconds. By default, they are @b not shown.
+ * When scrolling, the scroller may "bounce" when reaching an edge of the
+ * content object. This is a visual way to indicate the end has been reached.
+ * This is enabled by default for both axis. This will set if it is enabled
+ * for that axis with the boolean parameters for each axis.
+ */
+ EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the bounce mode
*
- * @see elm_clock_show_seconds_get()
+ * @param obj The Scroller object
+ * @param h_bounce Allow bounce horizontally
+ * @param v_bounce Allow bounce vertically
*
- * @ingroup Clock
+ * @see elm_scroller_bounce_set()
*/
- EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
/**
- * Get whether the given clock widget is showing time with seconds
- * or not
+ * @brief Set scroll page size relative to viewport size.
*
- * @param obj The clock object
- * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
+ * @param obj The scroller object
+ * @param h_pagerel The horizontal page relative size
+ * @param v_pagerel The vertical page relative size
*
- * This function gets whether @p obj is showing or not the elapsed
- * seconds.
- *
- * @see elm_clock_show_seconds_set()
- *
- * @ingroup Clock
+ * The scroller is capable of limiting scrolling by the user to "pages". That
+ * is to jump by and only show a "whole page" at a time as if the continuous
+ * area of the scroller content is split into page sized pieces. This sets
+ * the size of a page relative to the viewport of the scroller. 1.0 is "1
+ * viewport" is size (horizontally or vertically). 0.0 turns it off in that
+ * axis. This is mutually exclusive with page size
+ * (see elm_scroller_page_size_set() for more information). Likewise 0.5
+ * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
+ * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
+ * the other axis.
*/
- EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
/**
- * Set the interval on time updates for an user mouse button hold
- * on clock widgets' time edition.
- *
- * @param obj The clock object
- * @param interval The (first) interval value in seconds
+ * @brief Set scroll page size.
*
- * This interval value is @b decreased while the user holds the
- * mouse pointer either incrementing or decrementing a given the
- * clock digit's value.
+ * @param obj The scroller object
+ * @param h_pagesize The horizontal page size
+ * @param v_pagesize The vertical page size
*
- * This helps the user to get to a given time distant from the
- * current one easier/faster, as it will start to flip quicker and
- * quicker on mouse button holds.
+ * This sets the page size to an absolute fixed value, with 0 turning it off
+ * for that axis.
*
- * The calculation for the next flip interval value, starting from
- * the one set with this call, is the previous interval divided by
- * 1.05, so it decreases a little bit.
+ * @see elm_scroller_page_relative_set()
+ */
+ EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get scroll current page number.
*
- * The default starting interval value for automatic flips is
- * @b 0.85 seconds.
+ * @param obj The scroller object
+ * @param h_pagenumber The horizontal page number
+ * @param v_pagenumber The vertical page number
*
- * @see elm_clock_interval_get()
+ * The page number starts from 0. 0 is the first page.
+ * Current page means the page which meet the top-left of the viewport.
+ * If there are two or more pages in the viewport, it returns the number of page
+ * which meet the top-left of the viewport.
*
- * @ingroup Clock
+ * @see elm_scroller_last_page_get()
+ * @see elm_scroller_page_show()
+ * @see elm_scroller_page_brint_in()
*/
- EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
/**
- * Get the interval on time updates for an user mouse button hold
- * on clock widgets' time edition.
+ * @brief Get scroll last page number.
*
- * @param obj The clock object
- * @return The (first) interval value, in seconds, set on it
+ * @param obj The scroller object
+ * @param h_pagenumber The horizontal page number
+ * @param v_pagenumber The vertical page number
*
- * @see elm_clock_interval_set() for more details
+ * The page number starts from 0. 0 is the first page.
+ * This returns the last page number among the pages.
*
- * @ingroup Clock
+ * @see elm_scroller_current_page_get()
+ * @see elm_scroller_page_show()
+ * @see elm_scroller_page_brint_in()
*/
- EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /**
- * @}
- */
-
+ EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
/**
- * @defgroup Layout Layout
+ * Show a specific virtual region within the scroller content object by page number.
*
- * @image html img/widget/layout/preview-00.png
- * @image latex img/widget/layout/preview-00.eps width=\textwidth
+ * @param obj The scroller object
+ * @param h_pagenumber The horizontal page number
+ * @param v_pagenumber The vertical page number
*
- * @image html img/layout-predefined.png
- * @image latex img/layout-predefined.eps width=\textwidth
+ * 0, 0 of the indicated page is located at the top-left of the viewport.
+ * This will jump to the page directly without animation.
*
- * This is a container widget that takes a standard Edje design file and
- * wraps it very thinly in a widget.
+ * Example of usage:
*
- * An Edje design (theme) file has a very wide range of possibilities to
- * describe the behavior of elements added to the Layout. Check out the Edje
- * documentation and the EDC reference to get more information about what can
- * be done with Edje.
+ * @code
+ * sc = elm_scroller_add(win);
+ * elm_scroller_content_set(sc, content);
+ * elm_scroller_page_relative_set(sc, 1, 0);
+ * elm_scroller_current_page_get(sc, &h_page, &v_page);
+ * elm_scroller_page_show(sc, h_page + 1, v_page);
+ * @endcode
*
- * Just like @ref List, @ref Box, and other container widgets, any
- * object added to the Layout will become its child, meaning that it will be
- * deleted if the Layout is deleted, move if the Layout is moved, and so on.
+ * @see elm_scroller_page_bring_in()
+ */
+ EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
+ /**
+ * Show a specific virtual region within the scroller content object by page number.
*
- * The Layout widget can contain as many Contents, Boxes or Tables as
- * described in its theme file. For instance, objects can be added to
- * different Tables by specifying the respective Table part names. The same
- * is valid for Content and Box.
+ * @param obj The scroller object
+ * @param h_pagenumber The horizontal page number
+ * @param v_pagenumber The vertical page number
*
- * The objects added as child of the Layout will behave as described in the
- * part description where they were added. There are 3 possible types of
- * parts where a child can be added:
+ * 0, 0 of the indicated page is located at the top-left of the viewport.
+ * This will slide to the page with animation.
*
- * @section secContent Content (SWALLOW part)
+ * Example of usage:
*
- * Only one object can be added to the @c SWALLOW part (but you still can
- * have many @c SWALLOW parts and one object on each of them). Use the @c
- * elm_layout_content_* set of functions to set, retrieve and unset objects
- * as content of the @c SWALLOW. After being set to this part, the object
- * size, position, visibility, clipping and other description properties
- * will be totally controled by the description of the given part (inside
- * the Edje theme file).
+ * @code
+ * sc = elm_scroller_add(win);
+ * elm_scroller_content_set(sc, content);
+ * elm_scroller_page_relative_set(sc, 1, 0);
+ * elm_scroller_last_page_get(sc, &h_page, &v_page);
+ * elm_scroller_page_bring_in(sc, h_page, v_page);
+ * @endcode
*
- * One can use @c evas_object_size_hint_* functions on the child to have some
- * kind of control over its behavior, but the resulting behavior will still
- * depend heavily on the @c SWALLOW part description.
+ * @see elm_scroller_page_show()
+ */
+ EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Show a specific virtual region within the scroller content object.
*
- * The Edje theme also can change the part description, based on signals or
- * scripts running inside the theme. This change can also be animated. All of
- * this will affect the child object set as content accordingly. The object
- * size will be changed if the part size is changed, it will animate move if
- * the part is moving, and so on.
+ * @param obj The scroller object
+ * @param x X coordinate of the region
+ * @param y Y coordinate of the region
+ * @param w Width of the region
+ * @param h Height of the region
*
- * The following picture demonstrates a Layout widget with a child object
- * added to its @c SWALLOW:
+ * This will ensure all (or part if it does not fit) of the designated
+ * region in the virtual content object (0, 0 starting at the top-left of the
+ * virtual content object) is shown within the scroller. Unlike
+ * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
+ * to this location (if configuration in general calls for transitions). It
+ * may not jump immediately to the new location and make take a while and
+ * show other content along the way.
*
- * @image html layout_swallow.png
- * @image latex layout_swallow.eps width=\textwidth
+ * @see elm_scroller_region_show()
+ */
+ 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);
+ /**
+ * @brief Set event propagation on a scroller
*
- * @section secBox Box (BOX part)
+ * @param obj The scroller object
+ * @param propagation If propagation is enabled or not
*
- * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
- * allows one to add objects to the box and have them distributed along its
- * area, accordingly to the specified @a layout property (now by @a layout we
- * mean the chosen layouting design of the Box, not the Layout widget
- * itself).
+ * This enables or disabled event propagation from the scroller content to
+ * the scroller and its parent. By default event propagation is disabled.
+ */
+ EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
+ /**
+ * @brief Get event propagation for a scroller
*
- * A similar effect for having a box with its position, size and other things
- * controled by the Layout theme would be to create an Elementary @ref Box
- * widget and add it as a Content in the @c SWALLOW part.
+ * @param obj The scroller object
+ * @return The propagation state
*
- * The main difference of using the Layout Box is that its behavior, the box
- * properties like layouting format, padding, align, etc. will be all
- * controled by the theme. This means, for example, that a signal could be
- * sent to the Layout theme (with elm_object_signal_emit()) and the theme
- * handled the signal by changing the box padding, or align, or both. Using
- * the Elementary @ref Box widget is not necessarily harder or easier, it
- * just depends on the circunstances and requirements.
+ * This gets the event propagation for a scroller.
*
- * The Layout Box can be used through the @c elm_layout_box_* set of
- * functions.
+ * @see elm_scroller_propagate_events_set()
+ */
+ EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
+ /**
+ * @}
+ */
+
+ /**
+ * @defgroup Label Label
*
- * The following picture demonstrates a Layout widget with many child objects
- * added to its @c BOX part:
+ * @image html img/widget/label/preview-00.png
+ * @image latex img/widget/label/preview-00.eps
*
- * @image html layout_box.png
- * @image latex layout_box.eps width=\textwidth
+ * @brief Widget to display text, with simple html-like markup.
*
- * @section secTable Table (TABLE part)
+ * The Label widget @b doesn't allow text to overflow its boundaries, if the
+ * text doesn't fit the geometry of the label it will be ellipsized or be
+ * cut. Elementary provides several themes for this widget:
+ * @li default - No animation
+ * @li marker - Centers the text in the label and make it bold by default
+ * @li slide_long - The entire text appears from the right of the screen and
+ * slides until it disappears in the left of the screen(reappering on the
+ * right again).
+ * @li slide_short - The text appears in the left of the label and slides to
+ * the right to show the overflow. When all of the text has been shown the
+ * position is reset.
+ * @li slide_bounce - The text appears in the left of the label and slides to
+ * the right to show the overflow. When all of the text has been shown the
+ * animation reverses, moving the text to the left.
*
- * Just like the @ref secBox, the Layout Table is very similar to the
- * Elementary @ref Table widget. It allows one to add objects to the Table
- * specifying the row and column where the object should be added, and any
- * column or row span if necessary.
+ * Custom themes can of course invent new markup tags and style them any way
+ * they like.
*
- * Again, we could have this design by adding a @ref Table widget to the @c
- * SWALLOW part using elm_layout_content_set(). The same difference happens
- * here when choosing to use the Layout Table (a @c TABLE part) instead of
- * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
+ * See @ref tutorial_label for a demonstration of how to use a label widget.
+ * @{
+ */
+ /**
+ * @brief Add a new label to the parent
*
- * The Layout Table can be used through the @c elm_layout_table_* set of
- * functions.
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ */
+ EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the label on the label object
*
- * The following picture demonstrates a Layout widget with many child objects
- * added to its @c TABLE part:
+ * @param obj The label object
+ * @param label The label will be used on the label object
+ * @deprecated See elm_object_text_set()
+ */
+ EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_set instead */
+ /**
+ * @brief Get the label used on the label object
*
- * @image html layout_table.png
- * @image latex layout_table.eps width=\textwidth
+ * @param obj The label object
+ * @return The string inside the label
+ * @deprecated See elm_object_text_get()
+ */
+ EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
+ /**
+ * @brief Set the wrapping behavior of the label
*
- * @section secPredef Predefined Layouts
+ * @param obj The label object
+ * @param wrap To wrap text or not
*
- * Another interesting thing about the Layout widget is that it offers some
- * predefined themes that come with the default Elementary theme. These
- * themes can be set by the call elm_layout_theme_set(), and provide some
- * basic functionality depending on the theme used.
+ * By default no wrapping is done. Possible values for @p wrap are:
+ * @li ELM_WRAP_NONE - No wrapping
+ * @li ELM_WRAP_CHAR - wrap between characters
+ * @li ELM_WRAP_WORD - wrap between words
+ * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
+ */
+ EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the wrapping behavior of the label
*
- * Most of them already send some signals, some already provide a toolbar or
- * back and next buttons.
+ * @param obj The label object
+ * @return Wrap type
*
- * These are available predefined theme layouts. All of them have class = @c
- * layout, group = @c application, and style = one of the following options:
- *
- * @li @c toolbar-content - application with toolbar and main content area
- * @li @c toolbar-content-back - application with toolbar and main content
- * area with a back button and title area
- * @li @c toolbar-content-back-next - application with toolbar and main
- * content area with a back and next buttons and title area
- * @li @c content-back - application with a main content area with a back
- * button and title area
- * @li @c content-back-next - application with a main content area with a
- * back and next buttons and title area
- * @li @c toolbar-vbox - application with toolbar and main content area as a
- * vertical box
- * @li @c toolbar-table - application with toolbar and main content area as a
- * table
+ * @see elm_label_line_wrap_set()
+ */
+ EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set wrap width of the label
*
- * @section secExamples Examples
+ * @param obj The label object
+ * @param w The wrap width in pixels at a minimum where words need to wrap
*
- * Some examples of the Layout widget can be found here:
- * @li @ref layout_example_01
- * @li @ref layout_example_02
- * @li @ref layout_example_03
- * @li @ref layout_example_edc
+ * This function sets the maximum width size hint of the label.
*
+ * @warning This is only relevant if the label is inside a container.
*/
-
+ EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
/**
- * Add a new layout to the parent
- *
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @brief Get wrap width of the label
*
- * @see elm_layout_file_set()
- * @see elm_layout_theme_set()
+ * @param obj The label object
+ * @return The wrap width in pixels at a minimum where words need to wrap
*
- * @ingroup Layout
+ * @see elm_label_wrap_width_set()
*/
- EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the file that will be used as layout
+ * @brief Set wrap height of the label
*
- * @param obj The layout object
- * @param file The path to file (edj) that will be used as layout
- * @param group The group that the layout belongs in edje file
+ * @param obj The label object
+ * @param h The wrap height in pixels at a minimum where words need to wrap
*
- * @return (1 = success, 0 = error)
+ * This function sets the maximum height size hint of the label.
*
- * @ingroup Layout
+ * @warning This is only relevant if the label is inside a container.
*/
- EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
+ EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
/**
- * Set the edje group from the elementary theme that will be used as layout
+ * @brief get wrap width of the label
*
- * @param obj The layout object
- * @param clas the clas of the group
- * @param group the group
- * @param style the style to used
+ * @param obj The label object
+ * @return The wrap height in pixels at a minimum where words need to wrap
+ */
+ EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the font size on the label object.
*
- * @return (1 = success, 0 = error)
+ * @param obj The label object
+ * @param size font size
*
- * @ingroup Layout
+ * @warning NEVER use this. It is for hyper-special cases only. use styles
+ * instead. e.g. "big", "medium", "small" - or better name them by use:
+ * "title", "footnote", "quote" etc.
*/
- EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
+ EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
/**
- * Set the layout content.
- *
- * @param obj The layout object
- * @param swallow The swallow part name in the edje file
- * @param content The child that will be added in this layout object
+ * @brief Set the text color on the label object
*
- * Once the content object is set, a previously set one will be deleted.
- * If you want to keep that old content object, use the
- * elm_layout_content_unset() function.
+ * @param obj The label object
+ * @param r Red property background color of The label object
+ * @param g Green property background color of The label object
+ * @param b Blue property background color of The label object
+ * @param a Alpha property background color of The label object
*
- * @note In an Edje theme, the part used as a content container is called @c
- * SWALLOW. This is why the parameter name is called @p swallow, but it is
- * expected to be a part name just like the second parameter of
- * elm_layout_box_append().
+ * @warning NEVER use this. It is for hyper-special cases only. use styles
+ * instead. e.g. "big", "medium", "small" - or better name them by use:
+ * "title", "footnote", "quote" etc.
+ */
+ 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);
+ /**
+ * @brief Set the text align on the label object
*
- * @see elm_layout_box_append()
- * @see elm_layout_content_get()
- * @see elm_layout_content_unset()
- * @see @ref secBox
+ * @param obj The label object
+ * @param align align mode ("left", "center", "right")
*
- * @ingroup Layout
+ * @warning NEVER use this. It is for hyper-special cases only. use styles
+ * instead. e.g. "big", "medium", "small" - or better name them by use:
+ * "title", "footnote", "quote" etc.
*/
- EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
+ EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
/**
- * Get the child object in the given content part.
+ * @brief Set background color of the label
*
- * @param obj The layout object
- * @param swallow The SWALLOW part to get its content
+ * @param obj The label object
+ * @param r Red property background color of The label object
+ * @param g Green property background color of The label object
+ * @param b Blue property background color of The label object
+ * @param a Alpha property background alpha of The label object
*
- * @return The swallowed object or NULL if none or an error occurred
+ * @warning NEVER use this. It is for hyper-special cases only. use styles
+ * instead. e.g. "big", "medium", "small" - or better name them by use:
+ * "title", "footnote", "quote" etc.
+ */
+ 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);
+ /**
+ * @brief Set the ellipsis behavior of the label
*
- * @see elm_layout_content_set()
+ * @param obj The label object
+ * @param ellipsis To ellipsis text or not
*
- * @ingroup Layout
+ * If set to true and the text doesn't fit in the label an ellipsis("...")
+ * will be shown at the end of the widget.
+ *
+ * @warning This doesn't work with slide(elm_label_slide_set()) or if the
+ * choosen wrap method was ELM_WRAP_WORD.
*/
- EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+ EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
/**
- * Unset the layout content.
- *
- * @param obj The layout object
- * @param swallow The swallow part name in the edje file
- * @return The content that was being used
+ * @brief Set the text slide of the label
*
- * Unparent and return the content object which was set for this part.
+ * @param obj The label object
+ * @param slide To start slide or stop
*
- * @see elm_layout_content_set()
+ * If set to true the text of the label will slide throught the length of
+ * label.
*
- * @ingroup Layout
+ * @warning This only work with the themes "slide_short", "slide_long" and
+ * "slide_bounce".
*/
- EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+ EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
/**
- * Set the text of the given part
+ * @brief Get the text slide mode of the label
*
- * @param obj The layout object
- * @param part The TEXT part where to set the text
- * @param text The text to set
+ * @param obj The label object
+ * @return slide slide mode value
*
- * @ingroup Layout
- * @deprecated use elm_object_text_* instead.
+ * @see elm_label_slide_set()
*/
- EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the text set in the given part
+ * @brief Set the slide duration(speed) of the label
*
- * @param obj The layout object
- * @param part The TEXT part to retrieve the text off
+ * @param obj The label object
+ * @return The duration in seconds in moving text from slide begin position
+ * to slide end position
+ */
+ EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the slide duration(speed) of the label
*
- * @return The text set in @p part
+ * @param obj The label object
+ * @return The duration time in moving text from slide begin position to slide end position
*
- * @ingroup Layout
- * @deprecated use elm_object_text_* instead.
+ * @see elm_label_slide_duration_set()
*/
- EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
+ EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Append child to layout box part.
+ * @}
+ */
+
+ /**
+ * @defgroup Toggle Toggle
*
- * @param obj the layout object
- * @param part the box part to which the object will be appended.
- * @param child the child object to append to box.
+ * @image html img/widget/toggle/preview-00.png
+ * @image latex img/widget/toggle/preview-00.eps
*
- * Once the object is appended, it will become child of the layout. Its
- * lifetime will be bound to the layout, whenever the layout dies the child
- * will be deleted automatically. One should use elm_layout_box_remove() to
- * make this layout forget about the object.
+ * @brief A toggle is a slider which can be used to toggle between
+ * two values. It has two states: on and off.
*
- * @see elm_layout_box_prepend()
- * @see elm_layout_box_insert_before()
- * @see elm_layout_box_insert_at()
- * @see elm_layout_box_remove()
+ * Signals that you can add callbacks for are:
+ * @li "changed" - Whenever the toggle value has been changed. Is not called
+ * until the toggle is released by the cursor (assuming it
+ * has been triggered by the cursor in the first place).
*
- * @ingroup Layout
+ * @ref tutorial_toggle show how to use a toggle.
+ * @{
*/
- EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
/**
- * Prepend child to layout box part.
+ * @brief Add a toggle to @p parent.
*
- * @param obj the layout object
- * @param part the box part to prepend.
- * @param child the child object to prepend to box.
+ * @param parent The parent object
*
- * Once the object is prepended, it will become child of the layout. Its
- * lifetime will be bound to the layout, whenever the layout dies the child
- * will be deleted automatically. One should use elm_layout_box_remove() to
- * make this layout forget about the object.
+ * @return The toggle object
+ */
+ EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Sets the label to be displayed with the toggle.
*
- * @see elm_layout_box_append()
- * @see elm_layout_box_insert_before()
- * @see elm_layout_box_insert_at()
- * @see elm_layout_box_remove()
+ * @param obj The toggle object
+ * @param label The label to be displayed
*
- * @ingroup Layout
+ * @deprecated use elm_object_text_set() instead.
*/
- EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
/**
- * Insert child to layout box part before a reference object.
+ * @brief Gets the label of the toggle
*
- * @param obj the layout object
- * @param part the box part to insert.
- * @param child the child object to insert into box.
- * @param reference another reference object to insert before in box.
+ * @param obj toggle object
+ * @return The label of the toggle
*
- * Once the object is inserted, it will become child of the layout. Its
- * lifetime will be bound to the layout, whenever the layout dies the child
- * will be deleted automatically. One should use elm_layout_box_remove() to
- * make this layout forget about the object.
+ * @deprecated use elm_object_text_get() instead.
+ */
+ EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the icon used for the toggle
*
- * @see elm_layout_box_append()
- * @see elm_layout_box_prepend()
- * @see elm_layout_box_insert_before()
- * @see elm_layout_box_remove()
+ * @param obj The toggle object
+ * @param icon The icon object for the button
*
- * @ingroup Layout
+ * Once the icon object is set, a previously set one will be deleted
+ * If you want to keep that old content object, use the
+ * elm_toggle_icon_unset() function.
*/
- EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
+ EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
/**
- * Insert child to layout box part at a given position.
- *
- * @param obj the layout object
- * @param part the box part to insert.
- * @param child the child object to insert into box.
- * @param pos the numeric position >=0 to insert the child.
+ * @brief Get the icon used for the toggle
*
- * Once the object is inserted, it will become child of the layout. Its
- * lifetime will be bound to the layout, whenever the layout dies the child
- * will be deleted automatically. One should use elm_layout_box_remove() to
- * make this layout forget about the object.
+ * @param obj The toggle object
+ * @return The icon object that is being used
*
- * @see elm_layout_box_append()
- * @see elm_layout_box_prepend()
- * @see elm_layout_box_insert_before()
- * @see elm_layout_box_remove()
+ * Return the icon object which is set for this widget.
*
- * @ingroup Layout
+ * @see elm_toggle_icon_set()
*/
- EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Remove a child of the given part box.
+ * @brief Unset the icon used for the toggle
*
- * @param obj The layout object
- * @param part The box part name to remove child.
- * @param child The object to remove from box.
- * @return The object that was being used, or NULL if not found.
+ * @param obj The toggle object
+ * @return The icon object that was being used
*
- * The object will be removed from the box part and its lifetime will
- * not be handled by the layout anymore. This is equivalent to
- * elm_layout_content_unset() for box.
+ * Unparent and return the icon object which was set for this widget.
*
- * @see elm_layout_box_append()
- * @see elm_layout_box_remove_all()
+ * @see elm_toggle_icon_set()
+ */
+ EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Sets the labels to be associated with the on and off states of the toggle.
*
- * @ingroup Layout
+ * @param obj The toggle object
+ * @param onlabel The label displayed when the toggle is in the "on" state
+ * @param offlabel The label displayed when the toggle is in the "off" state
*/
- EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
+ EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
/**
- * Remove all child of the given part box.
+ * @brief Gets the labels associated with the on and off states of the toggle.
*
- * @param obj The layout object
- * @param part The box part name to remove child.
- * @param clear If EINA_TRUE, then all objects will be deleted as
- * well, otherwise they will just be removed and will be
- * dangling on the canvas.
+ * @param obj The toggle object
+ * @param onlabel A char** to place the onlabel of @p obj into
+ * @param offlabel A char** to place the offlabel of @p obj into
+ */
+ EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Sets the state of the toggle to @p state.
*
- * The objects will be removed from the box part and their lifetime will
- * not be handled by the layout anymore. This is equivalent to
- * elm_layout_box_remove() for all box children.
+ * @param obj The toggle object
+ * @param state The state of @p obj
+ */
+ EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Gets the state of the toggle to @p state.
*
- * @see elm_layout_box_append()
- * @see elm_layout_box_remove()
+ * @param obj The toggle object
+ * @return The state of @p obj
+ */
+ EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Sets the state pointer of the toggle to @p statep.
*
- * @ingroup Layout
+ * @param obj The toggle object
+ * @param statep The state pointer of @p obj
*/
- EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
+ EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
/**
- * Insert child to layout table part.
+ * @}
+ */
+
+ /**
+ * @defgroup Frame Frame
*
- * @param obj the layout object
- * @param part the box part to pack child.
- * @param child_obj the child object to pack into table.
- * @param col the column to which the child should be added. (>= 0)
- * @param row the row to which the child should be added. (>= 0)
- * @param colspan how many columns should be used to store this object. (>=
- * 1)
- * @param rowspan how many rows should be used to store this object. (>= 1)
+ * @image html img/widget/frame/preview-00.png
+ * @image latex img/widget/frame/preview-00.eps
*
- * Once the object is inserted, it will become child of the table. Its
- * lifetime will be bound to the layout, and whenever the layout dies the
- * child will be deleted automatically. One should use
- * elm_layout_table_remove() to make this layout forget about the object.
+ * @brief Frame is a widget that holds some content and has a title.
*
- * If @p colspan or @p rowspan are bigger than 1, that object will occupy
- * more space than a single cell. For instance, the following code:
- * @code
- * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
- * @endcode
+ * The default look is a frame with a title, but Frame supports multple
+ * styles:
+ * @li default
+ * @li pad_small
+ * @li pad_medium
+ * @li pad_large
+ * @li pad_huge
+ * @li outdent_top
+ * @li outdent_bottom
*
- * Would result in an object being added like the following picture:
+ * Of all this styles only default shows the title. Frame emits no signals.
*
- * @image html layout_colspan.png
- * @image latex layout_colspan.eps width=\textwidth
+ * For a detailed example see the @ref tutorial_frame.
*
- * @see elm_layout_table_unpack()
- * @see elm_layout_table_clear()
+ * @{
+ */
+ /**
+ * @brief Add a new frame to the parent
*
- * @ingroup Layout
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
*/
- 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);
+ EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Unpack (remove) a child of the given part table.
+ * @brief Set the frame label
*
- * @param obj The layout object
- * @param part The table part name to remove child.
- * @param child_obj The object to remove from table.
- * @return The object that was being used, or NULL if not found.
+ * @param obj The frame object
+ * @param label The label of this frame object
*
- * The object will be unpacked from the table part and its lifetime
- * will not be handled by the layout anymore. This is equivalent to
- * elm_layout_content_unset() for table.
+ * @deprecated use elm_object_text_set() instead.
+ */
+ EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the frame label
*
- * @see elm_layout_table_pack()
- * @see elm_layout_table_clear()
+ * @param obj The frame object
*
- * @ingroup Layout
+ * @return The label of this frame objet or NULL if unable to get frame
+ *
+ * @deprecated use elm_object_text_get() instead.
*/
- EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
+ EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Remove all child of the given part table.
+ * @brief Set the content of the frame widget
*
- * @param obj The layout object
- * @param part The table part name to remove child.
- * @param clear If EINA_TRUE, then all objects will be deleted as
- * well, otherwise they will just be removed and will be
- * dangling on the canvas.
+ * Once the content object is set, a previously set one will be deleted.
+ * If you want to keep that old content object, use the
+ * elm_frame_content_unset() function.
*
- * The objects will be removed from the table part and their lifetime will
- * not be handled by the layout anymore. This is equivalent to
- * elm_layout_table_unpack() for all table children.
+ * @param obj The frame object
+ * @param content The content will be filled in this frame object
+ */
+ EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the content of the frame widget
*
- * @see elm_layout_table_pack()
- * @see elm_layout_table_unpack()
+ * Return the content object which is set for this widget
*
- * @ingroup Layout
+ * @param obj The frame object
+ * @return The content that is being used
*/
- EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
+ EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the edje layout
+ * @brief Unset the content of the frame widget
*
- * @param obj The layout object
+ * Unparent and return the content object which was set for this widget
*
- * @return A Evas_Object with the edje layout settings loaded
- * with function elm_layout_file_set
+ * @param obj The frame object
+ * @return The content that was being used
+ */
+ EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @}
+ */
+
+ /**
+ * @defgroup Table Table
*
- * This returns the edje object. It is not expected to be used to then
- * swallow objects via edje_object_part_swallow() for example. Use
- * elm_layout_content_set() instead so child object handling and sizing is
- * done properly.
+ * A container widget to arrange other widgets in a table where items can
+ * also span multiple columns or rows - even overlap (and then be raised or
+ * lowered accordingly to adjust stacking if they do overlap).
*
- * @note This function should only be used if you really need to call some
- * low level Edje function on this edje object. All the common stuff (setting
- * text, emitting signals, hooking callbacks to signals, etc.) can be done
- * with proper elementary functions.
+ * The followin are examples of how to use a table:
+ * @li @ref tutorial_table_01
+ * @li @ref tutorial_table_02
*
- * @see elm_object_signal_callback_add()
- * @see elm_object_signal_emit()
- * @see elm_object_text_part_set()
- * @see elm_layout_content_set()
- * @see elm_layout_box_append()
- * @see elm_layout_table_pack()
- * @see elm_layout_data_get()
+ * @{
+ */
+ /**
+ * @brief Add a new table to the parent
*
- * @ingroup Layout
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
*/
- EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Get the edje data from the given layout
+ * @brief Set the homogeneous layout in the table
*
* @param obj The layout object
- * @param key The data key
- *
- * @return The edje data string
- *
- * This function fetches data specified inside the edje theme of this layout.
- * This function return NULL if data is not found.
- *
- * In EDC this comes from a data block within the group block that @p
- * obj was loaded from. E.g.
- *
- * @code
- * collections {
- * group {
- * name: "a_group";
- * data {
- * item: "key1" "value1";
- * item: "key2" "value2";
- * }
- * }
- * }
- * @endcode
- *
- * @ingroup Layout
+ * @param homogeneous A boolean to set if the layout is homogeneous in the
+ * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
*/
- EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
+ EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
/**
- * Eval sizing
- *
- * @param obj The layout object
- *
- * Manually forces a sizing re-evaluation. This is useful when the minimum
- * size required by the edje theme of this layout has changed. The change on
- * the minimum size required by the edje theme is not immediately reported to
- * the elementary layout, so one needs to call this function in order to tell
- * the widget (layout) that it needs to reevaluate its own size.
- *
- * The minimum size of the theme is calculated based on minimum size of
- * parts, the size of elements inside containers like box and table, etc. All
- * of this can change due to state changes, and that's when this function
- * should be called.
- *
- * Also note that a standard signal of "size,eval" "elm" emitted from the
- * edje object will cause this to happen too.
+ * @brief Get the current table homogeneous mode.
*
- * @ingroup Layout
+ * @param obj The table object
+ * @return A boolean to indicating if the layout is homogeneous in the table
+ * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
*/
- EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
- EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
- EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
- EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
- EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
- 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);
- EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
-/**
- * @def elm_layout_icon_set
- * Convienience macro to set the icon object in a layout that follows the
- * Elementary naming convention for its parts.
- *
- * @ingroup Layout
- */
-#define elm_layout_icon_set(_ly, _obj) \
- do { \
- const char *sig; \
- elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
- if ((_obj)) sig = "elm,state,icon,visible"; \
- else sig = "elm,state,icon,hidden"; \
- elm_object_signal_emit((_ly), sig, "elm"); \
- } while (0)
-
-/**
- * @def elm_layout_icon_get
- * Convienience macro to get the icon object from a layout that follows the
- * Elementary naming convention for its parts.
- *
- * @ingroup Layout
- */
-#define elm_layout_icon_get(_ly) \
- elm_layout_content_get((_ly), "elm.swallow.icon")
-
-/**
- * @def elm_layout_end_set
- * Convienience macro to set the end object in a layout that follows the
- * Elementary naming convention for its parts.
- *
- * @ingroup Layout
- */
-#define elm_layout_end_set(_ly, _obj) \
- do { \
- const char *sig; \
- elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
- if ((_obj)) sig = "elm,state,end,visible"; \
- else sig = "elm,state,end,hidden"; \
- elm_object_signal_emit((_ly), sig, "elm"); \
- } while (0)
-
-/**
- * @def elm_layout_end_get
- * Convienience macro to get the end object in a layout that follows the
- * Elementary naming convention for its parts.
- *
- * @ingroup Layout
- */
-#define elm_layout_end_get(_ly) \
- elm_layout_content_get((_ly), "elm.swallow.end")
-
-/**
- * @def elm_layout_label_set
- * Convienience macro to set the label in a layout that follows the
- * Elementary naming convention for its parts.
- *
- * @ingroup Layout
- * @deprecate use elm_object_text_* instead.
- */
-#define elm_layout_label_set(_ly, _txt) \
- elm_layout_text_set((_ly), "elm.text", (_txt))
-
-/**
- * @def elm_layout_label_get
- * Convienience macro to get the label in a layout that follows the
- * Elementary naming convention for its parts.
- *
- * @ingroup Layout
- * @deprecate use elm_object_text_* instead.
- */
-#define elm_layout_label_get(_ly) \
- elm_layout_text_get((_ly), "elm.text")
-
- /* smart callbacks called:
- * "theme,changed" - when elm theme is changed.
+ EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @warning <b>Use elm_table_homogeneous_set() instead</b>
*/
-
+ EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
/**
- * @defgroup Notify Notify
- *
- * @image html img/widget/notify/preview-00.png
- * @image latex img/widget/notify/preview-00.eps
- *
- * Display a container in a particular region of the parent(top, bottom,
- * etc. A timeout can be set to automatically hide the notify. This is so
- * that, after an evas_object_show() on a notify object, if a timeout was set
- * on it, it will @b automatically get hidden after that time.
- *
- * Signals that you can add callbacks for are:
- * @li "timeout" - when timeout happens on notify and it's hidden
- * @li "block,clicked" - when a click outside of the notify happens
- *
- * @ref tutorial_notify show usage of the API.
- *
- * @{
+ * @warning <b>Use elm_table_homogeneous_get() instead</b>
*/
+ EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @brief Possible orient values for notify.
+ * @brief Set padding between cells.
*
- * This values should be used in conjunction to elm_notify_orient_set() to
- * set the position in which the notify should appear(relative to its parent)
- * and in conjunction with elm_notify_orient_get() to know where the notify
- * is appearing.
+ * @param obj The layout object.
+ * @param horizontal set the horizontal padding.
+ * @param vertical set the vertical padding.
+ *
+ * Default value is 0.
*/
- typedef enum _Elm_Notify_Orient
- {
- ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
- ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
- ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
- ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
- ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
- ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
- ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
- ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
- ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
- ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
- } Elm_Notify_Orient;
+ EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
/**
- * @brief Add a new notify to the parent
+ * @brief Get padding between cells.
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @param obj The layout object.
+ * @param horizontal set the horizontal padding.
+ * @param vertical set the vertical padding.
*/
- EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
/**
- * @brief Set the content of the notify widget
+ * @brief Add a subobject on the table with the coordinates passed
*
- * @param obj The notify object
- * @param content The content will be filled in this notify object
+ * @param obj The table object
+ * @param subobj The subobject to be added to the table
+ * @param x Row number
+ * @param y Column number
+ * @param w rowspan
+ * @param h colspan
*
- * Once the content object is set, a previously set one will be deleted. If
- * you want to keep that old content object, use the
- * elm_notify_content_unset() function.
+ * @note All positioning inside the table is relative to rows and columns, so
+ * a value of 0 for x and y, means the top left cell of the table, and a
+ * value of 1 for w and h means @p subobj only takes that 1 cell.
*/
- EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+ EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
/**
- * @brief Unset the content of the notify widget
- *
- * @param obj The notify object
- * @return The content that was being used
- *
- * Unparent and return the content object which was set for this widget
+ * @brief Remove child from table.
*
- * @see elm_notify_content_set()
+ * @param obj The table object
+ * @param subobj The subobject
*/
- EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
/**
- * @brief Return the content of the notify widget
- *
- * @param obj The notify object
- * @return The content that is being used
+ * @brief Faster way to remove all child objects from a table object.
*
- * @see elm_notify_content_set()
+ * @param obj The table object
+ * @param clear If true, will delete children, else just remove from table.
*/
- EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
/**
- * @brief Set the notify parent
+ * @brief Set the packing location of an existing child of the table
*
- * @param obj The notify object
- * @param content The new parent
+ * @param subobj The subobject to be modified in the table
+ * @param x Row number
+ * @param y Column number
+ * @param w rowspan
+ * @param h colspan
*
- * Once the parent object is set, a previously set one will be disconnected
- * and replaced.
+ * Modifies the position of an object already in the table.
+ *
+ * @note All positioning inside the table is relative to rows and columns, so
+ * a value of 0 for x and y, means the top left cell of the table, and a
+ * value of 1 for w and h means @p subobj only takes that 1 cell.
*/
- EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
/**
- * @brief Get the notify parent
+ * @brief Get the packing location of an existing child of the table
*
- * @param obj The notify object
- * @return The parent
+ * @param subobj The subobject to be modified in the table
+ * @param x Row number
+ * @param y Column number
+ * @param w rowspan
+ * @param h colspan
*
- * @see elm_notify_parent_set()
+ * @see elm_table_pack_set()
*/
- EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
/**
- * @brief Set the orientation
+ * @}
+ */
+
+ /**
+ * @defgroup Gengrid Gengrid (Generic grid)
*
- * @param obj The notify object
- * @param orient The new orientation
+ * This widget aims to position objects in a grid layout while
+ * actually creating and rendering only the visible ones, using the
+ * same idea as the @ref Genlist "genlist": the user defines a @b
+ * class for each item, specifying functions that will be called at
+ * object creation, deletion, etc. When those items are selected by
+ * the user, a callback function is issued. Users may interact with
+ * a gengrid via the mouse (by clicking on items to select them and
+ * clicking on the grid's viewport and swiping to pan the whole
+ * view) or via the keyboard, navigating through item with the
+ * arrow keys.
*
- * Sets the position in which the notify will appear in its parent.
+ * @section Gengrid_Layouts Gengrid layouts
*
- * @see @ref Elm_Notify_Orient for possible values.
- */
- EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
- /**
- * @brief Return the orientation
- * @param obj The notify object
- * @return The orientation of the notification
+ * Gengrids may layout its items in one of two possible layouts:
+ * - horizontal or
+ * - vertical.
*
- * @see elm_notify_orient_set()
- * @see Elm_Notify_Orient
- */
- EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the time interval after which the notify window is going to be
- * hidden.
+ * When in "horizontal mode", items will be placed in @b columns,
+ * from top to bottom and, when the space for a column is filled,
+ * another one is started on the right, thus expanding the grid
+ * horizontally, making for horizontal scrolling. When in "vertical
+ * mode" , though, items will be placed in @b rows, from left to
+ * right and, when the space for a row is filled, another one is
+ * started below, thus expanding the grid vertically (and making
+ * for vertical scrolling).
*
- * @param obj The notify object
- * @param time The timeout in seconds
+ * @section Gengrid_Items Gengrid items
*
- * This function sets a timeout and starts the timer controlling when the
- * notify is hidden. Since calling evas_object_show() on a notify restarts
- * the timer controlling when the notify is hidden, setting this before the
- * notify is shown will in effect mean starting the timer when the notify is
- * shown.
+ * An item in a gengrid can have 0 or more text labels (they can be
+ * regular text or textblock Evas objects - that's up to the style
+ * to determine), 0 or more icons (which are simply objects
+ * swallowed into the gengrid item's theming Edje object) and 0 or
+ * more <b>boolean states</b>, which have the behavior left to the
+ * user to define. The Edje part names for each of these properties
+ * will be looked up, in the theme file for the gengrid, under the
+ * Edje (string) data items named @c "labels", @c "icons" and @c
+ * "states", respectively. For each of those properties, if more
+ * than one part is provided, they must have names listed separated
+ * by spaces in the data fields. For the default gengrid item
+ * theme, we have @b one label part (@c "elm.text"), @b two icon
+ * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
+ * no state parts.
*
- * @note Set a value <= 0.0 to disable a running timer.
+ * A gengrid item may be at one of several styles. Elementary
+ * provides one by default - "default", but this can be extended by
+ * system or application custom themes/overlays/extensions (see
+ * @ref Theme "themes" for more details).
*
- * @note If the value > 0.0 and the notify is previously visible, the
- * timer will be started with this value, canceling any running timer.
- */
- EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
- /**
- * @brief Return the timeout value (in seconds)
- * @param obj the notify object
+ * @section Gengrid_Item_Class Gengrid item classes
*
- * @see elm_notify_timeout_set()
- */
- EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Sets whether events should be passed to by a click outside
- * its area.
+ * In order to have the ability to add and delete items on the fly,
+ * gengrid implements a class (callback) system where the
+ * application provides a structure with information about that
+ * type of item (gengrid may contain multiple different items with
+ * different classes, states and styles). Gengrid will call the
+ * functions in this struct (methods) when an item is "realized"
+ * (i.e., created dynamically, while the user is scrolling the
+ * grid). All objects will simply be deleted when no longer needed
+ * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
+ * contains the following members:
+ * - @c item_style - This is a constant string and simply defines
+ * the name of the item style. It @b must be specified and the
+ * default should be @c "default".
+ * - @c func.label_get - This function is called when an item
+ * object is actually created. The @c data parameter will point to
+ * the same data passed to elm_gengrid_item_append() and related
+ * item creation functions. The @c obj parameter is the gengrid
+ * object itself, while the @c part one is the name string of one
+ * of the existing text parts in the Edje group implementing the
+ * item's theme. This function @b must return a strdup'()ed string,
+ * as the caller will free() it when done. See
+ * #Elm_Gengrid_Item_Label_Get_Cb.
+ * - @c func.icon_get - This function is called when an item object
+ * is actually created. The @c data parameter will point to the
+ * same data passed to elm_gengrid_item_append() and related item
+ * creation functions. The @c obj parameter is the gengrid object
+ * itself, while the @c part one is the name string of one of the
+ * existing (icon) swallow parts in the Edje group implementing the
+ * item's theme. It must return @c NULL, when no icon is desired,
+ * or a valid object handle, otherwise. The object will be deleted
+ * by the gengrid on its deletion or when the item is "unrealized".
+ * See #Elm_Gengrid_Item_Icon_Get_Cb.
+ * - @c func.state_get - This function is called when an item
+ * object is actually created. The @c data parameter will point to
+ * the same data passed to elm_gengrid_item_append() and related
+ * item creation functions. The @c obj parameter is the gengrid
+ * object itself, while the @c part one is the name string of one
+ * of the state parts in the Edje group implementing the item's
+ * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
+ * true/on. Gengrids will emit a signal to its theming Edje object
+ * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
+ * "source" arguments, respectively, when the state is true (the
+ * default is false), where @c XXX is the name of the (state) part.
+ * See #Elm_Gengrid_Item_State_Get_Cb.
+ * - @c func.del - This is called when elm_gengrid_item_del() is
+ * called on an item or elm_gengrid_clear() is called on the
+ * gengrid. This is intended for use when gengrid items are
+ * deleted, so any data attached to the item (e.g. its data
+ * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
*
- * @param obj The notify object
- * @param repeats EINA_TRUE Events are repeats, else no
+ * @section Gengrid_Usage_Hints Usage hints
*
- * When true if the user clicks outside the window the events will be caught
- * by the others widgets, else the events are blocked.
+ * If the user wants to have multiple items selected at the same
+ * time, elm_gengrid_multi_select_set() will permit it. If the
+ * gengrid is single-selection only (the default), then
+ * elm_gengrid_select_item_get() will return the selected item or
+ * @c NULL, if none is selected. If the gengrid is under
+ * multi-selection, then elm_gengrid_selected_items_get() will
+ * return a list (that is only valid as long as no items are
+ * modified (added, deleted, selected or unselected) of child items
+ * on a gengrid.
*
- * @note The default value is EINA_TRUE.
+ * If an item changes (internal (boolean) state, label or icon
+ * changes), then use elm_gengrid_item_update() to have gengrid
+ * update the item with the new state. A gengrid will re-"realize"
+ * the item, thus calling the functions in the
+ * #Elm_Gengrid_Item_Class set for that item.
+ *
+ * To programmatically (un)select an item, use
+ * elm_gengrid_item_selected_set(). To get its selected state use
+ * elm_gengrid_item_selected_get(). To make an item disabled
+ * (unable to be selected and appear differently) use
+ * elm_gengrid_item_disabled_set() to set this and
+ * elm_gengrid_item_disabled_get() to get the disabled state.
+ *
+ * Grid cells will only have their selection smart callbacks called
+ * when firstly getting selected. Any further clicks will do
+ * nothing, unless you enable the "always select mode", with
+ * elm_gengrid_always_select_mode_set(), thus making every click to
+ * issue selection callbacks. elm_gengrid_no_select_mode_set() will
+ * turn off the ability to select items entirely in the widget and
+ * they will neither appear selected nor call the selection smart
+ * callbacks.
+ *
+ * Remember that you can create new styles and add your own theme
+ * augmentation per application with elm_theme_extension_add(). If
+ * you absolutely must have a specific style that overrides any
+ * theme the user or system sets up you can use
+ * elm_theme_overlay_add() to add such a file.
+ *
+ * @section Gengrid_Smart_Events Gengrid smart events
+ *
+ * Smart events that you can add callbacks for are:
+ * - @c "activated" - The user has double-clicked or pressed
+ * (enter|return|spacebar) on an item. The @c event_info parameter
+ * is the gengrid item that was activated.
+ * - @c "clicked,double" - The user has double-clicked an item.
+ * The @c event_info parameter is the gengrid item that was double-clicked.
+ * - @c "longpressed" - This is called when the item is pressed for a certain
+ * amount of time. By default it's 1 second.
+ * - @c "selected" - The user has made an item selected. The
+ * @c event_info parameter is the gengrid item that was selected.
+ * - @c "unselected" - The user has made an item unselected. The
+ * @c event_info parameter is the gengrid item that was unselected.
+ * - @c "realized" - This is called when the item in the gengrid
+ * has its implementing Evas object instantiated, de facto. @c
+ * event_info is the gengrid item that was created. The object
+ * may be deleted at any time, so it is highly advised to the
+ * caller @b not to use the object pointer returned from
+ * elm_gengrid_item_object_get(), because it may point to freed
+ * objects.
+ * - @c "unrealized" - This is called when the implementing Evas
+ * object for this item is deleted. @c event_info is the gengrid
+ * item that was deleted.
+ * - @c "changed" - Called when an item is added, removed, resized
+ * or moved and when the gengrid is resized or gets "horizontal"
+ * property changes.
+ * - @c "scroll,anim,start" - This is called when scrolling animation has
+ * started.
+ * - @c "scroll,anim,stop" - This is called when scrolling animation has
+ * stopped.
+ * - @c "drag,start,up" - Called when the item in the gengrid has
+ * been dragged (not scrolled) up.
+ * - @c "drag,start,down" - Called when the item in the gengrid has
+ * been dragged (not scrolled) down.
+ * - @c "drag,start,left" - Called when the item in the gengrid has
+ * been dragged (not scrolled) left.
+ * - @c "drag,start,right" - Called when the item in the gengrid has
+ * been dragged (not scrolled) right.
+ * - @c "drag,stop" - Called when the item in the gengrid has
+ * stopped being dragged.
+ * - @c "drag" - Called when the item in the gengrid is being
+ * dragged.
+ * - @c "scroll" - called when the content has been scrolled
+ * (moved).
+ * - @c "scroll,drag,start" - called when dragging the content has
+ * started.
+ * - @c "scroll,drag,stop" - called when dragging the content has
+ * stopped.
+ * - @c "scroll,edge,top" - This is called when the gengrid is scrolled until
+ * the top edge.
+ * - @c "scroll,edge,bottom" - This is called when the gengrid is scrolled
+ * until the bottom edge.
+ * - @c "scroll,edge,left" - This is called when the gengrid is scrolled
+ * until the left edge.
+ * - @c "scroll,edge,right" - This is called when the gengrid is scrolled
+ * until the right edge.
+ *
+ * List of gengrid examples:
+ * @li @ref gengrid_example
*/
- EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
+
/**
- * @brief Return true if events are repeat below the notify object
- * @param obj the notify object
- *
- * @see elm_notify_repeat_events_set()
+ * @addtogroup Gengrid
+ * @{
*/
- EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
+ typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
+ typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
+ typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
+ typedef Evas_Object *(*Elm_Gengrid_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
+ typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
+ typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
+
+ typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
+ typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
+ typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
+ typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
+
/**
- * @}
+ * @struct _Elm_Gengrid_Item_Class
+ *
+ * Gengrid item class definition. See @ref Gengrid_Item_Class for
+ * field details.
*/
+ struct _Elm_Gengrid_Item_Class
+ {
+ const char *item_style;
+ struct _Elm_Gengrid_Item_Class_Func
+ {
+ Elm_Gengrid_Item_Label_Get_Cb label_get;
+ Elm_Gengrid_Item_Icon_Get_Cb icon_get;
+ Elm_Gengrid_Item_State_Get_Cb state_get;
+ Elm_Gengrid_Item_Del_Cb del;
+ } func;
+ }; /**< #Elm_Gengrid_Item_Class member definitions */
/**
- * @defgroup Hover Hover
+ * Add a new gengrid widget to the given parent Elementary
+ * (container) object
*
- * @image html img/widget/hover/preview-00.png
- * @image latex img/widget/hover/preview-00.eps
+ * @param parent The parent object
+ * @return a new gengrid widget handle or @c NULL, on errors
*
- * A Hover object will hover over its @p parent object at the @p target
- * location. Anything in the background will be given a darker coloring to
- * indicate that the hover object is on top (at the default theme). When the
- * hover is clicked it is dismissed(hidden), if the contents of the hover are
- * clicked that @b doesn't cause the hover to be dismissed.
+ * This function inserts a new gengrid widget on the canvas.
*
- * @note The hover object will take up the entire space of @p target
- * object.
+ * @see elm_gengrid_item_size_set()
+ * @see elm_gengrid_group_item_size_set()
+ * @see elm_gengrid_horizontal_set()
+ * @see elm_gengrid_item_append()
+ * @see elm_gengrid_item_del()
+ * @see elm_gengrid_clear()
*
- * Elementary has the following styles for the hover widget:
- * @li default
- * @li popout
- * @li menu
- * @li hoversel_vertical
+ * @ingroup Gengrid
+ */
+ EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the size for the items of a given gengrid widget
*
- * The following are the available position for content:
- * @li left
- * @li top-left
- * @li top
- * @li top-right
- * @li right
- * @li bottom-right
- * @li bottom
- * @li bottom-left
- * @li middle
- * @li smart
+ * @param obj The gengrid object.
+ * @param w The items' width.
+ * @param h The items' height;
*
- * Signals that you can add callbacks for are:
- * @li "clicked" - the user clicked the empty space in the hover to dismiss
- * @li "smart,changed" - a content object placed under the "smart"
- * policy was replaced to a new slot direction.
+ * A gengrid, after creation, has still no information on the size
+ * to give to each of its cells. So, you most probably will end up
+ * with squares one @ref Fingers "finger" wide, the default
+ * size. Use this function to force a custom size for you items,
+ * making them as big as you wish.
*
- * See @ref tutorial_hover for more information.
+ * @see elm_gengrid_item_size_get()
*
- * @{
+ * @ingroup Gengrid
*/
- typedef enum _Elm_Hover_Axis
- {
- ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
- ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
- ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
- ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
- } Elm_Hover_Axis;
+ EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
+
/**
- * @brief Adds a hover object to @p parent
+ * Get the size set for the items of a given gengrid widget
*
- * @param parent The parent object
- * @return The hover object or NULL if one could not be created
- */
- EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
- /**
- * @brief Sets the target object for the hover.
+ * @param obj The gengrid object.
+ * @param w Pointer to a variable where to store the items' width.
+ * @param h Pointer to a variable where to store the items' height.
*
- * @param obj The hover object
- * @param target The object to center the hover onto. The hover
+ * @note Use @c NULL pointers on the size values you're not
+ * interested in: they'll be ignored by the function.
*
- * This function will cause the hover to be centered on the target object.
+ * @see elm_gengrid_item_size_get() for more details
+ *
+ * @ingroup Gengrid
*/
- EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
+ EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
+
/**
- * @brief Gets the target object for the hover.
+ * Set the size for the group items of a given gengrid widget
*
- * @param obj The hover object
- * @param parent The object to locate the hover over.
+ * @param obj The gengrid object.
+ * @param w The group items' width.
+ * @param h The group items' height;
*
- * @see elm_hover_target_set()
+ * A gengrid, after creation, has still no information on the size
+ * to give to each of its cells. So, you most probably will end up
+ * with squares one @ref Fingers "finger" wide, the default
+ * size. Use this function to force a custom size for you group items,
+ * making them as big as you wish.
+ *
+ * @see elm_gengrid_group_item_size_get()
+ *
+ * @ingroup Gengrid
*/
- EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
+
/**
- * @brief Sets the parent object for the hover.
+ * Get the size set for the group items of a given gengrid widget
*
- * @param obj The hover object
- * @param parent The object to locate the hover over.
+ * @param obj The gengrid object.
+ * @param w Pointer to a variable where to store the group items' width.
+ * @param h Pointer to a variable where to store the group items' height.
*
- * This function will cause the hover to take up the entire space that the
- * parent object fills.
+ * @note Use @c NULL pointers on the size values you're not
+ * interested in: they'll be ignored by the function.
+ *
+ * @see elm_gengrid_group_item_size_get() for more details
+ *
+ * @ingroup Gengrid
*/
- EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
+
/**
- * @brief Gets the parent object for the hover.
+ * Set the items grid's alignment within a given gengrid widget
*
- * @param obj The hover object
- * @return The parent object to locate the hover over.
+ * @param obj The gengrid object.
+ * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
+ * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
*
- * @see elm_hover_parent_set()
+ * This sets the alignment of the whole grid of items of a gengrid
+ * within its given viewport. By default, those values are both
+ * 0.5, meaning that the gengrid will have its items grid placed
+ * exactly in the middle of its viewport.
+ *
+ * @note If given alignment values are out of the cited ranges,
+ * they'll be changed to the nearest boundary values on the valid
+ * ranges.
+ *
+ * @see elm_gengrid_align_get()
+ *
+ * @ingroup Gengrid
*/
- EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
+
/**
- * @brief Sets the content of the hover object and the direction in which it
- * will pop out.
+ * Get the items grid's alignment values within a given gengrid
+ * widget
*
- * @param obj The hover object
- * @param swallow The direction that the object will be displayed
- * at. Accepted values are "left", "top-left", "top", "top-right",
- * "right", "bottom-right", "bottom", "bottom-left", "middle" and
- * "smart".
- * @param content The content to place at @p swallow
+ * @param obj The gengrid object.
+ * @param align_x Pointer to a variable where to store the
+ * horizontal alignment.
+ * @param align_y Pointer to a variable where to store the vertical
+ * alignment.
*
- * Once the content object is set for a given direction, a previously
- * set one (on the same direction) will be deleted. If you want to
- * keep that old content object, use the elm_hover_content_unset()
- * function.
+ * @note Use @c NULL pointers on the alignment values you're not
+ * interested in: they'll be ignored by the function.
*
- * All directions may have contents at the same time, except for
- * "smart". This is a special placement hint and its use case
- * independs of the calculations coming from
- * elm_hover_best_content_location_get(). Its use is for cases when
- * one desires only one hover content, but with a dinamic special
- * placement within the hover area. The content's geometry, whenever
- * it changes, will be used to decide on a best location not
- * extrapolating the hover's parent object view to show it in (still
- * being the hover's target determinant of its medium part -- move and
- * resize it to simulate finger sizes, for example). If one of the
- * directions other than "smart" are used, a previously content set
- * using it will be deleted, and vice-versa.
+ * @see elm_gengrid_align_set() for more details
+ *
+ * @ingroup Gengrid
*/
- EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
+ EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the content of the hover object, in a given direction.
+ * Set whether a given gengrid widget is or not able have items
+ * @b reordered
*
- * Return the content object which was set for this widget in the
- * @p swallow direction.
+ * @param obj The gengrid object
+ * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
+ * @c EINA_FALSE to turn it off
*
- * @param obj The hover object
- * @param swallow The direction that the object was display at.
- * @return The content that was being used
+ * If a gengrid is set to allow reordering, a click held for more
+ * than 0.5 over a given item will highlight it specially,
+ * signalling the gengrid has entered the reordering state. From
+ * that time on, the user will be able to, while still holding the
+ * mouse button down, move the item freely in the gengrid's
+ * viewport, replacing to said item to the locations it goes to.
+ * The replacements will be animated and, whenever the user
+ * releases the mouse button, the item being replaced gets a new
+ * definitive place in the grid.
*
- * @see elm_hover_content_set()
+ * @see elm_gengrid_reorder_mode_get()
+ *
+ * @ingroup Gengrid
*/
- EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+ EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
+
/**
- * @brief Unset the content of the hover object, in a given direction.
+ * Get whether a given gengrid widget is or not able have items
+ * @b reordered
*
- * Unparent and return the content object set at @p swallow direction.
+ * @param obj The gengrid object
+ * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
+ * off
*
- * @param obj The hover object
- * @param swallow The direction that the object was display at.
- * @return The content that was being used.
+ * @see elm_gengrid_reorder_mode_set() for more details
*
- * @see elm_hover_content_set()
+ * @ingroup Gengrid
*/
- EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * @brief Returns the best swallow location for content in the hover.
- *
- * @param obj The hover object
- * @param pref_axis The preferred orientation axis for the hover object to use
- * @return The edje location to place content into the hover or @c
- * NULL, on errors.
+ * Append a new item in a given gengrid widget.
*
- * Best is defined here as the location at which there is the most available
- * space.
+ * @param obj The gengrid object.
+ * @param gic The item class for the item.
+ * @param data The item data.
+ * @param func Convenience function called when the item is
+ * selected.
+ * @param func_data Data to be passed to @p func.
+ * @return A handle to the item added or @c NULL, on errors.
*
- * @p pref_axis may be one of
- * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
- * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
- * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
- * - @c ELM_HOVER_AXIS_BOTH -- both
+ * This adds an item to the beginning of the gengrid.
*
- * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
- * nescessarily be along the horizontal axis("left" or "right"). If
- * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
- * be along the vertical axis("top" or "bottom"). Chossing
- * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
- * returned position may be in either axis.
+ * @see elm_gengrid_item_prepend()
+ * @see elm_gengrid_item_insert_before()
+ * @see elm_gengrid_item_insert_after()
+ * @see elm_gengrid_item_del()
*
- * @see elm_hover_content_set()
+ * @ingroup Gengrid
*/
- EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
+ 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);
+
/**
- * @}
+ * Prepend a new item in a given gengrid widget.
+ *
+ * @param obj The gengrid object.
+ * @param gic The item class for the item.
+ * @param data The item data.
+ * @param func Convenience function called when the item is
+ * selected.
+ * @param func_data Data to be passed to @p func.
+ * @return A handle to the item added or @c NULL, on errors.
+ *
+ * This adds an item to the end of the gengrid.
+ *
+ * @see elm_gengrid_item_append()
+ * @see elm_gengrid_item_insert_before()
+ * @see elm_gengrid_item_insert_after()
+ * @see elm_gengrid_item_del()
+ *
+ * @ingroup Gengrid
*/
+ 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);
- /* entry */
/**
- * @defgroup Entry Entry
+ * Insert an item before another in a gengrid widget
*
- * @image html img/widget/entry/preview-00.png
- * @image latex img/widget/entry/preview-00.eps width=\textwidth
- * @image html img/widget/entry/preview-01.png
- * @image latex img/widget/entry/preview-01.eps width=\textwidth
- * @image html img/widget/entry/preview-02.png
- * @image latex img/widget/entry/preview-02.eps width=\textwidth
- * @image html img/widget/entry/preview-03.png
- * @image latex img/widget/entry/preview-03.eps width=\textwidth
+ * @param obj The gengrid object.
+ * @param gic The item class for the item.
+ * @param data The item data.
+ * @param relative The item to place this new one before.
+ * @param func Convenience function called when the item is
+ * selected.
+ * @param func_data Data to be passed to @p func.
+ * @return A handle to the item added or @c NULL, on errors.
*
- * An entry is a convenience widget which shows a box that the user can
- * enter text into. Entries by default don't scroll, so they grow to
- * accomodate the entire text, resizing the parent window as needed. This
- * can be changed with the elm_entry_scrollable_set() function.
+ * This inserts an item before another in the gengrid.
*
- * They can also be single line or multi line (the default) and when set
- * to multi line mode they support text wrapping in any of the modes
- * indicated by #Elm_Wrap_Type.
+ * @see elm_gengrid_item_append()
+ * @see elm_gengrid_item_prepend()
+ * @see elm_gengrid_item_insert_after()
+ * @see elm_gengrid_item_del()
*
- * Other features include password mode, filtering of inserted text with
- * elm_entry_text_filter_append() and related functions, inline "items" and
- * formatted markup text.
+ * @ingroup Gengrid
+ */
+ 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);
+
+ /**
+ * Insert an item after another in a gengrid widget
*
- * @section entry-markup Formatted text
+ * @param obj The gengrid object.
+ * @param gic The item class for the item.
+ * @param data The item data.
+ * @param relative The item to place this new one after.
+ * @param func Convenience function called when the item is
+ * selected.
+ * @param func_data Data to be passed to @p func.
+ * @return A handle to the item added or @c NULL, on errors.
*
- * The markup tags supported by the Entry are defined by the theme, but
- * even when writing new themes or extensions it's a good idea to stick to
- * a sane default, to maintain coherency and avoid application breakages.
- * Currently defined by the default theme are the following tags:
- * @li \<br\>: Inserts a line break.
- * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
- * breaks.
- * @li \<tab\>: Inserts a tab.
- * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
- * enclosed text.
- * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
- * @li \<link\>...\</link\>: Underlines the enclosed text.
- * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
+ * This inserts an item after another in the gengrid.
*
- * @section entry-special Special markups
+ * @see elm_gengrid_item_append()
+ * @see elm_gengrid_item_prepend()
+ * @see elm_gengrid_item_insert_after()
+ * @see elm_gengrid_item_del()
*
- * Besides those used to format text, entries support two special markup
- * tags used to insert clickable portions of text or items inlined within
- * the text.
+ * @ingroup Gengrid
+ */
+ 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);
+
+ EAPI Elm_Gengrid_Item *elm_gengrid_item_sorted_insert(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
+
+ EAPI Elm_Gengrid_Item *elm_gengrid_item_direct_sorted_insert(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
+
+ /**
+ * Set whether items on a given gengrid widget are to get their
+ * selection callbacks issued for @b every subsequent selection
+ * click on them or just for the first click.
*
- * @subsection entry-anchors Anchors
+ * @param obj The gengrid object
+ * @param always_select @c EINA_TRUE to make items "always
+ * selected", @c EINA_FALSE, otherwise
*
- * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
- * \</a\> tags and an event will be generated when this text is clicked,
- * like this:
+ * By default, grid items will only call their selection callback
+ * function when firstly getting selected, any subsequent further
+ * clicks will do nothing. With this call, you make those
+ * subsequent clicks also to issue the selection callbacks.
*
- * @code
- * This text is outside <a href=anc-01>but this one is an anchor</a>
- * @endcode
+ * @note <b>Double clicks</b> will @b always be reported on items.
*
- * The @c href attribute in the opening tag gives the name that will be
- * used to identify the anchor and it can be any valid utf8 string.
+ * @see elm_gengrid_always_select_mode_get()
*
- * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
- * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
- * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
- * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
- * an anchor.
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get whether items on a given gengrid widget have their selection
+ * callbacks issued for @b every subsequent selection click on them
+ * or just for the first click.
*
- * @subsection entry-items Items
+ * @param obj The gengrid object.
+ * @return @c EINA_TRUE if the gengrid items are "always selected",
+ * @c EINA_FALSE, otherwise
*
- * Inlined in the text, any other @c Evas_Object can be inserted by using
- * \<item\> tags this way:
+ * @see elm_gengrid_always_select_mode_set() for more details
*
- * @code
- * <item size=16x16 vsize=full href=emoticon/haha></item>
- * @endcode
+ * @ingroup Gengrid
+ */
+ EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set whether items on a given gengrid widget can be selected or not.
*
- * Just like with anchors, the @c href identifies each item, but these need,
- * in addition, to indicate their size, which is done using any one of
- * @c size, @c absize or @c relsize attributes. These attributes take their
- * value in the WxH format, where W is the width and H the height of the
- * item.
+ * @param obj The gengrid object
+ * @param no_select @c EINA_TRUE to make items selectable,
+ * @c EINA_FALSE otherwise
*
- * @li absize: Absolute pixel size for the item. Whatever value is set will
- * be the item's size regardless of any scale value the object may have
- * been set to. The final line height will be adjusted to fit larger items.
- * @li size: Similar to @c absize, but it's adjusted to the scale value set
- * for the object.
- * @li relsize: Size is adjusted for the item to fit within the current
- * line height.
+ * This will make items in @p obj selectable or not. In the latter
+ * case, any user interaction on the gengrid items will neither make
+ * them appear selected nor them call their selection callback
+ * functions.
*
- * Besides their size, items are specificed a @c vsize value that affects
- * how their final size and position are calculated. The possible values
- * are:
- * @li ascent: Item will be placed within the line's baseline and its
- * ascent. That is, the height between the line where all characters are
- * positioned and the highest point in the line. For @c size and @c absize
- * items, the descent value will be added to the total line height to make
- * them fit. @c relsize items will be adjusted to fit within this space.
- * @li full: Items will be placed between the descent and ascent, or the
- * lowest point in the line and its highest.
+ * @see elm_gengrid_no_select_mode_get()
*
- * The next image shows different configurations of items and how they
- * are the previously mentioned options affect their sizes. In all cases,
- * the green line indicates the ascent, blue for the baseline and red for
- * the descent.
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get whether items on a given gengrid widget can be selected or
+ * not.
*
- * @image html entry_item.png
- * @image latex entry_item.eps width=\textwidth
+ * @param obj The gengrid object
+ * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
+ * otherwise
*
- * And another one to show how size differs from absize. In the first one,
- * the scale value is set to 1.0, while the second one is using one of 2.0.
+ * @see elm_gengrid_no_select_mode_set() for more details
*
- * @image html entry_item_scale.png
- * @image latex entry_item_scale.eps width=\textwidth
+ * @ingroup Gengrid
+ */
+ EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Enable or disable multi-selection in a given gengrid widget
*
- * After the size for an item is calculated, the entry will request an
- * object to place in its space. For this, the functions set with
- * elm_entry_item_provider_append() and related functions will be called
- * in order until one of them returns a @c non-NULL value. If no providers
- * are available, or all of them return @c NULL, then the entry falls back
- * to one of the internal defaults, provided the name matches with one of
- * them.
+ * @param obj The gengrid object.
+ * @param multi @c EINA_TRUE, to enable multi-selection,
+ * @c EINA_FALSE to disable it.
*
- * All of the following are currently supported:
+ * Multi-selection is the ability for one to have @b more than one
+ * item selected, on a given gengrid, simultaneously. When it is
+ * enabled, a sequence of clicks on different items will make them
+ * all selected, progressively. A click on an already selected item
+ * will unselect it. If interecting via the keyboard,
+ * multi-selection is enabled while holding the "Shift" key.
*
- * - emoticon/angry
- * - emoticon/angry-shout
- * - emoticon/crazy-laugh
- * - emoticon/evil-laugh
- * - emoticon/evil
- * - emoticon/goggle-smile
- * - emoticon/grumpy
- * - emoticon/grumpy-smile
- * - emoticon/guilty
- * - emoticon/guilty-smile
- * - emoticon/haha
- * - emoticon/half-smile
- * - emoticon/happy-panting
- * - emoticon/happy
- * - emoticon/indifferent
- * - emoticon/kiss
- * - emoticon/knowing-grin
- * - emoticon/laugh
- * - emoticon/little-bit-sorry
- * - emoticon/love-lots
- * - emoticon/love
- * - emoticon/minimal-smile
- * - emoticon/not-happy
- * - emoticon/not-impressed
- * - emoticon/omg
- * - emoticon/opensmile
- * - emoticon/smile
- * - emoticon/sorry
- * - emoticon/squint-laugh
- * - emoticon/surprised
- * - emoticon/suspicious
- * - emoticon/tongue-dangling
- * - emoticon/tongue-poke
- * - emoticon/uh
- * - emoticon/unhappy
- * - emoticon/very-sorry
- * - emoticon/what
- * - emoticon/wink
- * - emoticon/worried
- * - emoticon/wtf
+ * @note By default, multi-selection is @b disabled on gengrids
*
- * Alternatively, an item may reference an image by its path, using
- * the URI form @c file:///path/to/an/image.png and the entry will then
- * use that image for the item.
+ * @see elm_gengrid_multi_select_get()
*
- * @section entry-files Loading and saving files
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get whether multi-selection is enabled or disabled for a given
+ * gengrid widget
*
- * Entries have convinience functions to load text from a file and save
- * changes back to it after a short delay. The automatic saving is enabled
- * by default, but can be disabled with elm_entry_autosave_set() and files
- * can be loaded directly as plain text or have any markup in them
- * recognized. See elm_entry_file_set() for more details.
+ * @param obj The gengrid object.
+ * @return @c EINA_TRUE, if multi-selection is enabled, @c
+ * EINA_FALSE otherwise
*
- * @section entry-signals Emitted signals
+ * @see elm_gengrid_multi_select_set() for more details
*
- * This widget emits the following signals:
+ * @ingroup Gengrid
+ */
+ EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Enable or disable bouncing effect for a given gengrid widget
*
- * @li "changed": The text within the entry was changed.
- * @li "changed,user": The text within the entry was changed because of user interaction.
- * @li "activated": The enter key was pressed on a single line entry.
- * @li "press": A mouse button has been pressed on the entry.
- * @li "longpressed": A mouse button has been pressed and held for a couple
- * seconds.
- * @li "clicked": The entry has been clicked (mouse press and release).
- * @li "clicked,double": The entry has been double clicked.
- * @li "clicked,triple": The entry has been triple clicked.
- * @li "focused": The entry has received focus.
- * @li "unfocused": The entry has lost focus.
- * @li "selection,paste": A paste of the clipboard contents was requested.
- * @li "selection,copy": A copy of the selected text into the clipboard was
- * requested.
- * @li "selection,cut": A cut of the selected text into the clipboard was
- * requested.
- * @li "selection,start": A selection has begun and no previous selection
- * existed.
- * @li "selection,changed": The current selection has changed.
- * @li "selection,cleared": The current selection has been cleared.
- * @li "cursor,changed": The cursor has changed position.
- * @li "anchor,clicked": An anchor has been clicked. The event_info
- * parameter for the callback will be an #Elm_Entry_Anchor_Info.
- * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
- * parameter for the callback will be an #Elm_Entry_Anchor_Info.
- * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
- * parameter for the callback will be an #Elm_Entry_Anchor_Info.
- * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
- * parameter for the callback will be an #Elm_Entry_Anchor_Info.
- * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
- * parameter for the callback will be an #Elm_Entry_Anchor_Info.
- * @li "preedit,changed": The preedit string has changed.
+ * @param obj The gengrid object
+ * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
+ * @c EINA_FALSE to disable it
+ * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
+ * @c EINA_FALSE to disable it
*
- * @section entry-examples
+ * The bouncing effect occurs whenever one reaches the gengrid's
+ * edge's while panning it -- it will scroll past its limits a
+ * little bit and return to the edge again, in a animated for,
+ * automatically.
*
- * An overview of the Entry API can be seen in @ref entry_example_01
+ * @note By default, gengrids have bouncing enabled on both axis
*
- * @{
+ * @see elm_gengrid_bounce_get()
+ *
+ * @ingroup Gengrid
*/
+ EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+
/**
- * @typedef Elm_Entry_Anchor_Info
+ * Get whether bouncing effects are enabled or disabled, for a
+ * given gengrid widget, on each axis
*
- * The info sent in the callback for the "anchor,clicked" signals emitted
- * by entries.
+ * @param obj The gengrid object
+ * @param h_bounce Pointer to a variable where to store the
+ * horizontal bouncing flag.
+ * @param v_bounce Pointer to a variable where to store the
+ * vertical bouncing flag.
+ *
+ * @see elm_gengrid_bounce_set() for more details
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set a given gengrid widget's scrolling page size, relative to
+ * its viewport size.
+ *
+ * @param obj The gengrid object
+ * @param h_pagerel The horizontal page (relative) size
+ * @param v_pagerel The vertical page (relative) size
+ *
+ * The gengrid's scroller is capable of binding scrolling by the
+ * user to "pages". It means that, while scrolling and, specially
+ * after releasing the mouse button, the grid will @b snap to the
+ * nearest displaying page's area. When page sizes are set, the
+ * grid's continuous content area is split into (equal) page sized
+ * pieces.
+ *
+ * This function sets the size of a page <b>relatively to the
+ * viewport dimensions</b> of the gengrid, for each axis. A value
+ * @c 1.0 means "the exact viewport's size", in that axis, while @c
+ * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
+ * a viewport". Sane usable values are, than, between @c 0.0 and @c
+ * 1.0. Values beyond those will make it behave behave
+ * inconsistently. If you only want one axis to snap to pages, use
+ * the value @c 0.0 for the other one.
+ *
+ * There is a function setting page size values in @b absolute
+ * values, too -- elm_gengrid_page_size_set(). Naturally, its use
+ * is mutually exclusive to this one.
+ *
+ * @see elm_gengrid_page_relative_get()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get a given gengrid widget's scrolling page size, relative to
+ * its viewport size.
+ *
+ * @param obj The gengrid object
+ * @param h_pagerel Pointer to a variable where to store the
+ * horizontal page (relative) size
+ * @param v_pagerel Pointer to a variable where to store the
+ * vertical page (relative) size
+ *
+ * @see elm_gengrid_page_relative_set() for more details
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set a given gengrid widget's scrolling page size
+ *
+ * @param obj The gengrid object
+ * @param h_pagerel The horizontal page size, in pixels
+ * @param v_pagerel The vertical page size, in pixels
+ *
+ * The gengrid's scroller is capable of binding scrolling by the
+ * user to "pages". It means that, while scrolling and, specially
+ * after releasing the mouse button, the grid will @b snap to the
+ * nearest displaying page's area. When page sizes are set, the
+ * grid's continuous content area is split into (equal) page sized
+ * pieces.
+ *
+ * This function sets the size of a page of the gengrid, in pixels,
+ * for each axis. Sane usable values are, between @c 0 and the
+ * dimensions of @p obj, for each axis. Values beyond those will
+ * make it behave behave inconsistently. If you only want one axis
+ * to snap to pages, use the value @c 0 for the other one.
+ *
+ * There is a function setting page size values in @b relative
+ * values, too -- elm_gengrid_page_relative_set(). Naturally, its
+ * use is mutually exclusive to this one.
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
+
+ /**
+ * @brief Get gengrid current page number.
+ *
+ * @param obj The gengrid object
+ * @param h_pagenumber The horizontal page number
+ * @param v_pagenumber The vertical page number
+ *
+ * The page number starts from 0. 0 is the first page.
+ * Current page means the page which meet the top-left of the viewport.
+ * If there are two or more pages in the viewport, it returns the number of page
+ * which meet the top-left of the viewport.
+ *
+ * @see elm_gengrid_last_page_get()
+ * @see elm_gengrid_page_show()
+ * @see elm_gengrid_page_brint_in()
+ */
+ EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
+
+ /**
+ * @brief Get scroll last page number.
+ *
+ * @param obj The gengrid object
+ * @param h_pagenumber The horizontal page number
+ * @param v_pagenumber The vertical page number
+ *
+ * The page number starts from 0. 0 is the first page.
+ * This returns the last page number among the pages.
+ *
+ * @see elm_gengrid_current_page_get()
+ * @see elm_gengrid_page_show()
+ * @see elm_gengrid_page_brint_in()
+ */
+ EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
+
+ /**
+ * Show a specific virtual region within the gengrid content object by page number.
+ *
+ * @param obj The gengrid object
+ * @param h_pagenumber The horizontal page number
+ * @param v_pagenumber The vertical page number
+ *
+ * 0, 0 of the indicated page is located at the top-left of the viewport.
+ * This will jump to the page directly without animation.
+ *
+ * Example of usage:
+ *
+ * @code
+ * sc = elm_gengrid_add(win);
+ * elm_gengrid_content_set(sc, content);
+ * elm_gengrid_page_relative_set(sc, 1, 0);
+ * elm_gengrid_current_page_get(sc, &h_page, &v_page);
+ * elm_gengrid_page_show(sc, h_page + 1, v_page);
+ * @endcode
+ *
+ * @see elm_gengrid_page_bring_in()
+ */
+ EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
+
+ /**
+ * Show a specific virtual region within the gengrid content object by page number.
+ *
+ * @param obj The gengrid object
+ * @param h_pagenumber The horizontal page number
+ * @param v_pagenumber The vertical page number
+ *
+ * 0, 0 of the indicated page is located at the top-left of the viewport.
+ * This will slide to the page with animation.
+ *
+ * Example of usage:
+ *
+ * @code
+ * sc = elm_gengrid_add(win);
+ * elm_gengrid_content_set(sc, content);
+ * elm_gengrid_page_relative_set(sc, 1, 0);
+ * elm_gengrid_last_page_get(sc, &h_page, &v_page);
+ * elm_gengrid_page_bring_in(sc, h_page, v_page);
+ * @endcode
+ *
+ * @see elm_gengrid_page_show()
+ */
+ EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set for what direction a given gengrid widget will expand while
+ * placing its items.
+ *
+ * @param obj The gengrid object.
+ * @param setting @c EINA_TRUE to make the gengrid expand
+ * horizontally, @c EINA_FALSE to expand vertically.
+ *
+ * When in "horizontal mode" (@c EINA_TRUE), items will be placed
+ * in @b columns, from top to bottom and, when the space for a
+ * column is filled, another one is started on the right, thus
+ * expanding the grid horizontally. When in "vertical mode"
+ * (@c EINA_FALSE), though, items will be placed in @b rows, from left
+ * to right and, when the space for a row is filled, another one is
+ * started below, thus expanding the grid vertically.
+ *
+ * @see elm_gengrid_horizontal_get()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get for what direction a given gengrid widget will expand while
+ * placing its items.
+ *
+ * @param obj The gengrid object.
+ * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
+ * @c EINA_FALSE if it's set to expand vertically.
+ *
+ * @see elm_gengrid_horizontal_set() for more detais
+ *
+ * @ingroup Gengrid
+ */
+ EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the first item in a given gengrid widget
+ *
+ * @param obj The gengrid object
+ * @return The first item's handle or @c NULL, if there are no
+ * items in @p obj (and on errors)
+ *
+ * This returns the first item in the @p obj's internal list of
+ * items.
+ *
+ * @see elm_gengrid_last_item_get()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the last item in a given gengrid widget
+ *
+ * @param obj The gengrid object
+ * @return The last item's handle or @c NULL, if there are no
+ * items in @p obj (and on errors)
+ *
+ * This returns the last item in the @p obj's internal list of
+ * items.
+ *
+ * @see elm_gengrid_first_item_get()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the @b next item in a gengrid widget's internal list of items,
+ * given a handle to one of those items.
+ *
+ * @param item The gengrid item to fetch next from
+ * @return The item after @p item, or @c NULL if there's none (and
+ * on errors)
+ *
+ * This returns the item placed after the @p item, on the container
+ * gengrid.
+ *
+ * @see elm_gengrid_item_prev_get()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the @b previous item in a gengrid widget's internal list of items,
+ * given a handle to one of those items.
+ *
+ * @param item The gengrid item to fetch previous from
+ * @return The item before @p item, or @c NULL if there's none (and
+ * on errors)
+ *
+ * This returns the item placed before the @p item, on the container
+ * gengrid.
+ *
+ * @see elm_gengrid_item_next_get()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the gengrid object's handle which contains a given gengrid
+ * item
+ *
+ * @param item The item to fetch the container from
+ * @return The gengrid (parent) object
+ *
+ * This returns the gengrid object itself that an item belongs to.
+ *
+ * @ingroup Gengrid
+ */
+ EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Remove a gengrid item from the its parent, deleting it.
+ *
+ * @param item The item to be removed.
+ * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
+ *
+ * @see elm_gengrid_clear(), to remove all items in a gengrid at
+ * once.
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Update the contents of a given gengrid item
+ *
+ * @param item The gengrid item
+ *
+ * This updates an item by calling all the item class functions
+ * again to get the icons, labels and states. Use this when the
+ * original item data has changed and you want thta changes to be
+ * reflected.
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
+
+ /**
+ * Return the data associated to a given gengrid item
+ *
+ * @param item The gengrid item.
+ * @return the data associated to this item.
+ *
+ * This returns the @c data value passed on the
+ * elm_gengrid_item_append() and related item addition calls.
+ *
+ * @see elm_gengrid_item_append()
+ * @see elm_gengrid_item_data_set()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the data associated to a given gengrid item
+ *
+ * @param item The gengrid item
+ * @param data The new data pointer to set on it
+ *
+ * This @b overrides the @c data value passed on the
+ * elm_gengrid_item_append() and related item addition calls. This
+ * function @b won't call elm_gengrid_item_update() automatically,
+ * so you'd issue it afterwards if you want to hove the item
+ * updated to reflect the that new data.
+ *
+ * @see elm_gengrid_item_data_get()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get a given gengrid item's position, relative to the whole
+ * gengrid's grid area.
+ *
+ * @param item The Gengrid item.
+ * @param x Pointer to variable where to store the item's <b>row
+ * number</b>.
+ * @param y Pointer to variable where to store the item's <b>column
+ * number</b>.
+ *
+ * This returns the "logical" position of the item whithin the
+ * gengrid. For example, @c (0, 1) would stand for first row,
+ * second column.
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set whether a given gengrid item is selected or not
+ *
+ * @param item The gengrid item
+ * @param selected Use @c EINA_TRUE, to make it selected, @c
+ * EINA_FALSE to make it unselected
+ *
+ * This sets the selected state of an item. If multi selection is
+ * not enabled on the containing gengrid and @p selected is @c
+ * EINA_TRUE, any other previously selected items will get
+ * unselected in favor of this new one.
+ *
+ * @see elm_gengrid_item_selected_get()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get whether a given gengrid item is selected or not
+ *
+ * @param item The gengrid item
+ * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
+ *
+ * @see elm_gengrid_item_selected_set() for more details
+ *
+ * @ingroup Gengrid
+ */
+ EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the real Evas object created to implement the view of a
+ * given gengrid item
+ *
+ * @param item The gengrid item.
+ * @return the Evas object implementing this item's view.
+ *
+ * This returns the actual Evas object used to implement the
+ * specified gengrid item's view. This may be @c NULL, as it may
+ * not have been created or may have been deleted, at any time, by
+ * the gengrid. <b>Do not modify this object</b> (move, resize,
+ * show, hide, etc.), as the gengrid is controlling it. This
+ * function is for querying, emitting custom signals or hooking
+ * lower level callbacks for events on that object. Do not delete
+ * this object under any circumstances.
+ *
+ * @see elm_gengrid_item_data_get()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Show the portion of a gengrid's internal grid containing a given
+ * item, @b immediately.
+ *
+ * @param item The item to display
+ *
+ * This causes gengrid to @b redraw its viewport's contents to the
+ * region contining the given @p item item, if it is not fully
+ * visible.
+ *
+ * @see elm_gengrid_item_bring_in()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Animatedly bring in, to the visible are of a gengrid, a given
+ * item on it.
+ *
+ * @param item The gengrid item to display
+ *
+ * This causes gengrig to jump to the given @p item item and show
+ * it (by scrolling), if it is not fully visible. This will use
+ * animation to do so and take a period of time to complete.
+ *
+ * @see elm_gengrid_item_show()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set whether a given gengrid item is disabled or not.
+ *
+ * @param item The gengrid item
+ * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
+ * to enable it back.
+ *
+ * A disabled item cannot be selected or unselected. It will also
+ * change its appearance, to signal the user it's disabled.
+ *
+ * @see elm_gengrid_item_disabled_get()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get whether a given gengrid item is disabled or not.
+ *
+ * @param item The gengrid item
+ * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
+ * (and on errors).
+ *
+ * @see elm_gengrid_item_disabled_set() for more details
+ *
+ * @ingroup Gengrid
+ */
+ EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the text to be shown in a given gengrid item's tooltips.
+ *
+ * @param item The gengrid item
+ * @param text The text to set in the content
+ *
+ * This call will setup the text to be used as tooltip to that item
+ * (analogous to elm_object_tooltip_text_set(), but being item
+ * tooltips with higher precedence than object tooltips). It can
+ * have only one tooltip at a time, so any previous tooltip data
+ * will get removed.
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the content to be shown in a given gengrid item's tooltips
+ *
+ * @param item The gengrid item.
+ * @param func The function returning the tooltip contents.
+ * @param data What to provide to @a func as callback data/context.
+ * @param del_cb Called when data is not needed anymore, either when
+ * another callback replaces @p func, the tooltip is unset with
+ * elm_gengrid_item_tooltip_unset() or the owner @p item
+ * dies. This callback receives as its first parameter the
+ * given @p data, being @c event_info the item handle.
+ *
+ * This call will setup the tooltip's contents to @p item
+ * (analogous to elm_object_tooltip_content_cb_set(), but being
+ * item tooltips with higher precedence than object tooltips). It
+ * can have only one tooltip at a time, so any previous tooltip
+ * content will get removed. @p func (with @p data) will be called
+ * every time Elementary needs to show the tooltip and it should
+ * return a valid Evas object, which will be fully managed by the
+ * tooltip system, getting deleted when the tooltip is gone.
+ *
+ * @ingroup Gengrid
+ */
+ 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);
+
+ /**
+ * Unset a tooltip from a given gengrid item
+ *
+ * @param item gengrid item to remove a previously set tooltip from.
+ *
+ * This call removes any tooltip set on @p item. The callback
+ * provided as @c del_cb to
+ * elm_gengrid_item_tooltip_content_cb_set() will be called to
+ * notify it is not used anymore (and have resources cleaned, if
+ * need be).
+ *
+ * @see elm_gengrid_item_tooltip_content_cb_set()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set a different @b style for a given gengrid item's tooltip.
+ *
+ * @param item gengrid item with tooltip set
+ * @param style the <b>theme style</b> to use on tooltips (e.g. @c
+ * "default", @c "transparent", etc)
+ *
+ * Tooltips can have <b>alternate styles</b> to be displayed on,
+ * which are defined by the theme set on Elementary. This function
+ * works analogously as elm_object_tooltip_style_set(), but here
+ * applied only to gengrid item objects. The default style for
+ * tooltips is @c "default".
+ *
+ * @note before you set a style you should define a tooltip with
+ * elm_gengrid_item_tooltip_content_cb_set() or
+ * elm_gengrid_item_tooltip_text_set()
+ *
+ * @see elm_gengrid_item_tooltip_style_get()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the style set a given gengrid item's tooltip.
+ *
+ * @param item gengrid item with tooltip already set on.
+ * @return style the theme style in use, which defaults to
+ * "default". If the object does not have a tooltip set,
+ * then @c NULL is returned.
+ *
+ * @see elm_gengrid_item_tooltip_style_set() for more details
+ *
+ * @ingroup Gengrid
+ */
+ EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Disable size restrictions on an object's tooltip
+ * @param item The tooltip's anchor object
+ * @param disable If EINA_TRUE, size restrictions are disabled
+ * @return EINA_FALSE on failure, EINA_TRUE on success
+ *
+ * This function allows a tooltip to expand beyond its parant window's canvas.
+ * It will instead be limited only by the size of the display.
+ */
+ EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
+ /**
+ * @brief Retrieve size restriction state of an object's tooltip
+ * @param item The tooltip's anchor object
+ * @return If EINA_TRUE, size restrictions are disabled
+ *
+ * This function returns whether a tooltip is allowed to expand beyond
+ * its parant window's canvas.
+ * It will instead be limited only by the size of the display.
+ */
+ EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
+ /**
+ * Set the type of mouse pointer/cursor decoration to be shown,
+ * when the mouse pointer is over the given gengrid widget item
+ *
+ * @param item gengrid item to customize cursor on
+ * @param cursor the cursor type's name
+ *
+ * This function works analogously as elm_object_cursor_set(), but
+ * here the cursor's changing area is restricted to the item's
+ * area, and not the whole widget's. Note that that item cursors
+ * have precedence over widget cursors, so that a mouse over @p
+ * item will always show cursor @p type.
+ *
+ * If this function is called twice for an object, a previously set
+ * cursor will be unset on the second call.
+ *
+ * @see elm_object_cursor_set()
+ * @see elm_gengrid_item_cursor_get()
+ * @see elm_gengrid_item_cursor_unset()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the type of mouse pointer/cursor decoration set to be shown,
+ * when the mouse pointer is over the given gengrid widget item
+ *
+ * @param item gengrid item with custom cursor set
+ * @return the cursor type's name or @c NULL, if no custom cursors
+ * were set to @p item (and on errors)
+ *
+ * @see elm_object_cursor_get()
+ * @see elm_gengrid_item_cursor_set() for more details
+ * @see elm_gengrid_item_cursor_unset()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Unset any custom mouse pointer/cursor decoration set to be
+ * shown, when the mouse pointer is over the given gengrid widget
+ * item, thus making it show the @b default cursor again.
+ *
+ * @param item a gengrid item
+ *
+ * Use this call to undo any custom settings on this item's cursor
+ * decoration, bringing it back to defaults (no custom style set).
+ *
+ * @see elm_object_cursor_unset()
+ * @see elm_gengrid_item_cursor_set() for more details
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set a different @b style for a given custom cursor set for a
+ * gengrid item.
+ *
+ * @param item gengrid item with custom cursor set
+ * @param style the <b>theme style</b> to use (e.g. @c "default",
+ * @c "transparent", etc)
+ *
+ * This function only makes sense when one is using custom mouse
+ * cursor decorations <b>defined in a theme file</b> , which can
+ * have, given a cursor name/type, <b>alternate styles</b> on
+ * it. It works analogously as elm_object_cursor_style_set(), but
+ * here applied only to gengrid item objects.
+ *
+ * @warning Before you set a cursor style you should have defined a
+ * custom cursor previously on the item, with
+ * elm_gengrid_item_cursor_set()
+ *
+ * @see elm_gengrid_item_cursor_engine_only_set()
+ * @see elm_gengrid_item_cursor_style_get()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the current @b style set for a given gengrid item's custom
+ * cursor
+ *
+ * @param item gengrid item with custom cursor set.
+ * @return style the cursor style in use. If the object does not
+ * have a cursor set, then @c NULL is returned.
+ *
+ * @see elm_gengrid_item_cursor_style_set() for more details
+ *
+ * @ingroup Gengrid
+ */
+ EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set if the (custom) cursor for a given gengrid item should be
+ * searched in its theme, also, or should only rely on the
+ * rendering engine.
+ *
+ * @param item item with custom (custom) cursor already set on
+ * @param engine_only Use @c EINA_TRUE to have cursors looked for
+ * only on those provided by the rendering engine, @c EINA_FALSE to
+ * have them searched on the widget's theme, as well.
+ *
+ * @note This call is of use only if you've set a custom cursor
+ * for gengrid items, with elm_gengrid_item_cursor_set().
+ *
+ * @note By default, cursors will only be looked for between those
+ * provided by the rendering engine.
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get if the (custom) cursor for a given gengrid item is being
+ * searched in its theme, also, or is only relying on the rendering
+ * engine.
+ *
+ * @param item a gengrid item
+ * @return @c EINA_TRUE, if cursors are being looked for only on
+ * those provided by the rendering engine, @c EINA_FALSE if they
+ * are being searched on the widget's theme, as well.
+ *
+ * @see elm_gengrid_item_cursor_engine_only_set(), for more details
+ *
+ * @ingroup Gengrid
+ */
+ EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Remove all items from a given gengrid widget
+ *
+ * @param obj The gengrid object.
+ *
+ * This removes (and deletes) all items in @p obj, leaving it
+ * empty.
+ *
+ * @see elm_gengrid_item_del(), to remove just one item.
+ *
+ * @ingroup Gengrid
+ */
+ EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the selected item in a given gengrid widget
+ *
+ * @param obj The gengrid object.
+ * @return The selected item's handleor @c NULL, if none is
+ * selected at the moment (and on errors)
+ *
+ * This returns the selected item in @p obj. If multi selection is
+ * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
+ * the first item in the list is selected, which might not be very
+ * useful. For that case, see elm_gengrid_selected_items_get().
+ *
+ * @ingroup Gengrid
+ */
+ EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get <b>a list</b> of selected items in a given gengrid
+ *
+ * @param obj The gengrid object.
+ * @return The list of selected items or @c NULL, if none is
+ * selected at the moment (and on errors)
+ *
+ * This returns a list of the selected items, in the order that
+ * they appear in the grid. This list is only valid as long as no
+ * more items are selected or unselected (or unselected implictly
+ * by deletion). The list contains #Elm_Gengrid_Item pointers as
+ * data, naturally.
+ *
+ * @see elm_gengrid_selected_item_get()
+ *
+ * @ingroup Gengrid
+ */
+ EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * @}
+ */
+
+ /**
+ * @defgroup Clock Clock
+ *
+ * @image html img/widget/clock/preview-00.png
+ * @image latex img/widget/clock/preview-00.eps
+ *
+ * This is a @b digital clock widget. In its default theme, it has a
+ * vintage "flipping numbers clock" appearance, which will animate
+ * sheets of individual algarisms individually as time goes by.
+ *
+ * A newly created clock will fetch system's time (already
+ * considering local time adjustments) to start with, and will tick
+ * accondingly. It may or may not show seconds.
+ *
+ * Clocks have an @b edition mode. When in it, the sheets will
+ * display extra arrow indications on the top and bottom and the
+ * user may click on them to raise or lower the time values. After
+ * it's told to exit edition mode, it will keep ticking with that
+ * new time set (it keeps the difference from local time).
+ *
+ * Also, when under edition mode, user clicks on the cited arrows
+ * which are @b held for some time will make the clock to flip the
+ * sheet, thus editing the time, continuosly and automatically for
+ * the user. The interval between sheet flips will keep growing in
+ * time, so that it helps the user to reach a time which is distant
+ * from the one set.
+ *
+ * The time display is, by default, in military mode (24h), but an
+ * am/pm indicator may be optionally shown, too, when it will
+ * switch to 12h.
+ *
+ * Smart callbacks one can register to:
+ * - "changed" - the clock's user changed the time
+ *
+ * Here is an example on its usage:
+ * @li @ref clock_example
+ */
+
+ /**
+ * @addtogroup Clock
+ * @{
+ */
+
+ /**
+ * Identifiers for which clock digits should be editable, when a
+ * clock widget is in edition mode. Values may be ORed together to
+ * make a mask, naturally.
+ *
+ * @see elm_clock_edit_set()
+ * @see elm_clock_digit_edit_set()
+ */
+ typedef enum _Elm_Clock_Digedit
+ {
+ ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
+ ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
+ ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
+ ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
+ ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
+ ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
+ ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
+ ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
+ } Elm_Clock_Digedit;
+
+ /**
+ * Add a new clock widget to the given parent Elementary
+ * (container) object
+ *
+ * @param parent The parent object
+ * @return a new clock widget handle or @c NULL, on errors
+ *
+ * This function inserts a new clock widget on the canvas.
+ *
+ * @ingroup Clock
+ */
+ EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set a clock widget's time, programmatically
+ *
+ * @param obj The clock widget object
+ * @param hrs The hours to set
+ * @param min The minutes to set
+ * @param sec The secondes to set
+ *
+ * This function updates the time that is showed by the clock
+ * widget.
+ *
+ * Values @b must be set within the following ranges:
+ * - 0 - 23, for hours
+ * - 0 - 59, for minutes
+ * - 0 - 59, for seconds,
+ *
+ * even if the clock is not in "military" mode.
+ *
+ * @warning The behavior for values set out of those ranges is @b
+ * indefined.
+ *
+ * @ingroup Clock
+ */
+ EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get a clock widget's time values
+ *
+ * @param obj The clock object
+ * @param[out] hrs Pointer to the variable to get the hours value
+ * @param[out] min Pointer to the variable to get the minutes value
+ * @param[out] sec Pointer to the variable to get the seconds value
+ *
+ * This function gets the time set for @p obj, returning
+ * it on the variables passed as the arguments to function
+ *
+ * @note Use @c NULL pointers on the time values you're not
+ * interested in: they'll be ignored by the function.
+ *
+ * @ingroup Clock
+ */
+ EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set whether a given clock widget is under <b>edition mode</b> or
+ * under (default) displaying-only mode.
+ *
+ * @param obj The clock object
+ * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
+ * put it back to "displaying only" mode
+ *
+ * This function makes a clock's time to be editable or not <b>by
+ * user interaction</b>. When in edition mode, clocks @b stop
+ * ticking, until one brings them back to canonical mode. The
+ * elm_clock_digit_edit_set() function will influence which digits
+ * of the clock will be editable. By default, all of them will be
+ * (#ELM_CLOCK_NONE).
+ *
+ * @note am/pm sheets, if being shown, will @b always be editable
+ * under edition mode.
+ *
+ * @see elm_clock_edit_get()
+ *
+ * @ingroup Clock
+ */
+ EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
+
+ /**
+ * Retrieve whether a given clock widget is under <b>edition
+ * mode</b> or under (default) displaying-only mode.
+ *
+ * @param obj The clock object
+ * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
+ * otherwise
+ *
+ * This function retrieves whether the clock's time can be edited
+ * or not by user interaction.
+ *
+ * @see elm_clock_edit_set() for more details
+ *
+ * @ingroup Clock
+ */
+ EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set what digits of the given clock widget should be editable
+ * when in edition mode.
+ *
+ * @param obj The clock object
+ * @param digedit Bit mask indicating the digits to be editable
+ * (values in #Elm_Clock_Digedit).
+ *
+ * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
+ * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
+ * EINA_FALSE).
+ *
+ * @see elm_clock_digit_edit_get()
+ *
+ * @ingroup Clock
+ */
+ EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
+
+ /**
+ * Retrieve what digits of the given clock widget should be
+ * editable when in edition mode.
+ *
+ * @param obj The clock object
+ * @return Bit mask indicating the digits to be editable
+ * (values in #Elm_Clock_Digedit).
+ *
+ * @see elm_clock_digit_edit_set() for more details
+ *
+ * @ingroup Clock
+ */
+ EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set if the given clock widget must show hours in military or
+ * am/pm mode
+ *
+ * @param obj The clock object
+ * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
+ * to military mode
+ *
+ * This function sets if the clock must show hours in military or
+ * am/pm mode. In some countries like Brazil the military mode
+ * (00-24h-format) is used, in opposition to the USA, where the
+ * am/pm mode is more commonly used.
+ *
+ * @see elm_clock_show_am_pm_get()
+ *
+ * @ingroup Clock
+ */
+ EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get if the given clock widget shows hours in military or am/pm
+ * mode
+ *
+ * @param obj The clock object
+ * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
+ * military
+ *
+ * This function gets if the clock shows hours in military or am/pm
+ * mode.
+ *
+ * @see elm_clock_show_am_pm_set() for more details
+ *
+ * @ingroup Clock
+ */
+ EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set if the given clock widget must show time with seconds or not
+ *
+ * @param obj The clock object
+ * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
+ *
+ * This function sets if the given clock must show or not elapsed
+ * seconds. By default, they are @b not shown.
+ *
+ * @see elm_clock_show_seconds_get()
+ *
+ * @ingroup Clock
+ */
+ EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get whether the given clock widget is showing time with seconds
+ * or not
+ *
+ * @param obj The clock object
+ * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
+ *
+ * This function gets whether @p obj is showing or not the elapsed
+ * seconds.
+ *
+ * @see elm_clock_show_seconds_set()
+ *
+ * @ingroup Clock
+ */
+ EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the interval on time updates for an user mouse button hold
+ * on clock widgets' time edition.
+ *
+ * @param obj The clock object
+ * @param interval The (first) interval value in seconds
+ *
+ * This interval value is @b decreased while the user holds the
+ * mouse pointer either incrementing or decrementing a given the
+ * clock digit's value.
+ *
+ * This helps the user to get to a given time distant from the
+ * current one easier/faster, as it will start to flip quicker and
+ * quicker on mouse button holds.
+ *
+ * The calculation for the next flip interval value, starting from
+ * the one set with this call, is the previous interval divided by
+ * 1.05, so it decreases a little bit.
+ *
+ * The default starting interval value for automatic flips is
+ * @b 0.85 seconds.
+ *
+ * @see elm_clock_interval_get()
+ *
+ * @ingroup Clock
+ */
+ EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the interval on time updates for an user mouse button hold
+ * on clock widgets' time edition.
+ *
+ * @param obj The clock object
+ * @return The (first) interval value, in seconds, set on it
+ *
+ * @see elm_clock_interval_set() for more details
+ *
+ * @ingroup Clock
+ */
+ EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * @}
+ */
+
+ /**
+ * @defgroup Layout Layout
+ *
+ * @image html img/widget/layout/preview-00.png
+ * @image latex img/widget/layout/preview-00.eps width=\textwidth
+ *
+ * @image html img/layout-predefined.png
+ * @image latex img/layout-predefined.eps width=\textwidth
+ *
+ * This is a container widget that takes a standard Edje design file and
+ * wraps it very thinly in a widget.
+ *
+ * An Edje design (theme) file has a very wide range of possibilities to
+ * describe the behavior of elements added to the Layout. Check out the Edje
+ * documentation and the EDC reference to get more information about what can
+ * be done with Edje.
+ *
+ * Just like @ref List, @ref Box, and other container widgets, any
+ * object added to the Layout will become its child, meaning that it will be
+ * deleted if the Layout is deleted, move if the Layout is moved, and so on.
+ *
+ * The Layout widget can contain as many Contents, Boxes or Tables as
+ * described in its theme file. For instance, objects can be added to
+ * different Tables by specifying the respective Table part names. The same
+ * is valid for Content and Box.
+ *
+ * The objects added as child of the Layout will behave as described in the
+ * part description where they were added. There are 3 possible types of
+ * parts where a child can be added:
+ *
+ * @section secContent Content (SWALLOW part)
+ *
+ * Only one object can be added to the @c SWALLOW part (but you still can
+ * have many @c SWALLOW parts and one object on each of them). Use the @c
+ * elm_layout_content_* set of functions to set, retrieve and unset objects
+ * as content of the @c SWALLOW. After being set to this part, the object
+ * size, position, visibility, clipping and other description properties
+ * will be totally controled by the description of the given part (inside
+ * the Edje theme file).
+ *
+ * One can use @c evas_object_size_hint_* functions on the child to have some
+ * kind of control over its behavior, but the resulting behavior will still
+ * depend heavily on the @c SWALLOW part description.
+ *
+ * The Edje theme also can change the part description, based on signals or
+ * scripts running inside the theme. This change can also be animated. All of
+ * this will affect the child object set as content accordingly. The object
+ * size will be changed if the part size is changed, it will animate move if
+ * the part is moving, and so on.
+ *
+ * The following picture demonstrates a Layout widget with a child object
+ * added to its @c SWALLOW:
+ *
+ * @image html layout_swallow.png
+ * @image latex layout_swallow.eps width=\textwidth
+ *
+ * @section secBox Box (BOX part)
+ *
+ * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
+ * allows one to add objects to the box and have them distributed along its
+ * area, accordingly to the specified @a layout property (now by @a layout we
+ * mean the chosen layouting design of the Box, not the Layout widget
+ * itself).
+ *
+ * A similar effect for having a box with its position, size and other things
+ * controled by the Layout theme would be to create an Elementary @ref Box
+ * widget and add it as a Content in the @c SWALLOW part.
+ *
+ * The main difference of using the Layout Box is that its behavior, the box
+ * properties like layouting format, padding, align, etc. will be all
+ * controled by the theme. This means, for example, that a signal could be
+ * sent to the Layout theme (with elm_object_signal_emit()) and the theme
+ * handled the signal by changing the box padding, or align, or both. Using
+ * the Elementary @ref Box widget is not necessarily harder or easier, it
+ * just depends on the circunstances and requirements.
+ *
+ * The Layout Box can be used through the @c elm_layout_box_* set of
+ * functions.
+ *
+ * The following picture demonstrates a Layout widget with many child objects
+ * added to its @c BOX part:
+ *
+ * @image html layout_box.png
+ * @image latex layout_box.eps width=\textwidth
+ *
+ * @section secTable Table (TABLE part)
+ *
+ * Just like the @ref secBox, the Layout Table is very similar to the
+ * Elementary @ref Table widget. It allows one to add objects to the Table
+ * specifying the row and column where the object should be added, and any
+ * column or row span if necessary.
+ *
+ * Again, we could have this design by adding a @ref Table widget to the @c
+ * SWALLOW part using elm_layout_content_set(). The same difference happens
+ * here when choosing to use the Layout Table (a @c TABLE part) instead of
+ * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
+ *
+ * The Layout Table can be used through the @c elm_layout_table_* set of
+ * functions.
+ *
+ * The following picture demonstrates a Layout widget with many child objects
+ * added to its @c TABLE part:
+ *
+ * @image html layout_table.png
+ * @image latex layout_table.eps width=\textwidth
+ *
+ * @section secPredef Predefined Layouts
+ *
+ * Another interesting thing about the Layout widget is that it offers some
+ * predefined themes that come with the default Elementary theme. These
+ * themes can be set by the call elm_layout_theme_set(), and provide some
+ * basic functionality depending on the theme used.
+ *
+ * Most of them already send some signals, some already provide a toolbar or
+ * back and next buttons.
+ *
+ * These are available predefined theme layouts. All of them have class = @c
+ * layout, group = @c application, and style = one of the following options:
+ *
+ * @li @c toolbar-content - application with toolbar and main content area
+ * @li @c toolbar-content-back - application with toolbar and main content
+ * area with a back button and title area
+ * @li @c toolbar-content-back-next - application with toolbar and main
+ * content area with a back and next buttons and title area
+ * @li @c content-back - application with a main content area with a back
+ * button and title area
+ * @li @c content-back-next - application with a main content area with a
+ * back and next buttons and title area
+ * @li @c toolbar-vbox - application with toolbar and main content area as a
+ * vertical box
+ * @li @c toolbar-table - application with toolbar and main content area as a
+ * table
+ *
+ * @section secExamples Examples
+ *
+ * Some examples of the Layout widget can be found here:
+ * @li @ref layout_example_01
+ * @li @ref layout_example_02
+ * @li @ref layout_example_03
+ * @li @ref layout_example_edc
+ *
+ */
+
+ /**
+ * Add a new layout to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * @see elm_layout_file_set()
+ * @see elm_layout_theme_set()
+ *
+ * @ingroup Layout
+ */
+ EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * Set the file that will be used as layout
+ *
+ * @param obj The layout object
+ * @param file The path to file (edj) that will be used as layout
+ * @param group The group that the layout belongs in edje file
+ *
+ * @return (1 = success, 0 = error)
+ *
+ * @ingroup Layout
+ */
+ EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
+ /**
+ * Set the edje group from the elementary theme that will be used as layout
+ *
+ * @param obj The layout object
+ * @param clas the clas of the group
+ * @param group the group
+ * @param style the style to used
+ *
+ * @return (1 = success, 0 = error)
+ *
+ * @ingroup Layout
+ */
+ EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
+ /**
+ * Set the layout content.
+ *
+ * @param obj The layout object
+ * @param swallow The swallow part name in the edje file
+ * @param content The child that will be added in this layout object
+ *
+ * Once the content object is set, a previously set one will be deleted.
+ * If you want to keep that old content object, use the
+ * elm_layout_content_unset() function.
+ *
+ * @note In an Edje theme, the part used as a content container is called @c
+ * SWALLOW. This is why the parameter name is called @p swallow, but it is
+ * expected to be a part name just like the second parameter of
+ * elm_layout_box_append().
+ *
+ * @see elm_layout_box_append()
+ * @see elm_layout_content_get()
+ * @see elm_layout_content_unset()
+ * @see @ref secBox
+ *
+ * @ingroup Layout
+ */
+ EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
+ /**
+ * Get the child object in the given content part.
+ *
+ * @param obj The layout object
+ * @param swallow The SWALLOW part to get its content
+ *
+ * @return The swallowed object or NULL if none or an error occurred
+ *
+ * @see elm_layout_content_set()
+ *
+ * @ingroup Layout
+ */
+ EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+ /**
+ * Unset the layout content.
+ *
+ * @param obj The layout object
+ * @param swallow The swallow part name in the edje file
+ * @return The content that was being used
+ *
+ * Unparent and return the content object which was set for this part.
+ *
+ * @see elm_layout_content_set()
+ *
+ * @ingroup Layout
+ */
+ EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+ /**
+ * Set the text of the given part
+ *
+ * @param obj The layout object
+ * @param part The TEXT part where to set the text
+ * @param text The text to set
+ *
+ * @ingroup Layout
+ * @deprecated use elm_object_text_* instead.
+ */
+ EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
+ /**
+ * Get the text set in the given part
+ *
+ * @param obj The layout object
+ * @param part The TEXT part to retrieve the text off
+ *
+ * @return The text set in @p part
+ *
+ * @ingroup Layout
+ * @deprecated use elm_object_text_* instead.
+ */
+ EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
+ /**
+ * Append child to layout box part.
+ *
+ * @param obj the layout object
+ * @param part the box part to which the object will be appended.
+ * @param child the child object to append to box.
+ *
+ * Once the object is appended, it will become child of the layout. Its
+ * lifetime will be bound to the layout, whenever the layout dies the child
+ * will be deleted automatically. One should use elm_layout_box_remove() to
+ * make this layout forget about the object.
+ *
+ * @see elm_layout_box_prepend()
+ * @see elm_layout_box_insert_before()
+ * @see elm_layout_box_insert_at()
+ * @see elm_layout_box_remove()
+ *
+ * @ingroup Layout
+ */
+ EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
+ /**
+ * Prepend child to layout box part.
+ *
+ * @param obj the layout object
+ * @param part the box part to prepend.
+ * @param child the child object to prepend to box.
+ *
+ * Once the object is prepended, it will become child of the layout. Its
+ * lifetime will be bound to the layout, whenever the layout dies the child
+ * will be deleted automatically. One should use elm_layout_box_remove() to
+ * make this layout forget about the object.
+ *
+ * @see elm_layout_box_append()
+ * @see elm_layout_box_insert_before()
+ * @see elm_layout_box_insert_at()
+ * @see elm_layout_box_remove()
+ *
+ * @ingroup Layout
+ */
+ EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
+ /**
+ * Insert child to layout box part before a reference object.
+ *
+ * @param obj the layout object
+ * @param part the box part to insert.
+ * @param child the child object to insert into box.
+ * @param reference another reference object to insert before in box.
+ *
+ * Once the object is inserted, it will become child of the layout. Its
+ * lifetime will be bound to the layout, whenever the layout dies the child
+ * will be deleted automatically. One should use elm_layout_box_remove() to
+ * make this layout forget about the object.
+ *
+ * @see elm_layout_box_append()
+ * @see elm_layout_box_prepend()
+ * @see elm_layout_box_insert_before()
+ * @see elm_layout_box_remove()
+ *
+ * @ingroup Layout
+ */
+ EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
+ /**
+ * Insert child to layout box part at a given position.
+ *
+ * @param obj the layout object
+ * @param part the box part to insert.
+ * @param child the child object to insert into box.
+ * @param pos the numeric position >=0 to insert the child.
+ *
+ * Once the object is inserted, it will become child of the layout. Its
+ * lifetime will be bound to the layout, whenever the layout dies the child
+ * will be deleted automatically. One should use elm_layout_box_remove() to
+ * make this layout forget about the object.
+ *
+ * @see elm_layout_box_append()
+ * @see elm_layout_box_prepend()
+ * @see elm_layout_box_insert_before()
+ * @see elm_layout_box_remove()
+ *
+ * @ingroup Layout
+ */
+ EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
+ /**
+ * Remove a child of the given part box.
+ *
+ * @param obj The layout object
+ * @param part The box part name to remove child.
+ * @param child The object to remove from box.
+ * @return The object that was being used, or NULL if not found.
+ *
+ * The object will be removed from the box part and its lifetime will
+ * not be handled by the layout anymore. This is equivalent to
+ * elm_layout_content_unset() for box.
+ *
+ * @see elm_layout_box_append()
+ * @see elm_layout_box_remove_all()
+ *
+ * @ingroup Layout
+ */
+ EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
+ /**
+ * Remove all child of the given part box.
+ *
+ * @param obj The layout object
+ * @param part The box part name to remove child.
+ * @param clear If EINA_TRUE, then all objects will be deleted as
+ * well, otherwise they will just be removed and will be
+ * dangling on the canvas.
+ *
+ * The objects will be removed from the box part and their lifetime will
+ * not be handled by the layout anymore. This is equivalent to
+ * elm_layout_box_remove() for all box children.
+ *
+ * @see elm_layout_box_append()
+ * @see elm_layout_box_remove()
+ *
+ * @ingroup Layout
+ */
+ EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
+ /**
+ * Insert child to layout table part.
+ *
+ * @param obj the layout object
+ * @param part the box part to pack child.
+ * @param child_obj the child object to pack into table.
+ * @param col the column to which the child should be added. (>= 0)
+ * @param row the row to which the child should be added. (>= 0)
+ * @param colspan how many columns should be used to store this object. (>=
+ * 1)
+ * @param rowspan how many rows should be used to store this object. (>= 1)
+ *
+ * Once the object is inserted, it will become child of the table. Its
+ * lifetime will be bound to the layout, and whenever the layout dies the
+ * child will be deleted automatically. One should use
+ * elm_layout_table_remove() to make this layout forget about the object.
+ *
+ * If @p colspan or @p rowspan are bigger than 1, that object will occupy
+ * more space than a single cell. For instance, the following code:
+ * @code
+ * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
+ * @endcode
+ *
+ * Would result in an object being added like the following picture:
+ *
+ * @image html layout_colspan.png
+ * @image latex layout_colspan.eps width=\textwidth
+ *
+ * @see elm_layout_table_unpack()
+ * @see elm_layout_table_clear()
+ *
+ * @ingroup Layout
+ */
+ 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);
+ /**
+ * Unpack (remove) a child of the given part table.
+ *
+ * @param obj The layout object
+ * @param part The table part name to remove child.
+ * @param child_obj The object to remove from table.
+ * @return The object that was being used, or NULL if not found.
+ *
+ * The object will be unpacked from the table part and its lifetime
+ * will not be handled by the layout anymore. This is equivalent to
+ * elm_layout_content_unset() for table.
+ *
+ * @see elm_layout_table_pack()
+ * @see elm_layout_table_clear()
+ *
+ * @ingroup Layout
+ */
+ EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
+ /**
+ * Remove all child of the given part table.
+ *
+ * @param obj The layout object
+ * @param part The table part name to remove child.
+ * @param clear If EINA_TRUE, then all objects will be deleted as
+ * well, otherwise they will just be removed and will be
+ * dangling on the canvas.
+ *
+ * The objects will be removed from the table part and their lifetime will
+ * not be handled by the layout anymore. This is equivalent to
+ * elm_layout_table_unpack() for all table children.
+ *
+ * @see elm_layout_table_pack()
+ * @see elm_layout_table_unpack()
+ *
+ * @ingroup Layout
+ */
+ EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
+ /**
+ * Get the edje layout
+ *
+ * @param obj The layout object
+ *
+ * @return A Evas_Object with the edje layout settings loaded
+ * with function elm_layout_file_set
+ *
+ * This returns the edje object. It is not expected to be used to then
+ * swallow objects via edje_object_part_swallow() for example. Use
+ * elm_layout_content_set() instead so child object handling and sizing is
+ * done properly.
+ *
+ * @note This function should only be used if you really need to call some
+ * low level Edje function on this edje object. All the common stuff (setting
+ * text, emitting signals, hooking callbacks to signals, etc.) can be done
+ * with proper elementary functions.
+ *
+ * @see elm_object_signal_callback_add()
+ * @see elm_object_signal_emit()
+ * @see elm_object_text_part_set()
+ * @see elm_layout_content_set()
+ * @see elm_layout_box_append()
+ * @see elm_layout_table_pack()
+ * @see elm_layout_data_get()
+ *
+ * @ingroup Layout
+ */
+ EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Get the edje data from the given layout
+ *
+ * @param obj The layout object
+ * @param key The data key
+ *
+ * @return The edje data string
+ *
+ * This function fetches data specified inside the edje theme of this layout.
+ * This function return NULL if data is not found.
+ *
+ * In EDC this comes from a data block within the group block that @p
+ * obj was loaded from. E.g.
+ *
+ * @code
+ * collections {
+ * group {
+ * name: "a_group";
+ * data {
+ * item: "key1" "value1";
+ * item: "key2" "value2";
+ * }
+ * }
+ * }
+ * @endcode
+ *
+ * @ingroup Layout
+ */
+ EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
+ /**
+ * Eval sizing
+ *
+ * @param obj The layout object
+ *
+ * Manually forces a sizing re-evaluation. This is useful when the minimum
+ * size required by the edje theme of this layout has changed. The change on
+ * the minimum size required by the edje theme is not immediately reported to
+ * the elementary layout, so one needs to call this function in order to tell
+ * the widget (layout) that it needs to reevaluate its own size.
+ *
+ * The minimum size of the theme is calculated based on minimum size of
+ * parts, the size of elements inside containers like box and table, etc. All
+ * of this can change due to state changes, and that's when this function
+ * should be called.
+ *
+ * Also note that a standard signal of "size,eval" "elm" emitted from the
+ * edje object will cause this to happen too.
+ *
+ * @ingroup Layout
+ */
+ EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Sets a specific cursor for an edje part.
+ *
+ * @param obj The layout object.
+ * @param part_name a part from loaded edje group.
+ * @param cursor cursor name to use, see Elementary_Cursor.h
+ *
+ * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
+ * part not exists or it has "mouse_events: 0".
+ *
+ * @ingroup Layout
+ */
+ EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
+
+ /**
+ * Get the cursor to be shown when mouse is over an edje part
+ *
+ * @param obj The layout object.
+ * @param part_name a part from loaded edje group.
+ * @return the cursor name.
+ *
+ * @ingroup Layout
+ */
+ EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
+
+ /**
+ * Unsets a cursor previously set with elm_layout_part_cursor_set().
+ *
+ * @param obj The layout object.
+ * @param part_name a part from loaded edje group, that had a cursor set
+ * with elm_layout_part_cursor_set().
+ *
+ * @ingroup Layout
+ */
+ EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
+
+ /**
+ * Sets a specific cursor style for an edje part.
+ *
+ * @param obj The layout object.
+ * @param part_name a part from loaded edje group.
+ * @param style the theme style to use (default, transparent, ...)
+ *
+ * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
+ * part not exists or it did not had a cursor set.
+ *
+ * @ingroup Layout
+ */
+ EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
+
+ /**
+ * Gets a specific cursor style for an edje part.
+ *
+ * @param obj The layout object.
+ * @param part_name a part from loaded edje group.
+ *
+ * @return the theme style in use, defaults to "default". If the
+ * object does not have a cursor set, then NULL is returned.
+ *
+ * @ingroup Layout
+ */
+ EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
+
+ /**
+ * Sets if the cursor set should be searched on the theme or should use
+ * the provided by the engine, only.
+ *
+ * @note before you set if should look on theme you should define a
+ * cursor with elm_layout_part_cursor_set(). By default it will only
+ * look for cursors provided by the engine.
+ *
+ * @param obj The layout object.
+ * @param part_name a part from loaded edje group.
+ * @param engine_only if cursors should be just provided by the engine
+ * or should also search on widget's theme as well
+ *
+ * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
+ * part not exists or it did not had a cursor set.
+ *
+ * @ingroup Layout
+ */
+ 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);
+
+ /**
+ * Gets a specific cursor engine_only for an edje part.
+ *
+ * @param obj The layout object.
+ * @param part_name a part from loaded edje group.
+ *
+ * @return whenever the cursor is just provided by engine or also from theme.
+ *
+ * @ingroup Layout
+ */
+ EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
+
+/**
+ * @def elm_layout_icon_set
+ * Convienience macro to set the icon object in a layout that follows the
+ * Elementary naming convention for its parts.
+ *
+ * @ingroup Layout
+ */
+#define elm_layout_icon_set(_ly, _obj) \
+ do { \
+ const char *sig; \
+ elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
+ if ((_obj)) sig = "elm,state,icon,visible"; \
+ else sig = "elm,state,icon,hidden"; \
+ elm_object_signal_emit((_ly), sig, "elm"); \
+ } while (0)
+
+/**
+ * @def elm_layout_icon_get
+ * Convienience macro to get the icon object from a layout that follows the
+ * Elementary naming convention for its parts.
+ *
+ * @ingroup Layout
+ */
+#define elm_layout_icon_get(_ly) \
+ elm_layout_content_get((_ly), "elm.swallow.icon")
+
+/**
+ * @def elm_layout_end_set
+ * Convienience macro to set the end object in a layout that follows the
+ * Elementary naming convention for its parts.
+ *
+ * @ingroup Layout
+ */
+#define elm_layout_end_set(_ly, _obj) \
+ do { \
+ const char *sig; \
+ elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
+ if ((_obj)) sig = "elm,state,end,visible"; \
+ else sig = "elm,state,end,hidden"; \
+ elm_object_signal_emit((_ly), sig, "elm"); \
+ } while (0)
+
+/**
+ * @def elm_layout_end_get
+ * Convienience macro to get the end object in a layout that follows the
+ * Elementary naming convention for its parts.
+ *
+ * @ingroup Layout
+ */
+#define elm_layout_end_get(_ly) \
+ elm_layout_content_get((_ly), "elm.swallow.end")
+
+/**
+ * @def elm_layout_label_set
+ * Convienience macro to set the label in a layout that follows the
+ * Elementary naming convention for its parts.
+ *
+ * @ingroup Layout
+ * @deprecated use elm_object_text_* instead.
+ */
+#define elm_layout_label_set(_ly, _txt) \
+ elm_layout_text_set((_ly), "elm.text", (_txt))
+
+/**
+ * @def elm_layout_label_get
+ * Convienience macro to get the label in a layout that follows the
+ * Elementary naming convention for its parts.
+ *
+ * @ingroup Layout
+ * @deprecated use elm_object_text_* instead.
+ */
+#define elm_layout_label_get(_ly) \
+ elm_layout_text_get((_ly), "elm.text")
+
+ /* smart callbacks called:
+ * "theme,changed" - when elm theme is changed.
+ */
+
+ /**
+ * @defgroup Notify Notify
+ *
+ * @image html img/widget/notify/preview-00.png
+ * @image latex img/widget/notify/preview-00.eps
+ *
+ * Display a container in a particular region of the parent(top, bottom,
+ * etc. A timeout can be set to automatically hide the notify. This is so
+ * that, after an evas_object_show() on a notify object, if a timeout was set
+ * on it, it will @b automatically get hidden after that time.
+ *
+ * Signals that you can add callbacks for are:
+ * @li "timeout" - when timeout happens on notify and it's hidden
+ * @li "block,clicked" - when a click outside of the notify happens
+ *
+ * @ref tutorial_notify show usage of the API.
+ *
+ * @{
+ */
+ /**
+ * @brief Possible orient values for notify.
+ *
+ * This values should be used in conjunction to elm_notify_orient_set() to
+ * set the position in which the notify should appear(relative to its parent)
+ * and in conjunction with elm_notify_orient_get() to know where the notify
+ * is appearing.
+ */
+ typedef enum _Elm_Notify_Orient
+ {
+ ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
+ ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
+ ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
+ ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
+ ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
+ ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
+ ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
+ ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
+ ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
+ ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
+ } Elm_Notify_Orient;
+ /**
+ * @brief Add a new notify to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ */
+ EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the content of the notify widget
+ *
+ * @param obj The notify object
+ * @param content The content will be filled in this notify object
+ *
+ * Once the content object is set, a previously set one will be deleted. If
+ * you want to keep that old content object, use the
+ * elm_notify_content_unset() function.
+ */
+ EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Unset the content of the notify widget
+ *
+ * @param obj The notify object
+ * @return The content that was being used
+ *
+ * Unparent and return the content object which was set for this widget
+ *
+ * @see elm_notify_content_set()
+ */
+ EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Return the content of the notify widget
+ *
+ * @param obj The notify object
+ * @return The content that is being used
+ *
+ * @see elm_notify_content_set()
+ */
+ EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the notify parent
+ *
+ * @param obj The notify object
+ * @param content The new parent
+ *
+ * Once the parent object is set, a previously set one will be disconnected
+ * and replaced.
+ */
+ EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the notify parent
+ *
+ * @param obj The notify object
+ * @return The parent
+ *
+ * @see elm_notify_parent_set()
+ */
+ EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the orientation
+ *
+ * @param obj The notify object
+ * @param orient The new orientation
+ *
+ * Sets the position in which the notify will appear in its parent.
+ *
+ * @see @ref Elm_Notify_Orient for possible values.
+ */
+ EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Return the orientation
+ * @param obj The notify object
+ * @return The orientation of the notification
+ *
+ * @see elm_notify_orient_set()
+ * @see Elm_Notify_Orient
+ */
+ EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the time interval after which the notify window is going to be
+ * hidden.
+ *
+ * @param obj The notify object
+ * @param time The timeout in seconds
+ *
+ * This function sets a timeout and starts the timer controlling when the
+ * notify is hidden. Since calling evas_object_show() on a notify restarts
+ * the timer controlling when the notify is hidden, setting this before the
+ * notify is shown will in effect mean starting the timer when the notify is
+ * shown.
+ *
+ * @note Set a value <= 0.0 to disable a running timer.
+ *
+ * @note If the value > 0.0 and the notify is previously visible, the
+ * timer will be started with this value, canceling any running timer.
+ */
+ EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Return the timeout value (in seconds)
+ * @param obj the notify object
+ *
+ * @see elm_notify_timeout_set()
+ */
+ EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Sets whether events should be passed to by a click outside
+ * its area.
+ *
+ * @param obj The notify object
+ * @param repeats EINA_TRUE Events are repeats, else no
+ *
+ * When true if the user clicks outside the window the events will be caught
+ * by the others widgets, else the events are blocked.
+ *
+ * @note The default value is EINA_TRUE.
+ */
+ EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Return true if events are repeat below the notify object
+ * @param obj the notify object
+ *
+ * @see elm_notify_repeat_events_set()
+ */
+ EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @}
+ */
+
+ /**
+ * @defgroup Hover Hover
+ *
+ * @image html img/widget/hover/preview-00.png
+ * @image latex img/widget/hover/preview-00.eps
+ *
+ * A Hover object will hover over its @p parent object at the @p target
+ * location. Anything in the background will be given a darker coloring to
+ * indicate that the hover object is on top (at the default theme). When the
+ * hover is clicked it is dismissed(hidden), if the contents of the hover are
+ * clicked that @b doesn't cause the hover to be dismissed.
+ *
+ * @note The hover object will take up the entire space of @p target
+ * object.
+ *
+ * Elementary has the following styles for the hover widget:
+ * @li default
+ * @li popout
+ * @li menu
+ * @li hoversel_vertical
+ *
+ * The following are the available position for content:
+ * @li left
+ * @li top-left
+ * @li top
+ * @li top-right
+ * @li right
+ * @li bottom-right
+ * @li bottom
+ * @li bottom-left
+ * @li middle
+ * @li smart
+ *
+ * Signals that you can add callbacks for are:
+ * @li "clicked" - the user clicked the empty space in the hover to dismiss
+ * @li "smart,changed" - a content object placed under the "smart"
+ * policy was replaced to a new slot direction.
+ *
+ * See @ref tutorial_hover for more information.
+ *
+ * @{
+ */
+ typedef enum _Elm_Hover_Axis
+ {
+ ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
+ ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
+ ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
+ ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
+ } Elm_Hover_Axis;
+ /**
+ * @brief Adds a hover object to @p parent
+ *
+ * @param parent The parent object
+ * @return The hover object or NULL if one could not be created
+ */
+ EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Sets the target object for the hover.
+ *
+ * @param obj The hover object
+ * @param target The object to center the hover onto. The hover
+ *
+ * This function will cause the hover to be centered on the target object.
+ */
+ EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Gets the target object for the hover.
+ *
+ * @param obj The hover object
+ * @param parent The object to locate the hover over.
+ *
+ * @see elm_hover_target_set()
+ */
+ EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Sets the parent object for the hover.
+ *
+ * @param obj The hover object
+ * @param parent The object to locate the hover over.
+ *
+ * This function will cause the hover to take up the entire space that the
+ * parent object fills.
+ */
+ EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Gets the parent object for the hover.
+ *
+ * @param obj The hover object
+ * @return The parent object to locate the hover over.
+ *
+ * @see elm_hover_parent_set()
+ */
+ EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Sets the content of the hover object and the direction in which it
+ * will pop out.
+ *
+ * @param obj The hover object
+ * @param swallow The direction that the object will be displayed
+ * at. Accepted values are "left", "top-left", "top", "top-right",
+ * "right", "bottom-right", "bottom", "bottom-left", "middle" and
+ * "smart".
+ * @param content The content to place at @p swallow
+ *
+ * Once the content object is set for a given direction, a previously
+ * set one (on the same direction) will be deleted. If you want to
+ * keep that old content object, use the elm_hover_content_unset()
+ * function.
+ *
+ * All directions may have contents at the same time, except for
+ * "smart". This is a special placement hint and its use case
+ * independs of the calculations coming from
+ * elm_hover_best_content_location_get(). Its use is for cases when
+ * one desires only one hover content, but with a dinamic special
+ * placement within the hover area. The content's geometry, whenever
+ * it changes, will be used to decide on a best location not
+ * extrapolating the hover's parent object view to show it in (still
+ * being the hover's target determinant of its medium part -- move and
+ * resize it to simulate finger sizes, for example). If one of the
+ * directions other than "smart" are used, a previously content set
+ * using it will be deleted, and vice-versa.
+ */
+ EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the content of the hover object, in a given direction.
+ *
+ * Return the content object which was set for this widget in the
+ * @p swallow direction.
+ *
+ * @param obj The hover object
+ * @param swallow The direction that the object was display at.
+ * @return The content that was being used
+ *
+ * @see elm_hover_content_set()
+ */
+ EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Unset the content of the hover object, in a given direction.
+ *
+ * Unparent and return the content object set at @p swallow direction.
+ *
+ * @param obj The hover object
+ * @param swallow The direction that the object was display at.
+ * @return The content that was being used.
+ *
+ * @see elm_hover_content_set()
+ */
+ EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Returns the best swallow location for content in the hover.
+ *
+ * @param obj The hover object
+ * @param pref_axis The preferred orientation axis for the hover object to use
+ * @return The edje location to place content into the hover or @c
+ * NULL, on errors.
+ *
+ * Best is defined here as the location at which there is the most available
+ * space.
+ *
+ * @p pref_axis may be one of
+ * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
+ * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
+ * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
+ * - @c ELM_HOVER_AXIS_BOTH -- both
+ *
+ * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
+ * nescessarily be along the horizontal axis("left" or "right"). If
+ * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
+ * be along the vertical axis("top" or "bottom"). Chossing
+ * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
+ * returned position may be in either axis.
+ *
+ * @see elm_hover_content_set()
+ */
+ EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
+ /**
+ * @}
+ */
+
+ /* entry */
+ /**
+ * @defgroup Entry Entry
+ *
+ * @image html img/widget/entry/preview-00.png
+ * @image latex img/widget/entry/preview-00.eps width=\textwidth
+ * @image html img/widget/entry/preview-01.png
+ * @image latex img/widget/entry/preview-01.eps width=\textwidth
+ * @image html img/widget/entry/preview-02.png
+ * @image latex img/widget/entry/preview-02.eps width=\textwidth
+ * @image html img/widget/entry/preview-03.png
+ * @image latex img/widget/entry/preview-03.eps width=\textwidth
+ *
+ * An entry is a convenience widget which shows a box that the user can
+ * enter text into. Entries by default don't scroll, so they grow to
+ * accomodate the entire text, resizing the parent window as needed. This
+ * can be changed with the elm_entry_scrollable_set() function.
+ *
+ * They can also be single line or multi line (the default) and when set
+ * to multi line mode they support text wrapping in any of the modes
+ * indicated by #Elm_Wrap_Type.
+ *
+ * Other features include password mode, filtering of inserted text with
+ * elm_entry_text_filter_append() and related functions, inline "items" and
+ * formatted markup text.
+ *
+ * @section entry-markup Formatted text
+ *
+ * The markup tags supported by the Entry are defined by the theme, but
+ * even when writing new themes or extensions it's a good idea to stick to
+ * a sane default, to maintain coherency and avoid application breakages.
+ * Currently defined by the default theme are the following tags:
+ * @li \<br\>: Inserts a line break.
+ * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
+ * breaks.
+ * @li \<tab\>: Inserts a tab.
+ * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
+ * enclosed text.
+ * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
+ * @li \<link\>...\</link\>: Underlines the enclosed text.
+ * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
+ *
+ * @section entry-special Special markups
+ *
+ * Besides those used to format text, entries support two special markup
+ * tags used to insert clickable portions of text or items inlined within
+ * the text.
+ *
+ * @subsection entry-anchors Anchors
+ *
+ * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
+ * \</a\> tags and an event will be generated when this text is clicked,
+ * like this:
+ *
+ * @code
+ * This text is outside <a href=anc-01>but this one is an anchor</a>
+ * @endcode
+ *
+ * The @c href attribute in the opening tag gives the name that will be
+ * used to identify the anchor and it can be any valid utf8 string.
+ *
+ * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
+ * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
+ * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
+ * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
+ * an anchor.
+ *
+ * @subsection entry-items Items
+ *
+ * Inlined in the text, any other @c Evas_Object can be inserted by using
+ * \<item\> tags this way:
+ *
+ * @code
+ * <item size=16x16 vsize=full href=emoticon/haha></item>
+ * @endcode
+ *
+ * Just like with anchors, the @c href identifies each item, but these need,
+ * in addition, to indicate their size, which is done using any one of
+ * @c size, @c absize or @c relsize attributes. These attributes take their
+ * value in the WxH format, where W is the width and H the height of the
+ * item.
+ *
+ * @li absize: Absolute pixel size for the item. Whatever value is set will
+ * be the item's size regardless of any scale value the object may have
+ * been set to. The final line height will be adjusted to fit larger items.
+ * @li size: Similar to @c absize, but it's adjusted to the scale value set
+ * for the object.
+ * @li relsize: Size is adjusted for the item to fit within the current
+ * line height.
+ *
+ * Besides their size, items are specificed a @c vsize value that affects
+ * how their final size and position are calculated. The possible values
+ * are:
+ * @li ascent: Item will be placed within the line's baseline and its
+ * ascent. That is, the height between the line where all characters are
+ * positioned and the highest point in the line. For @c size and @c absize
+ * items, the descent value will be added to the total line height to make
+ * them fit. @c relsize items will be adjusted to fit within this space.
+ * @li full: Items will be placed between the descent and ascent, or the
+ * lowest point in the line and its highest.
+ *
+ * The next image shows different configurations of items and how they
+ * are the previously mentioned options affect their sizes. In all cases,
+ * the green line indicates the ascent, blue for the baseline and red for
+ * the descent.
+ *
+ * @image html entry_item.png
+ * @image latex entry_item.eps width=\textwidth
+ *
+ * And another one to show how size differs from absize. In the first one,
+ * the scale value is set to 1.0, while the second one is using one of 2.0.
+ *
+ * @image html entry_item_scale.png
+ * @image latex entry_item_scale.eps width=\textwidth
+ *
+ * After the size for an item is calculated, the entry will request an
+ * object to place in its space. For this, the functions set with
+ * elm_entry_item_provider_append() and related functions will be called
+ * in order until one of them returns a @c non-NULL value. If no providers
+ * are available, or all of them return @c NULL, then the entry falls back
+ * to one of the internal defaults, provided the name matches with one of
+ * them.
+ *
+ * All of the following are currently supported:
+ *
+ * - emoticon/angry
+ * - emoticon/angry-shout
+ * - emoticon/crazy-laugh
+ * - emoticon/evil-laugh
+ * - emoticon/evil
+ * - emoticon/goggle-smile
+ * - emoticon/grumpy
+ * - emoticon/grumpy-smile
+ * - emoticon/guilty
+ * - emoticon/guilty-smile
+ * - emoticon/haha
+ * - emoticon/half-smile
+ * - emoticon/happy-panting
+ * - emoticon/happy
+ * - emoticon/indifferent
+ * - emoticon/kiss
+ * - emoticon/knowing-grin
+ * - emoticon/laugh
+ * - emoticon/little-bit-sorry
+ * - emoticon/love-lots
+ * - emoticon/love
+ * - emoticon/minimal-smile
+ * - emoticon/not-happy
+ * - emoticon/not-impressed
+ * - emoticon/omg
+ * - emoticon/opensmile
+ * - emoticon/smile
+ * - emoticon/sorry
+ * - emoticon/squint-laugh
+ * - emoticon/surprised
+ * - emoticon/suspicious
+ * - emoticon/tongue-dangling
+ * - emoticon/tongue-poke
+ * - emoticon/uh
+ * - emoticon/unhappy
+ * - emoticon/very-sorry
+ * - emoticon/what
+ * - emoticon/wink
+ * - emoticon/worried
+ * - emoticon/wtf
+ *
+ * Alternatively, an item may reference an image by its path, using
+ * the URI form @c file:///path/to/an/image.png and the entry will then
+ * use that image for the item.
+ *
+ * @section entry-files Loading and saving files
+ *
+ * Entries have convinience functions to load text from a file and save
+ * changes back to it after a short delay. The automatic saving is enabled
+ * by default, but can be disabled with elm_entry_autosave_set() and files
+ * can be loaded directly as plain text or have any markup in them
+ * recognized. See elm_entry_file_set() for more details.
+ *
+ * @section entry-signals Emitted signals
+ *
+ * This widget emits the following signals:
+ *
+ * @li "changed": The text within the entry was changed.
+ * @li "changed,user": The text within the entry was changed because of user interaction.
+ * @li "activated": The enter key was pressed on a single line entry.
+ * @li "press": A mouse button has been pressed on the entry.
+ * @li "longpressed": A mouse button has been pressed and held for a couple
+ * seconds.
+ * @li "clicked": The entry has been clicked (mouse press and release).
+ * @li "clicked,double": The entry has been double clicked.
+ * @li "clicked,triple": The entry has been triple clicked.
+ * @li "focused": The entry has received focus.
+ * @li "unfocused": The entry has lost focus.
+ * @li "selection,paste": A paste of the clipboard contents was requested.
+ * @li "selection,copy": A copy of the selected text into the clipboard was
+ * requested.
+ * @li "selection,cut": A cut of the selected text into the clipboard was
+ * requested.
+ * @li "selection,start": A selection has begun and no previous selection
+ * existed.
+ * @li "selection,changed": The current selection has changed.
+ * @li "selection,cleared": The current selection has been cleared.
+ * @li "cursor,changed": The cursor has changed position.
+ * @li "anchor,clicked": An anchor has been clicked. The event_info
+ * parameter for the callback will be an #Elm_Entry_Anchor_Info.
+ * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
+ * parameter for the callback will be an #Elm_Entry_Anchor_Info.
+ * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
+ * parameter for the callback will be an #Elm_Entry_Anchor_Info.
+ * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
+ * parameter for the callback will be an #Elm_Entry_Anchor_Info.
+ * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
+ * parameter for the callback will be an #Elm_Entry_Anchor_Info.
+ * @li "preedit,changed": The preedit string has changed.
+ *
+ * @section entry-examples
+ *
+ * An overview of the Entry API can be seen in @ref entry_example_01
+ *
+ * @{
+ */
+ /**
+ * @typedef Elm_Entry_Anchor_Info
+ *
+ * The info sent in the callback for the "anchor,clicked" signals emitted
+ * by entries.
+ */
+ typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
+ /**
+ * @struct _Elm_Entry_Anchor_Info
+ *
+ * The info sent in the callback for the "anchor,clicked" signals emitted
+ * by entries.
+ */
+ struct _Elm_Entry_Anchor_Info
+ {
+ const char *name; /**< The name of the anchor, as stated in its href */
+ int button; /**< The mouse button used to click on it */
+ Evas_Coord x, /**< Anchor geometry, relative to canvas */
+ y, /**< Anchor geometry, relative to canvas */
+ w, /**< Anchor geometry, relative to canvas */
+ h; /**< Anchor geometry, relative to canvas */
+ };
+ /**
+ * @typedef Elm_Entry_Filter_Cb
+ * This callback type is used by entry filters to modify text.
+ * @param data The data specified as the last param when adding the filter
+ * @param entry The entry object
+ * @param text A pointer to the location of the text being filtered. This data can be modified,
+ * but any additional allocations must be managed by the user.
+ * @see elm_entry_text_filter_append
+ * @see elm_entry_text_filter_prepend
+ */
+ typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
+
+ /**
+ * This adds an entry to @p parent object.
+ *
+ * By default, entries are:
+ * @li not scrolled
+ * @li multi-line
+ * @li word wrapped
+ * @li autosave is enabled
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ */
+ EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * Sets the entry to single line mode.
+ *
+ * In single line mode, entries don't ever wrap when the text reaches the
+ * edge, and instead they keep growing horizontally. Pressing the @c Enter
+ * key will generate an @c "activate" event instead of adding a new line.
+ *
+ * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
+ * and pressing enter will break the text into a different line
+ * without generating any events.
+ *
+ * @param obj The entry object
+ * @param single_line If true, the text in the entry
+ * will be on a single line.
+ */
+ EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
+ /**
+ * Gets whether the entry is set to be single line.
+ *
+ * @param obj The entry object
+ * @return single_line If true, the text in the entry is set to display
+ * on a single line.
+ *
+ * @see elm_entry_single_line_set()
+ */
+ EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Sets the entry to password mode.
+ *
+ * In password mode, entries are implicitly single line and the display of
+ * any text in them is replaced with asterisks (*).
+ *
+ * @param obj The entry object
+ * @param password If true, password mode is enabled.
+ */
+ EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
+ /**
+ * Gets whether the entry is set to password mode.
+ *
+ * @param obj The entry object
+ * @return If true, the entry is set to display all characters
+ * as asterisks (*).
+ *
+ * @see elm_entry_password_set()
+ */
+ EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This sets the text displayed within the entry to @p entry.
+ *
+ * @param obj The entry object
+ * @param entry The text to be displayed
+ *
+ * @deprecated Use elm_object_text_set() instead.
+ */
+ EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
+ /**
+ * This returns the text currently shown in object @p entry.
+ * See also elm_entry_entry_set().
+ *
+ * @param obj The entry object
+ * @return The currently displayed text or NULL on failure
+ *
+ * @deprecated Use elm_object_text_get() instead.
+ */
+ EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Appends @p entry to the text of the entry.
+ *
+ * Adds the text in @p entry to the end of any text already present in the
+ * widget.
+ *
+ * The appended text is subject to any filters set for the widget.
+ *
+ * @param obj The entry object
+ * @param entry The text to be displayed
+ *
+ * @see elm_entry_text_filter_append()
+ */
+ EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
+ /**
+ * Gets whether the entry is empty.
+ *
+ * Empty means no text at all. If there are any markup tags, like an item
+ * tag for which no provider finds anything, and no text is displayed, this
+ * function still returns EINA_FALSE.
+ *
+ * @param obj The entry object
+ * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
+ */
+ EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Gets any selected text within the entry.
+ *
+ * If there's any selected text in the entry, this function returns it as
+ * a string in markup format. NULL is returned if no selection exists or
+ * if an error occurred.
+ *
+ * The returned value points to an internal string and should not be freed
+ * or modified in any way. If the @p entry object is deleted or its
+ * contents are changed, the returned pointer should be considered invalid.
+ *
+ * @param obj The entry object
+ * @return The selected text within the entry or NULL on failure
+ */
+ EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Inserts the given text into the entry at the current cursor position.
+ *
+ * This inserts text at the cursor position as if it was typed
+ * by the user (note that this also allows markup which a user
+ * can't just "type" as it would be converted to escaped text, so this
+ * call can be used to insert things like emoticon items or bold push/pop
+ * tags, other font and color change tags etc.)
+ *
+ * If any selection exists, it will be replaced by the inserted text.
+ *
+ * The inserted text is subject to any filters set for the widget.
+ *
+ * @param obj The entry object
+ * @param entry The text to insert
+ *
+ * @see elm_entry_text_filter_append()
+ */
+ EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
+ /**
+ * Set the line wrap type to use on multi-line entries.
+ *
+ * Sets the wrap type used by the entry to any of the specified in
+ * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
+ * line (without inserting a line break or paragraph separator) when it
+ * reaches the far edge of the widget.
+ *
+ * Note that this only makes sense for multi-line entries. A widget set
+ * to be single line will never wrap.
+ *
+ * @param obj The entry object
+ * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
+ */
+ EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
+ /**
+ * Gets the wrap mode the entry was set to use.
+ *
+ * @param obj The entry object
+ * @return Wrap type
+ *
+ * @see also elm_entry_line_wrap_set()
+ */
+ EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Sets if the entry is to be editable or not.
+ *
+ * By default, entries are editable and when focused, any text input by the
+ * user will be inserted at the current cursor position. But calling this
+ * function with @p editable as EINA_FALSE will prevent the user from
+ * inputting text into the entry.
+ *
+ * The only way to change the text of a non-editable entry is to use
+ * elm_object_text_set(), elm_entry_entry_insert() and other related
+ * functions.
+ *
+ * @param obj The entry object
+ * @param editable If EINA_TRUE, user input will be inserted in the entry,
+ * if not, the entry is read-only and no user input is allowed.
+ */
+ EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
+ /**
+ * Gets whether the entry is editable or not.
+ *
+ * @param obj The entry object
+ * @return If true, the entry is editable by the user.
+ * If false, it is not editable by the user
+ *
+ * @see elm_entry_editable_set()
+ */
+ EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This drops any existing text selection within the entry.
+ *
+ * @param obj The entry object
+ */
+ EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This selects all text within the entry.
+ *
+ * @param obj The entry object
+ */
+ EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This moves the cursor one place to the right within the entry.
+ *
+ * @param obj The entry object
+ * @return EINA_TRUE upon success, EINA_FALSE upon failure
+ */
+ EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This moves the cursor one place to the left within the entry.
+ *
+ * @param obj The entry object
+ * @return EINA_TRUE upon success, EINA_FALSE upon failure
+ */
+ EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This moves the cursor one line up within the entry.
+ *
+ * @param obj The entry object
+ * @return EINA_TRUE upon success, EINA_FALSE upon failure
+ */
+ EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This moves the cursor one line down within the entry.
+ *
+ * @param obj The entry object
+ * @return EINA_TRUE upon success, EINA_FALSE upon failure
+ */
+ EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This moves the cursor to the beginning of the entry.
+ *
+ * @param obj The entry object
+ */
+ EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This moves the cursor to the end of the entry.
+ *
+ * @param obj The entry object
+ */
+ EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This moves the cursor to the beginning of the current line.
+ *
+ * @param obj The entry object
+ */
+ EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This moves the cursor to the end of the current line.
+ *
+ * @param obj The entry object
+ */
+ EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This begins a selection within the entry as though
+ * the user were holding down the mouse button to make a selection.
+ *
+ * @param obj The entry object
+ */
+ EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This ends a selection within the entry as though
+ * the user had just released the mouse button while making a selection.
+ *
+ * @param obj The entry object
+ */
+ EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Gets whether a format node exists at the current cursor position.
+ *
+ * A format node is anything that defines how the text is rendered. It can
+ * be a visible format node, such as a line break or a paragraph separator,
+ * or an invisible one, such as bold begin or end tag.
+ * This function returns whether any format node exists at the current
+ * cursor position.
+ *
+ * @param obj The entry object
+ * @return EINA_TRUE if the current cursor position contains a format node,
+ * EINA_FALSE otherwise.
+ *
+ * @see elm_entry_cursor_is_visible_format_get()
+ */
+ EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Gets if the current cursor position holds a visible format node.
+ *
+ * @param obj The entry object
+ * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
+ * if it's an invisible one or no format exists.
+ *
+ * @see elm_entry_cursor_is_format_get()
+ */
+ EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Gets the character pointed by the cursor at its current position.
+ *
+ * This function returns a string with the utf8 character stored at the
+ * current cursor position.
+ * Only the text is returned, any format that may exist will not be part
+ * of the return value.
+ *
+ * @param obj The entry object
+ * @return The text pointed by the cursors.
+ */
+ EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This function returns the geometry of the cursor.
+ *
+ * It's useful if you want to draw something on the cursor (or where it is),
+ * or for example in the case of scrolled entry where you want to show the
+ * cursor.
+ *
+ * @param obj The entry object
+ * @param x returned geometry
+ * @param y returned geometry
+ * @param w returned geometry
+ * @param h returned geometry
+ * @return EINA_TRUE upon success, EINA_FALSE upon failure
+ */
+ 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);
+ /**
+ * Sets the cursor position in the entry to the given value
+ *
+ * The value in @p pos is the index of the character position within the
+ * contents of the string as returned by elm_entry_cursor_pos_get().
+ *
+ * @param obj The entry object
+ * @param pos The position of the cursor
+ */
+ EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
+ /**
+ * Retrieves the current position of the cursor in the entry
+ *
+ * @param obj The entry object
+ * @return The cursor position
+ */
+ EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This executes a "cut" action on the selected text in the entry.
+ *
+ * @param obj The entry object
+ */
+ EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This executes a "copy" action on the selected text in the entry.
+ *
+ * @param obj The entry object
+ */
+ EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This executes a "paste" action in the entry.
+ *
+ * @param obj The entry object
+ */
+ EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This clears and frees the items in a entry's contextual (longpress)
+ * menu.
+ *
+ * @param obj The entry object
+ *
+ * @see elm_entry_context_menu_item_add()
+ */
+ EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This adds an item to the entry's contextual menu.
+ *
+ * A longpress on an entry will make the contextual menu show up, if this
+ * hasn't been disabled with elm_entry_context_menu_disabled_set().
+ * By default, this menu provides a few options like enabling selection mode,
+ * which is useful on embedded devices that need to be explicit about it,
+ * and when a selection exists it also shows the copy and cut actions.
+ *
+ * With this function, developers can add other options to this menu to
+ * perform any action they deem necessary.
+ *
+ * @param obj The entry object
+ * @param label The item's text label
+ * @param icon_file The item's icon file
+ * @param icon_type The item's icon type
+ * @param func The callback to execute when the item is clicked
+ * @param data The data to associate with the item for related functions
+ */
+ 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);
+ /**
+ * This disables the entry's contextual (longpress) menu.
+ *
+ * @param obj The entry object
+ * @param disabled If true, the menu is disabled
+ */
+ EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+ /**
+ * This returns whether the entry's contextual (longpress) menu is
+ * disabled.
+ *
+ * @param obj The entry object
+ * @return If true, the menu is disabled
+ */
+ EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This appends a custom item provider to the list for that entry
+ *
+ * This appends the given callback. The list is walked from beginning to end
+ * with each function called given the item href string in the text. If the
+ * function returns an object handle other than NULL (it should create an
+ * object to do this), then this object is used to replace that item. If
+ * not the next provider is called until one provides an item object, or the
+ * default provider in entry does.
+ *
+ * @param obj The entry object
+ * @param func The function called to provide the item object
+ * @param data The data passed to @p func
+ *
+ * @see @ref entry-items
+ */
+ 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);
+ /**
+ * This prepends a custom item provider to the list for that entry
+ *
+ * This prepends the given callback. See elm_entry_item_provider_append() for
+ * more information
+ *
+ * @param obj The entry object
+ * @param func The function called to provide the item object
+ * @param data The data passed to @p func
+ */
+ 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);
+ /**
+ * This removes a custom item provider to the list for that entry
+ *
+ * This removes the given callback. See elm_entry_item_provider_append() for
+ * more information
+ *
+ * @param obj The entry object
+ * @param func The function called to provide the item object
+ * @param data The data passed to @p func
+ */
+ 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);
+ /**
+ * Append a filter function for text inserted in the entry
+ *
+ * Append the given callback to the list. This functions will be called
+ * whenever any text is inserted into the entry, with the text to be inserted
+ * as a parameter. The callback function is free to alter the text in any way
+ * it wants, but it must remember to free the given pointer and update it.
+ * If the new text is to be discarded, the function can free it and set its
+ * text parameter to NULL. This will also prevent any following filters from
+ * being called.
+ *
+ * @param obj The entry object
+ * @param func The function to use as text filter
+ * @param data User data to pass to @p func
+ */
+ EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
+ /**
+ * Prepend a filter function for text insdrted in the entry
+ *
+ * Prepend the given callback to the list. See elm_entry_text_filter_append()
+ * for more information
+ *
+ * @param obj The entry object
+ * @param func The function to use as text filter
+ * @param data User data to pass to @p func
+ */
+ EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
+ /**
+ * Remove a filter from the list
+ *
+ * Removes the given callback from the filter list. See
+ * elm_entry_text_filter_append() for more information.
+ *
+ * @param obj The entry object
+ * @param func The filter function to remove
+ * @param data The user data passed when adding the function
+ */
+ EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
+ /**
+ * This converts a markup (HTML-like) string into UTF-8.
+ *
+ * The returned string is a malloc'ed buffer and it should be freed when
+ * not needed anymore.
+ *
+ * @param s The string (in markup) to be converted
+ * @return The converted string (in UTF-8). It should be freed.
+ */
+ EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
+ /**
+ * This converts a UTF-8 string into markup (HTML-like).
+ *
+ * The returned string is a malloc'ed buffer and it should be freed when
+ * not needed anymore.
+ *
+ * @param s The string (in UTF-8) to be converted
+ * @return The converted string (in markup). It should be freed.
+ */
+ EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
+ /**
+ * This sets the file (and implicitly loads it) for the text to display and
+ * then edit. All changes are written back to the file after a short delay if
+ * the entry object is set to autosave (which is the default).
+ *
+ * If the entry had any other file set previously, any changes made to it
+ * will be saved if the autosave feature is enabled, otherwise, the file
+ * will be silently discarded and any non-saved changes will be lost.
+ *
+ * @param obj The entry object
+ * @param file The path to the file to load and save
+ * @param format The file format
+ */
+ EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
+ /**
+ * Gets the file being edited by the entry.
+ *
+ * This function can be used to retrieve any file set on the entry for
+ * edition, along with the format used to load and save it.
+ *
+ * @param obj The entry object
+ * @param file The path to the file to load and save
+ * @param format The file format
+ */
+ EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
+ /**
+ * This function writes any changes made to the file set with
+ * elm_entry_file_set()
+ *
+ * @param obj The entry object
+ */
+ EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This sets the entry object to 'autosave' the loaded text file or not.
+ *
+ * @param obj The entry object
+ * @param autosave Autosave the loaded file or not
+ *
+ * @see elm_entry_file_set()
+ */
+ EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
+ /**
+ * This gets the entry object's 'autosave' status.
+ *
+ * @param obj The entry object
+ * @return Autosave the loaded file or not
+ *
+ * @see elm_entry_file_set()
+ */
+ EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Control pasting of text and images for the widget.
+ *
+ * Normally the entry allows both text and images to be pasted. By setting
+ * textonly to be true, this prevents images from being pasted.
+ *
+ * Note this only changes the behaviour of text.
+ *
+ * @param obj The entry object
+ * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
+ * text+image+other.
+ */
+ EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
+ /**
+ * Getting elm_entry text paste/drop mode.
+ *
+ * In textonly mode, only text may be pasted or dropped into the widget.
+ *
+ * @param obj The entry object
+ * @return If the widget only accepts text from pastes.
+ */
+ EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Enable or disable scrolling in entry
+ *
+ * Normally the entry is not scrollable unless you enable it with this call.
+ *
+ * @param obj The entry object
+ * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
+ */
+ EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
+ /**
+ * Get the scrollable state of the entry
+ *
+ * Normally the entry is not scrollable. This gets the scrollable state
+ * of the entry. See elm_entry_scrollable_set() for more information.
+ *
+ * @param obj The entry object
+ * @return The scrollable state
+ */
+ EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
+ /**
+ * This sets a widget to be displayed to the left of a scrolled entry.
+ *
+ * @param obj The scrolled entry object
+ * @param icon The widget to display on the left side of the scrolled
+ * entry.
+ *
+ * @note A previously set widget will be destroyed.
+ * @note If the object being set does not have minimum size hints set,
+ * it won't get properly displayed.
+ *
+ * @see elm_entry_end_set()
+ */
+ EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
+ /**
+ * Gets the leftmost widget of the scrolled entry. This object is
+ * owned by the scrolled entry and should not be modified.
+ *
+ * @param obj The scrolled entry object
+ * @return the left widget inside the scroller
+ */
+ EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
+ /**
+ * Unset the leftmost widget of the scrolled entry, unparenting and
+ * returning it.
+ *
+ * @param obj The scrolled entry object
+ * @return the previously set icon sub-object of this entry, on
+ * success.
+ *
+ * @see elm_entry_icon_set()
+ */
+ EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
+ /**
+ * Sets the visibility of the left-side widget of the scrolled entry,
+ * set by elm_entry_icon_set().
+ *
+ * @param obj The scrolled entry object
+ * @param setting EINA_TRUE if the object should be displayed,
+ * EINA_FALSE if not.
+ */
+ EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
+ /**
+ * This sets a widget to be displayed to the end of a scrolled entry.
+ *
+ * @param obj The scrolled entry object
+ * @param end The widget to display on the right side of the scrolled
+ * entry.
+ *
+ * @note A previously set widget will be destroyed.
+ * @note If the object being set does not have minimum size hints set,
+ * it won't get properly displayed.
+ *
+ * @see elm_entry_icon_set
+ */
+ EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
+ /**
+ * Gets the endmost widget of the scrolled entry. This object is owned
+ * by the scrolled entry and should not be modified.
+ *
+ * @param obj The scrolled entry object
+ * @return the right widget inside the scroller
+ */
+ EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
+ /**
+ * Unset the endmost widget of the scrolled entry, unparenting and
+ * returning it.
+ *
+ * @param obj The scrolled entry object
+ * @return the previously set icon sub-object of this entry, on
+ * success.
+ *
+ * @see elm_entry_icon_set()
+ */
+ EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
+ /**
+ * Sets the visibility of the end widget of the scrolled entry, set by
+ * elm_entry_end_set().
+ *
+ * @param obj The scrolled entry object
+ * @param setting EINA_TRUE if the object should be displayed,
+ * EINA_FALSE if not.
+ */
+ EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
+ /**
+ * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
+ * them).
+ *
+ * Setting an entry to single-line mode with elm_entry_single_line_set()
+ * will automatically disable the display of scrollbars when the entry
+ * moves inside its scroller.
+ *
+ * @param obj The scrolled entry object
+ * @param h The horizontal scrollbar policy to apply
+ * @param v The vertical scrollbar policy to apply
+ */
+ EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
+ /**
+ * This enables/disables bouncing within the entry.
+ *
+ * This function sets whether the entry will bounce when scrolling reaches
+ * the end of the contained entry.
+ *
+ * @param obj The scrolled entry object
+ * @param h The horizontal bounce state
+ * @param v The vertical bounce state
+ */
+ EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
+ /**
+ * Get the bounce mode
+ *
+ * @param obj The Entry object
+ * @param h_bounce Allow bounce horizontally
+ * @param v_bounce Allow bounce vertically
+ */
+ EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
+
+ /* pre-made filters for entries */
+ /**
+ * @typedef Elm_Entry_Filter_Limit_Size
+ *
+ * Data for the elm_entry_filter_limit_size() entry filter.
+ */
+ typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
+ /**
+ * @struct _Elm_Entry_Filter_Limit_Size
+ *
+ * Data for the elm_entry_filter_limit_size() entry filter.
+ */
+ struct _Elm_Entry_Filter_Limit_Size
+ {
+ int max_char_count; /**< The maximum number of characters allowed. */
+ int max_byte_count; /**< The maximum number of bytes allowed*/
+ };
+ /**
+ * Filter inserted text based on user defined character and byte limits
+ *
+ * Add this filter to an entry to limit the characters that it will accept
+ * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
+ * The funtion works on the UTF-8 representation of the string, converting
+ * it from the set markup, thus not accounting for any format in it.
+ *
+ * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
+ * it as data when setting the filter. In it, it's possible to set limits
+ * by character count or bytes (any of them is disabled if 0), and both can
+ * be set at the same time. In that case, it first checks for characters,
+ * then bytes.
+ *
+ * The function will cut the inserted text in order to allow only the first
+ * number of characters that are still allowed. The cut is made in
+ * characters, even when limiting by bytes, in order to always contain
+ * valid ones and avoid half unicode characters making it in.
+ *
+ * This filter, like any others, does not apply when setting the entry text
+ * directly with elm_object_text_set() (or the deprecated
+ * elm_entry_entry_set()).
+ */
+ EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
+ /**
+ * @typedef Elm_Entry_Filter_Accept_Set
+ *
+ * Data for the elm_entry_filter_accept_set() entry filter.
+ */
+ typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
+ /**
+ * @struct _Elm_Entry_Filter_Accept_Set
+ *
+ * Data for the elm_entry_filter_accept_set() entry filter.
+ */
+ struct _Elm_Entry_Filter_Accept_Set
+ {
+ const char *accepted; /**< Set of characters accepted in the entry. */
+ const char *rejected; /**< Set of characters rejected from the entry. */
+ };
+ /**
+ * Filter inserted text based on accepted or rejected sets of characters
+ *
+ * Add this filter to an entry to restrict the set of accepted characters
+ * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
+ * This structure contains both accepted and rejected sets, but they are
+ * mutually exclusive.
+ *
+ * The @c accepted set takes preference, so if it is set, the filter will
+ * only work based on the accepted characters, ignoring anything in the
+ * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
+ *
+ * In both cases, the function filters by matching utf8 characters to the
+ * raw markup text, so it can be used to remove formatting tags.
+ *
+ * This filter, like any others, does not apply when setting the entry text
+ * directly with elm_object_text_set() (or the deprecated
+ * elm_entry_entry_set()).
+ */
+ EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
+ /**
+ * Set the input panel layout of the entry
+ *
+ * @param obj The entry object
+ * @param layout layout type
+ */
+ EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
+ /**
+ * Get the input panel layout of the entry
+ *
+ * @param obj The entry object
+ * @return layout type
+ *
+ * @see elm_entry_input_panel_layout_set
+ */
+ EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @}
+ */
+
+ /* composite widgets - these basically put together basic widgets above
+ * in convenient packages that do more than basic stuff */
+
+ /* anchorview */
+ /**
+ * @defgroup Anchorview Anchorview
+ *
+ * @image html img/widget/anchorview/preview-00.png
+ * @image latex img/widget/anchorview/preview-00.eps
+ *
+ * Anchorview is for displaying text that contains markup with anchors
+ * like <c>\<a href=1234\>something\</\></c> in it.
+ *
+ * Besides being styled differently, the anchorview widget provides the
+ * necessary functionality so that clicking on these anchors brings up a
+ * popup with user defined content such as "call", "add to contacts" or
+ * "open web page". This popup is provided using the @ref Hover widget.
+ *
+ * This widget is very similar to @ref Anchorblock, so refer to that
+ * widget for an example. The only difference Anchorview has is that the
+ * widget is already provided with scrolling functionality, so if the
+ * text set to it is too large to fit in the given space, it will scroll,
+ * whereas the @ref Anchorblock widget will keep growing to ensure all the
+ * text can be displayed.
+ *
+ * This widget emits the following signals:
+ * @li "anchor,clicked": will be called when an anchor is clicked. The
+ * @p event_info parameter on the callback will be a pointer of type
+ * ::Elm_Entry_Anchorview_Info.
+ *
+ * See @ref Anchorblock for an example on how to use both of them.
+ *
+ * @see Anchorblock
+ * @see Entry
+ * @see Hover
+ *
+ * @{
+ */
+ /**
+ * @typedef Elm_Entry_Anchorview_Info
+ *
+ * The info sent in the callback for "anchor,clicked" signals emitted by
+ * the Anchorview widget.
+ */
+ typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
+ /**
+ * @struct _Elm_Entry_Anchorview_Info
+ *
+ * The info sent in the callback for "anchor,clicked" signals emitted by
+ * the Anchorview widget.
+ */
+ struct _Elm_Entry_Anchorview_Info
+ {
+ const char *name; /**< Name of the anchor, as indicated in its href
+ attribute */
+ int button; /**< The mouse button used to click on it */
+ Evas_Object *hover; /**< The hover object to use for the popup */
+ struct {
+ Evas_Coord x, y, w, h;
+ } anchor, /**< Geometry selection of text used as anchor */
+ hover_parent; /**< Geometry of the object used as parent by the
+ hover */
+ Eina_Bool hover_left : 1; /**< Hint indicating if there's space
+ for content on the left side of
+ the hover. Before calling the
+ callback, the widget will make the
+ necessary calculations to check
+ which sides are fit to be set with
+ content, based on the position the
+ hover is activated and its distance
+ to the edges of its parent object
+ */
+ Eina_Bool hover_right : 1; /**< Hint indicating content fits on
+ the right side of the hover.
+ See @ref hover_left */
+ Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
+ of the hover. See @ref hover_left */
+ Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
+ below the hover. See @ref
+ hover_left */
+ };
+ /**
+ * Add a new Anchorview object
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ */
+ EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * Set the text to show in the anchorview
+ *
+ * Sets the text of the anchorview to @p text. This text can include markup
+ * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
+ * text that will be specially styled and react to click events, ended with
+ * either of \</a\> or \</\>. When clicked, the anchor will emit an
+ * "anchor,clicked" signal that you can attach a callback to with
+ * evas_object_smart_callback_add(). The name of the anchor given in the
+ * event info struct will be the one set in the href attribute, in this
+ * case, anchorname.
+ *
+ * Other markup can be used to style the text in different ways, but it's
+ * up to the style defined in the theme which tags do what.
+ * @deprecated use elm_object_text_set() instead.
+ */
+ EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
+ /**
+ * Get the markup text set for the anchorview
+ *
+ * Retrieves the text set on the anchorview, with markup tags included.
+ *
+ * @param obj The anchorview object
+ * @return The markup text set or @c NULL if nothing was set or an error
+ * occurred
+ * @deprecated use elm_object_text_set() instead.
+ */
+ EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the parent of the hover popup
+ *
+ * Sets the parent object to use by the hover created by the anchorview
+ * when an anchor is clicked. See @ref Hover for more details on this.
+ * If no parent is set, the same anchorview object will be used.
+ *
+ * @param obj The anchorview object
+ * @param parent The object to use as parent for the hover
+ */
+ EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * Get the parent of the hover popup
+ *
+ * Get the object used as parent for the hover created by the anchorview
+ * widget. See @ref Hover for more details on this.
+ *
+ * @param obj The anchorview object
+ * @return The object used as parent for the hover, NULL if none is set.
+ */
+ EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the style that the hover should use
+ *
+ * When creating the popup hover, anchorview will request that it's
+ * themed according to @p style.
+ *
+ * @param obj The anchorview object
+ * @param style The style to use for the underlying hover
+ *
+ * @see elm_object_style_set()
+ */
+ EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
+ /**
+ * Get the style that the hover should use
+ *
+ * Get the style the hover created by anchorview will use.
+ *
+ * @param obj The anchorview object
+ * @return The style to use by the hover. NULL means the default is used.
+ *
+ * @see elm_object_style_set()
+ */
+ EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Ends the hover popup in the anchorview
+ *
+ * When an anchor is clicked, the anchorview widget will create a hover
+ * object to use as a popup with user provided content. This function
+ * terminates this popup, returning the anchorview to its normal state.
+ *
+ * @param obj The anchorview object
+ */
+ EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set bouncing behaviour when the scrolled content reaches an edge
+ *
+ * Tell the internal scroller object whether it should bounce or not
+ * when it reaches the respective edges for each axis.
+ *
+ * @param obj The anchorview object
+ * @param h_bounce Whether to bounce or not in the horizontal axis
+ * @param v_bounce Whether to bounce or not in the vertical axis
+ *
+ * @see elm_scroller_bounce_set()
+ */
+ EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+ /**
+ * Get the set bouncing behaviour of the internal scroller
+ *
+ * Get whether the internal scroller should bounce when the edge of each
+ * axis is reached scrolling.
+ *
+ * @param obj The anchorview object
+ * @param h_bounce Pointer where to store the bounce state of the horizontal
+ * axis
+ * @param v_bounce Pointer where to store the bounce state of the vertical
+ * axis
+ *
+ * @see elm_scroller_bounce_get()
+ */
+ EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
+ /**
+ * Appends a custom item provider to the given anchorview
+ *
+ * Appends the given function to the list of items providers. This list is
+ * called, one function at a time, with the given @p data pointer, the
+ * anchorview object and, in the @p item parameter, the item name as
+ * referenced in its href string. Following functions in the list will be
+ * called in order until one of them returns something different to NULL,
+ * which should be an Evas_Object which will be used in place of the item
+ * element.
+ *
+ * Items in the markup text take the form \<item relsize=16x16 vsize=full
+ * href=item/name\>\</item\>
+ *
+ * @param obj The anchorview object
+ * @param func The function to add to the list of providers
+ * @param data User data that will be passed to the callback function
+ *
+ * @see elm_entry_item_provider_append()
+ */
+ 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);
+ /**
+ * Prepend a custom item provider to the given anchorview
+ *
+ * Like elm_anchorview_item_provider_append(), but it adds the function
+ * @p func to the beginning of the list, instead of the end.
+ *
+ * @param obj The anchorview object
+ * @param func The function to add to the list of providers
+ * @param data User data that will be passed to the callback function
+ */
+ 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);
+ /**
+ * Remove a custom item provider from the list of the given anchorview
+ *
+ * Removes the function and data pairing that matches @p func and @p data.
+ * That is, unless the same function and same user data are given, the
+ * function will not be removed from the list. This allows us to add the
+ * same callback several times, with different @p data pointers and be
+ * able to remove them later without conflicts.
+ *
+ * @param obj The anchorview object
+ * @param func The function to remove from the list
+ * @param data The data matching the function to remove from the list
+ */
+ 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);
+ /**
+ * @}
+ */
+
+ /* anchorblock */
+ /**
+ * @defgroup Anchorblock Anchorblock
+ *
+ * @image html img/widget/anchorblock/preview-00.png
+ * @image latex img/widget/anchorblock/preview-00.eps
+ *
+ * Anchorblock is for displaying text that contains markup with anchors
+ * like <c>\<a href=1234\>something\</\></c> in it.
+ *
+ * Besides being styled differently, the anchorblock widget provides the
+ * necessary functionality so that clicking on these anchors brings up a
+ * popup with user defined content such as "call", "add to contacts" or
+ * "open web page". This popup is provided using the @ref Hover widget.
+ *
+ * This widget emits the following signals:
+ * @li "anchor,clicked": will be called when an anchor is clicked. The
+ * @p event_info parameter on the callback will be a pointer of type
+ * ::Elm_Entry_Anchorblock_Info.
+ *
+ * @see Anchorview
+ * @see Entry
+ * @see Hover
+ *
+ * Since examples are usually better than plain words, we might as well
+ * try @ref tutorial_anchorblock_example "one".
+ */
+ /**
+ * @addtogroup Anchorblock
+ * @{
+ */
+ /**
+ * @typedef Elm_Entry_Anchorblock_Info
+ *
+ * The info sent in the callback for "anchor,clicked" signals emitted by
+ * the Anchorblock widget.
+ */
+ typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
+ /**
+ * @struct _Elm_Entry_Anchorblock_Info
+ *
+ * The info sent in the callback for "anchor,clicked" signals emitted by
+ * the Anchorblock widget.
+ */
+ struct _Elm_Entry_Anchorblock_Info
+ {
+ const char *name; /**< Name of the anchor, as indicated in its href
+ attribute */
+ int button; /**< The mouse button used to click on it */
+ Evas_Object *hover; /**< The hover object to use for the popup */
+ struct {
+ Evas_Coord x, y, w, h;
+ } anchor, /**< Geometry selection of text used as anchor */
+ hover_parent; /**< Geometry of the object used as parent by the
+ hover */
+ Eina_Bool hover_left : 1; /**< Hint indicating if there's space
+ for content on the left side of
+ the hover. Before calling the
+ callback, the widget will make the
+ necessary calculations to check
+ which sides are fit to be set with
+ content, based on the position the
+ hover is activated and its distance
+ to the edges of its parent object
+ */
+ Eina_Bool hover_right : 1; /**< Hint indicating content fits on
+ the right side of the hover.
+ See @ref hover_left */
+ Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
+ of the hover. See @ref hover_left */
+ Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
+ below the hover. See @ref
+ hover_left */
+ };
+ /**
+ * Add a new Anchorblock object
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ */
+ EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * Set the text to show in the anchorblock
+ *
+ * Sets the text of the anchorblock to @p text. This text can include markup
+ * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
+ * of text that will be specially styled and react to click events, ended
+ * with either of \</a\> or \</\>. When clicked, the anchor will emit an
+ * "anchor,clicked" signal that you can attach a callback to with
+ * evas_object_smart_callback_add(). The name of the anchor given in the
+ * event info struct will be the one set in the href attribute, in this
+ * case, anchorname.
+ *
+ * Other markup can be used to style the text in different ways, but it's
+ * up to the style defined in the theme which tags do what.
+ * @deprecated use elm_object_text_set() instead.
+ */
+ EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
+ /**
+ * Get the markup text set for the anchorblock
+ *
+ * Retrieves the text set on the anchorblock, with markup tags included.
+ *
+ * @param obj The anchorblock object
+ * @return The markup text set or @c NULL if nothing was set or an error
+ * occurred
+ * @deprecated use elm_object_text_set() instead.
+ */
+ EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the parent of the hover popup
+ *
+ * Sets the parent object to use by the hover created by the anchorblock
+ * when an anchor is clicked. See @ref Hover for more details on this.
+ *
+ * @param obj The anchorblock object
+ * @param parent The object to use as parent for the hover
+ */
+ EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * Get the parent of the hover popup
+ *
+ * Get the object used as parent for the hover created by the anchorblock
+ * widget. See @ref Hover for more details on this.
+ * If no parent is set, the same anchorblock object will be used.
+ *
+ * @param obj The anchorblock object
+ * @return The object used as parent for the hover, NULL if none is set.
+ */
+ EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the style that the hover should use
+ *
+ * When creating the popup hover, anchorblock will request that it's
+ * themed according to @p style.
+ *
+ * @param obj The anchorblock object
+ * @param style The style to use for the underlying hover
+ *
+ * @see elm_object_style_set()
+ */
+ EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
+ /**
+ * Get the style that the hover should use
+ *
+ * Get the style the hover created by anchorblock will use.
+ *
+ * @param obj The anchorblock object
+ * @return The style to use by the hover. NULL means the default is used.
+ *
+ * @see elm_object_style_set()
+ */
+ EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Ends the hover popup in the anchorblock
+ *
+ * When an anchor is clicked, the anchorblock widget will create a hover
+ * object to use as a popup with user provided content. This function
+ * terminates this popup, returning the anchorblock to its normal state.
+ *
+ * @param obj The anchorblock object
+ */
+ EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Appends a custom item provider to the given anchorblock
+ *
+ * Appends the given function to the list of items providers. This list is
+ * called, one function at a time, with the given @p data pointer, the
+ * anchorblock object and, in the @p item parameter, the item name as
+ * referenced in its href string. Following functions in the list will be
+ * called in order until one of them returns something different to NULL,
+ * which should be an Evas_Object which will be used in place of the item
+ * element.
+ *
+ * Items in the markup text take the form \<item relsize=16x16 vsize=full
+ * href=item/name\>\</item\>
+ *
+ * @param obj The anchorblock object
+ * @param func The function to add to the list of providers
+ * @param data User data that will be passed to the callback function
+ *
+ * @see elm_entry_item_provider_append()
+ */
+ 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);
+ /**
+ * Prepend a custom item provider to the given anchorblock
+ *
+ * Like elm_anchorblock_item_provider_append(), but it adds the function
+ * @p func to the beginning of the list, instead of the end.
+ *
+ * @param obj The anchorblock object
+ * @param func The function to add to the list of providers
+ * @param data User data that will be passed to the callback function
+ */
+ 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);
+ /**
+ * Remove a custom item provider from the list of the given anchorblock
+ *
+ * Removes the function and data pairing that matches @p func and @p data.
+ * That is, unless the same function and same user data are given, the
+ * function will not be removed from the list. This allows us to add the
+ * same callback several times, with different @p data pointers and be
+ * able to remove them later without conflicts.
+ *
+ * @param obj The anchorblock object
+ * @param func The function to remove from the list
+ * @param data The data matching the function to remove from the list
+ */
+ 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);
+ /**
+ * @}
+ */
+
+ /**
+ * @defgroup Bubble Bubble
+ *
+ * @image html img/widget/bubble/preview-00.png
+ * @image latex img/widget/bubble/preview-00.eps
+ * @image html img/widget/bubble/preview-01.png
+ * @image latex img/widget/bubble/preview-01.eps
+ * @image html img/widget/bubble/preview-02.png
+ * @image latex img/widget/bubble/preview-02.eps
+ *
+ * @brief The Bubble is a widget to show text similarly to how speech is
+ * represented in comics.
+ *
+ * The bubble widget contains 5 important visual elements:
+ * @li The frame is a rectangle with rounded rectangles and an "arrow".
+ * @li The @p icon is an image to which the frame's arrow points to.
+ * @li The @p label is a text which appears to the right of the icon if the
+ * corner is "top_left" or "bottom_left" and is right aligned to the frame
+ * otherwise.
+ * @li The @p info is a text which appears to the right of the label. Info's
+ * font is of a ligther color than label.
+ * @li The @p content is an evas object that is shown inside the frame.
+ *
+ * The position of the arrow, icon, label and info depends on which corner is
+ * selected. The four available corners are:
+ * @li "top_left" - Default
+ * @li "top_right"
+ * @li "bottom_left"
+ * @li "bottom_right"
+ *
+ * Signals that you can add callbacks for are:
+ * @li "clicked" - This is called when a user has clicked the bubble.
+ *
+ * For an example of using a buble see @ref bubble_01_example_page "this".
+ *
+ * @{
+ */
+ /**
+ * Add a new bubble to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * This function adds a text bubble to the given parent evas object.
+ */
+ EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * Set the label of the bubble
+ *
+ * @param obj The bubble object
+ * @param label The string to set in the label
+ *
+ * This function sets the title of the bubble. Where this appears depends on
+ * the selected corner.
+ * @deprecated use elm_object_text_set() instead.
+ */
+ EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+ /**
+ * Get the label of the bubble
+ *
+ * @param obj The bubble object
+ * @return The string of set in the label
+ *
+ * This function gets the title of the bubble.
+ * @deprecated use elm_object_text_get() instead.
+ */
+ EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the info of the bubble
+ *
+ * @param obj The bubble object
+ * @param info The given info about the bubble
+ *
+ * This function sets the info of the bubble. Where this appears depends on
+ * the selected corner.
+ * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
+ */
+ EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
+ /**
+ * Get the info of the bubble
+ *
+ * @param obj The bubble object
+ *
+ * @return The "info" string of the bubble
+ *
+ * This function gets the info text.
+ * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
+ */
+ EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the content to be shown in the bubble
+ *
+ * Once the content object is set, a previously set one will be deleted.
+ * If you want to keep the old content object, use the
+ * elm_bubble_content_unset() function.
+ *
+ * @param obj The bubble object
+ * @param content The given content of the bubble
+ *
+ * This function sets the content shown on the middle of the bubble.
+ */
+ EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+ /**
+ * Get the content shown in the bubble
+ *
+ * Return the content object which is set for this widget.
+ *
+ * @param obj The bubble object
+ * @return The content that is being used
+ */
+ EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Unset the content shown in the bubble
+ *
+ * Unparent and return the content object which was set for this widget.
+ *
+ * @param obj The bubble object
+ * @return The content that was being used
+ */
+ EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the icon of the bubble
+ *
+ * Once the icon object is set, a previously set one will be deleted.
+ * If you want to keep the old content object, use the
+ * elm_icon_content_unset() function.
+ *
+ * @param obj The bubble object
+ * @param icon The given icon for the bubble
+ */
+ EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+ /**
+ * Get the icon of the bubble
+ *
+ * @param obj The bubble object
+ * @return The icon for the bubble
+ *
+ * This function gets the icon shown on the top left of bubble.
+ */
+ EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Unset the icon of the bubble
+ *
+ * Unparent and return the icon object which was set for this widget.
+ *
+ * @param obj The bubble object
+ * @return The icon that was being used
+ */
+ EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the corner of the bubble
+ *
+ * @param obj The bubble object.
+ * @param corner The given corner for the bubble.
+ *
+ * This function sets the corner of the bubble. The corner will be used to
+ * determine where the arrow in the frame points to and where label, icon and
+ * info arre shown.
+ *
+ * Possible values for corner are:
+ * @li "top_left" - Default
+ * @li "top_right"
+ * @li "bottom_left"
+ * @li "bottom_right"
+ */
+ EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
+ /**
+ * Get the corner of the bubble
+ *
+ * @param obj The bubble object.
+ * @return The given corner for the bubble.
+ *
+ * This function gets the selected corner of the bubble.
+ */
+ EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @}
+ */
+
+ /**
+ * @defgroup Photo Photo
+ *
+ * For displaying the photo of a person (contact). Simple yet
+ * with a very specific purpose.
+ *
+ * Signals that you can add callbacks for are:
+ *
+ * "clicked" - This is called when a user has clicked the photo
+ * "drag,start" - Someone started dragging the image out of the object
+ * "drag,end" - Dragged item was dropped (somewhere)
+ *
+ * @{
+ */
+
+ /**
+ * Add a new photo to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Photo
+ */
+ EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the file that will be used as photo
+ *
+ * @param obj The photo object
+ * @param file The path to file that will be used as photo
+ *
+ * @return (1 = success, 0 = error)
+ *
+ * @ingroup Photo
+ */
+ EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the file that will be used as thumbnail in the photo.
+ *
+ * @param obj The photo object.
+ * @param file The path to file that will be used as thumb.
+ * @param group The key used in case of an EET file.
+ *
+ * @ingroup Photo
+ */
+ EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
+
+ /**
+ * Set the size that will be used on the photo
+ *
+ * @param obj The photo object
+ * @param size The size that the photo will be
+ *
+ * @ingroup Photo
+ */
+ EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set if the photo should be completely visible or not.
+ *
+ * @param obj The photo object
+ * @param fill if true the photo will be completely visible
+ *
+ * @ingroup Photo
+ */
+ EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set editability of the photo.
+ *
+ * An editable photo can be dragged to or from, and can be cut or
+ * pasted too. Note that pasting an image or dropping an item on
+ * the image will delete the existing content.
+ *
+ * @param obj The photo object.
+ * @param set To set of clear editablity.
+ */
+ EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
+
+ /**
+ * @}
+ */
+
+ /* gesture layer */
+ /**
+ * @defgroup Elm_Gesture_Layer Gesture Layer
+ * Gesture Layer Usage:
+ *
+ * Use Gesture Layer to detect gestures.
+ * The advantage is that you don't have to implement
+ * gesture detection, just set callbacks of gesture state.
+ * By using gesture layer we make standard interface.
+ *
+ * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
+ * with a parent object parameter.
+ * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
+ * call. Usually with same object as target (2nd parameter).
+ *
+ * Now you need to tell gesture layer what gestures you follow.
+ * This is done with @ref elm_gesture_layer_cb_set call.
+ * By setting the callback you actually saying to gesture layer:
+ * I would like to know when the gesture @ref Elm_Gesture_Types
+ * switches to state @ref Elm_Gesture_State.
+ *
+ * Next, you need to implement the actual action that follows the input
+ * in your callback.
+ *
+ * Note that if you like to stop being reported about a gesture, just set
+ * all callbacks referring this gesture to NULL.
+ * (again with @ref elm_gesture_layer_cb_set)
+ *
+ * The information reported by gesture layer to your callback is depending
+ * on @ref Elm_Gesture_Types:
+ * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
+ * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
+ * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
+ *
+ * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
+ * @ref ELM_GESTURE_MOMENTUM.
+ *
+ * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
+ * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
+ * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
+ * Note that we consider a flick as a line-gesture that should be completed
+ * in flick-time-limit as defined in @ref Config.
+ *
+ * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
+ *
+ * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
+ *
+ *
+ * Gesture Layer Tweaks:
+ *
+ * Note that line, flick, gestures can start without the need to remove fingers from surface.
+ * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
+ *
+ * Setting glayer_continues_enable to false in @ref Config will change this behavior
+ * so gesture starts when user touches (a *DOWN event) touch-surface
+ * and ends when no fingers touches surface (a *UP event).
+ */
+
+ /**
+ * @enum _Elm_Gesture_Types
+ * Enum of supported gesture types.
+ * @ingroup Elm_Gesture_Layer
+ */
+ enum _Elm_Gesture_Types
+ {
+ ELM_GESTURE_FIRST = 0,
+
+ ELM_GESTURE_N_TAPS, /**< N fingers single taps */
+ ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
+ ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
+ ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
+
+ ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
+
+ ELM_GESTURE_N_LINES, /**< N fingers line gesture */
+ ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
+
+ ELM_GESTURE_ZOOM, /**< Zoom */
+ ELM_GESTURE_ROTATE, /**< Rotate */
+
+ ELM_GESTURE_LAST
+ };
+
+ /**
+ * @typedef Elm_Gesture_Types
+ * gesture types enum
+ * @ingroup Elm_Gesture_Layer
+ */
+ typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
+
+ /**
+ * @enum _Elm_Gesture_State
+ * Enum of gesture states.
+ * @ingroup Elm_Gesture_Layer
+ */
+ enum _Elm_Gesture_State
+ {
+ ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
+ ELM_GESTURE_STATE_START, /**< Gesture STARTed */
+ ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
+ ELM_GESTURE_STATE_END, /**< Gesture completed */
+ ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
+ };
+
+ /**
+ * @typedef Elm_Gesture_State
+ * gesture states enum
+ * @ingroup Elm_Gesture_Layer
+ */
+ typedef enum _Elm_Gesture_State Elm_Gesture_State;
+
+ /**
+ * @struct _Elm_Gesture_Taps_Info
+ * Struct holds taps info for user
+ * @ingroup Elm_Gesture_Layer
+ */
+ struct _Elm_Gesture_Taps_Info
+ {
+ Evas_Coord x, y; /**< Holds center point between fingers */
+ unsigned int n; /**< Number of fingers tapped */
+ unsigned int timestamp; /**< event timestamp */
+ };
+
+ /**
+ * @typedef Elm_Gesture_Taps_Info
+ * holds taps info for user
+ * @ingroup Elm_Gesture_Layer
+ */
+ typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
+
+ /**
+ * @struct _Elm_Gesture_Momentum_Info
+ * Struct holds momentum info for user
+ * x1 and y1 are not necessarily in sync
+ * x1 holds x value of x direction starting point
+ * and same holds for y1.
+ * This is noticeable when doing V-shape movement
+ * @ingroup Elm_Gesture_Layer
+ */
+ struct _Elm_Gesture_Momentum_Info
+ { /* Report line ends, timestamps, and momentum computed */
+ Evas_Coord x1; /**< Final-swipe direction starting point on X */
+ Evas_Coord y1; /**< Final-swipe direction starting point on Y */
+ Evas_Coord x2; /**< Final-swipe direction ending point on X */
+ Evas_Coord y2; /**< Final-swipe direction ending point on Y */
+
+ unsigned int tx; /**< Timestamp of start of final x-swipe */
+ unsigned int ty; /**< Timestamp of start of final y-swipe */
+
+ Evas_Coord mx; /**< Momentum on X */
+ Evas_Coord my; /**< Momentum on Y */
+ };
+
+ /**
+ * @typedef Elm_Gesture_Momentum_Info
+ * holds momentum info for user
+ * @ingroup Elm_Gesture_Layer
+ */
+ typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
+
+ /**
+ * @struct _Elm_Gesture_Line_Info
+ * Struct holds line info for user
+ * @ingroup Elm_Gesture_Layer
+ */
+ struct _Elm_Gesture_Line_Info
+ { /* Report line ends, timestamps, and momentum computed */
+ Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
+ unsigned int n; /**< Number of fingers (lines) */
+ /* FIXME should be radians, bot degrees */
+ double angle; /**< Angle (direction) of lines */
+ };
+
+ /**
+ * @typedef Elm_Gesture_Line_Info
+ * Holds line info for user
+ * @ingroup Elm_Gesture_Layer
+ */
+ typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
+
+ /**
+ * @struct _Elm_Gesture_Zoom_Info
+ * Struct holds zoom info for user
+ * @ingroup Elm_Gesture_Layer
+ */
+ struct _Elm_Gesture_Zoom_Info
+ {
+ Evas_Coord x, y; /**< Holds zoom center point reported to user */
+ Evas_Coord radius; /**< Holds radius between fingers reported to user */
+ double zoom; /**< Zoom value: 1.0 means no zoom */
+ double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
+ };
+
+ /**
+ * @typedef Elm_Gesture_Zoom_Info
+ * Holds zoom info for user
+ * @ingroup Elm_Gesture_Layer
+ */
+ typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
+
+ /**
+ * @struct _Elm_Gesture_Rotate_Info
+ * Struct holds rotation info for user
+ * @ingroup Elm_Gesture_Layer
+ */
+ struct _Elm_Gesture_Rotate_Info
+ {
+ Evas_Coord x, y; /**< Holds zoom center point reported to user */
+ Evas_Coord radius; /**< Holds radius between fingers reported to user */
+ double base_angle; /**< Holds start-angle */
+ double angle; /**< Rotation value: 0.0 means no rotation */
+ double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
+ };
+
+ /**
+ * @typedef Elm_Gesture_Rotate_Info
+ * Holds rotation info for user
+ * @ingroup Elm_Gesture_Layer
+ */
+ typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
+
+ /**
+ * @typedef Elm_Gesture_Event_Cb
+ * User callback used to stream gesture info from gesture layer
+ * @param data user data
+ * @param event_info gesture report info
+ * Returns a flag field to be applied on the causing event.
+ * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
+ * upon the event, in an irreversible way.
+ *
+ * @ingroup Elm_Gesture_Layer
+ */
+ typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
+
+ /**
+ * Use function to set callbacks to be notified about
+ * change of state of gesture.
+ * When a user registers a callback with this function
+ * this means this gesture has to be tested.
+ *
+ * When ALL callbacks for a gesture are set to NULL
+ * it means user isn't interested in gesture-state
+ * and it will not be tested.
+ *
+ * @param obj Pointer to gesture-layer.
+ * @param idx The gesture you would like to track its state.
+ * @param cb callback function pointer.
+ * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
+ * @param data user info to be sent to callback (usually, Smart Data)
+ *
+ * @ingroup Elm_Gesture_Layer
+ */
+ EAPI void elm_gesture_layer_cb_set(Evas_Object *obj, Elm_Gesture_Types idx, Elm_Gesture_State cb_type, Elm_Gesture_Event_Cb cb, void *data) EINA_ARG_NONNULL(1);
+
+ /**
+ * Call this function to get repeat-events settings.
+ *
+ * @param obj Pointer to gesture-layer.
+ *
+ * @return repeat events settings.
+ * @see elm_gesture_layer_hold_events_set()
+ * @ingroup Elm_Gesture_Layer
+ */
+ EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * This function called in order to make gesture-layer repeat events.
+ * Set this of you like to get the raw events only if gestures were not detected.
+ * Clear this if you like gesture layer to fwd events as testing gestures.
+ *
+ * @param obj Pointer to gesture-layer.
+ * @param r Repeat: TRUE/FALSE
+ *
+ * @ingroup Elm_Gesture_Layer
*/
- typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
+ EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
+
/**
- * @struct _Elm_Entry_Anchor_Info
+ * This function sets step-value for zoom action.
+ * Set step to any positive value.
+ * Cancel step setting by setting to 0.0
*
- * The info sent in the callback for the "anchor,clicked" signals emitted
- * by entries.
+ * @param obj Pointer to gesture-layer.
+ * @param s new zoom step value.
+ *
+ * @ingroup Elm_Gesture_Layer
*/
- struct _Elm_Entry_Anchor_Info
- {
- const char *name; /**< The name of the anchor, as stated in its href */
- int button; /**< The mouse button used to click on it */
- Evas_Coord x, /**< Anchor geometry, relative to canvas */
- y, /**< Anchor geometry, relative to canvas */
- w, /**< Anchor geometry, relative to canvas */
- h; /**< Anchor geometry, relative to canvas */
- };
+ EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
+
/**
- * @typedef Elm_Entry_Filter_Cb
- * This callback type is used by entry filters to modify text.
- * @param data The data specified as the last param when adding the filter
- * @param entry The entry object
- * @param text A pointer to the location of the text being filtered. This data can be modified,
- * but any additional allocations must be managed by the user.
- * @see elm_entry_text_filter_append
- * @see elm_entry_text_filter_prepend
+ * This function sets step-value for rotate action.
+ * Set step to any positive value.
+ * Cancel step setting by setting to 0.0
+ *
+ * @param obj Pointer to gesture-layer.
+ * @param s new roatate step value.
+ *
+ * @ingroup Elm_Gesture_Layer
*/
- typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
+ EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
/**
- * This adds an entry to @p parent object.
+ * This function called to attach gesture-layer to an Evas_Object.
+ * @param obj Pointer to gesture-layer.
+ * @param t Pointer to underlying object (AKA Target)
*
- * By default, entries are:
- * @li not scrolled
- * @li multi-line
- * @li word wrapped
- * @li autosave is enabled
+ * @return TRUE, FALSE on success, failure.
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @ingroup Elm_Gesture_Layer
*/
- EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
+
/**
- * Sets the entry to single line mode.
+ * Call this function to construct a new gesture-layer object.
+ * This does not activate the gesture layer. You have to
+ * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
*
- * In single line mode, entries don't ever wrap when the text reaches the
- * edge, and instead they keep growing horizontally. Pressing the @c Enter
- * key will generate an @c "activate" event instead of adding a new line.
+ * @param parent the parent object.
*
- * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
- * and pressing enter will break the text into a different line
- * without generating any events.
+ * @return Pointer to new gesture-layer object.
*
- * @param obj The entry object
- * @param single_line If true, the text in the entry
- * will be on a single line.
+ * @ingroup Elm_Gesture_Layer
*/
- EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
- * Gets whether the entry is set to be single line.
+ * @defgroup Thumb Thumb
*
- * @param obj The entry object
- * @return single_line If true, the text in the entry is set to display
- * on a single line.
+ * @image html img/widget/thumb/preview-00.png
+ * @image latex img/widget/thumb/preview-00.eps
*
- * @see elm_entry_single_line_set()
- */
- EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Sets the entry to password mode.
+ * A thumb object is used for displaying the thumbnail of an image or video.
+ * You must have compiled Elementary with Ethumb_Client support and the DBus
+ * service must be present and auto-activated in order to have thumbnails to
+ * be generated.
*
- * In password mode, entries are implicitly single line and the display of
- * any text in them is replaced with asterisks (*).
+ * Once the thumbnail object becomes visible, it will check if there is a
+ * previously generated thumbnail image for the file set on it. If not, it
+ * will start generating this thumbnail.
*
- * @param obj The entry object
- * @param password If true, password mode is enabled.
- */
- EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
- /**
- * Gets whether the entry is set to password mode.
+ * Different config settings will cause different thumbnails to be generated
+ * even on the same file.
*
- * @param obj The entry object
- * @return If true, the entry is set to display all characters
- * as asterisks (*).
+ * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
+ * Ethumb documentation to change this path, and to see other configuration
+ * options.
*
- * @see elm_entry_password_set()
+ * Signals that you can add callbacks for are:
+ *
+ * - "clicked" - This is called when a user has clicked the thumb without dragging
+ * around.
+ * - "clicked,double" - This is called when a user has double-clicked the thumb.
+ * - "press" - This is called when a user has pressed down the thumb.
+ * - "generate,start" - The thumbnail generation started.
+ * - "generate,stop" - The generation process stopped.
+ * - "generate,error" - The generation failed.
+ * - "load,error" - The thumbnail image loading failed.
+ *
+ * available styles:
+ * - default
+ * - noframe
+ *
+ * An example of use of thumbnail:
+ *
+ * - @ref thumb_example_01
*/
- EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * This sets the text displayed within the entry to @p entry.
+ * @addtogroup Thumb
+ * @{
+ */
+
+ /**
+ * @enum _Elm_Thumb_Animation_Setting
+ * @typedef Elm_Thumb_Animation_Setting
*
- * @param obj The entry object
- * @param entry The text to be displayed
+ * Used to set if a video thumbnail is animating or not.
*
- * @deprecated Use elm_object_text_set() instead.
+ * @ingroup Thumb
*/
- EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Thumb_Animation_Setting
+ {
+ ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
+ ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
+ ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
+ ELM_THUMB_ANIMATION_LAST
+ } Elm_Thumb_Animation_Setting;
+
/**
- * This returns the text currently shown in object @p entry.
- * See also elm_entry_entry_set().
+ * Add a new thumb object to the parent.
*
- * @param obj The entry object
- * @return The currently displayed text or NULL on failure
+ * @param parent The parent object.
+ * @return The new object or NULL if it cannot be created.
*
- * @deprecated Use elm_object_text_get() instead.
+ * @see elm_thumb_file_set()
+ * @see elm_thumb_ethumb_client_get()
+ *
+ * @ingroup Thumb
*/
- EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Appends @p entry to the text of the entry.
+ * Reload thumbnail if it was generated before.
*
- * Adds the text in @p entry to the end of any text already present in the
- * widget.
+ * @param obj The thumb object to reload
*
- * The appended text is subject to any filters set for the widget.
+ * This is useful if the ethumb client configuration changed, like its
+ * size, aspect or any other property one set in the handle returned
+ * by elm_thumb_ethumb_client_get().
*
- * @param obj The entry object
- * @param entry The text to be displayed
+ * If the options didn't change, the thumbnail won't be generated again, but
+ * the old one will still be used.
*
- * @see elm_entry_text_filter_append()
+ * @see elm_thumb_file_set()
+ *
+ * @ingroup Thumb
*/
- EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
+ EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Gets whether the entry is empty.
+ * Set the file that will be used as thumbnail.
*
- * Empty means no text at all. If there are any markup tags, like an item
- * tag for which no provider finds anything, and no text is displayed, this
- * function still returns EINA_FALSE.
+ * @param obj The thumb object.
+ * @param file The path to file that will be used as thumb.
+ * @param key The key used in case of an EET file.
*
- * @param obj The entry object
- * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
+ * The file can be an image or a video (in that case, acceptable extensions are:
+ * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
+ * function elm_thumb_animate().
+ *
+ * @see elm_thumb_file_get()
+ * @see elm_thumb_reload()
+ * @see elm_thumb_animate()
+ *
+ * @ingroup Thumb
*/
- EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
/**
- * Gets any selected text within the entry.
+ * Get the image or video path and key used to generate the thumbnail.
*
- * If there's any selected text in the entry, this function returns it as
- * a string in markup format. NULL is returned if no selection exists or
- * if an error occurred.
+ * @param obj The thumb object.
+ * @param file Pointer to filename.
+ * @param key Pointer to key.
*
- * The returned value points to an internal string and should not be freed
- * or modified in any way. If the @p entry object is deleted or its
- * contents are changed, the returned pointer should be considered invalid.
+ * @see elm_thumb_file_set()
+ * @see elm_thumb_path_get()
*
- * @param obj The entry object
- * @return The selected text within the entry or NULL on failure
+ * @ingroup Thumb
*/
- EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
/**
- * Inserts the given text into the entry at the current cursor position.
+ * Get the path and key to the image or video generated by ethumb.
*
- * This inserts text at the cursor position as if it was typed
- * by the user (note that this also allows markup which a user
- * can't just "type" as it would be converted to escaped text, so this
- * call can be used to insert things like emoticon items or bold push/pop
- * tags, other font and color change tags etc.)
+ * One just need to make sure that the thumbnail was generated before getting
+ * its path; otherwise, the path will be NULL. One way to do that is by asking
+ * for the path when/after the "generate,stop" smart callback is called.
*
- * If any selection exists, it will be replaced by the inserted text.
+ * @param obj The thumb object.
+ * @param file Pointer to thumb path.
+ * @param key Pointer to thumb key.
*
- * The inserted text is subject to any filters set for the widget.
+ * @see elm_thumb_file_get()
*
- * @param obj The entry object
- * @param entry The text to insert
+ * @ingroup Thumb
+ */
+ EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
+ /**
+ * Set the animation state for the thumb object. If its content is an animated
+ * video, you may start/stop the animation or tell it to play continuously and
+ * looping.
+ *
+ * @param obj The thumb object.
+ * @param setting The animation setting.
+ *
+ * @see elm_thumb_file_set()
*
- * @see elm_entry_text_filter_append()
+ * @ingroup Thumb
*/
- EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
+ EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
/**
- * Set the line wrap type to use on multi-line entries.
+ * Get the animation state for the thumb object.
*
- * Sets the wrap type used by the entry to any of the specified in
- * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
- * line (without inserting a line break or paragraph separator) when it
- * reaches the far edge of the widget.
+ * @param obj The thumb object.
+ * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
+ * on errors.
*
- * Note that this only makes sense for multi-line entries. A widget set
- * to be single line will never wrap.
+ * @see elm_thumb_animate_set()
*
- * @param obj The entry object
- * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
+ * @ingroup Thumb
*/
- EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
+ EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Gets the wrap mode the entry was set to use.
+ * Get the ethumb_client handle so custom configuration can be made.
*
- * @param obj The entry object
- * @return Wrap type
+ * @return Ethumb_Client instance or NULL.
*
- * @see also elm_entry_line_wrap_set()
- */
- EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Sets if the entry is to be editable or not.
+ * This must be called before the objects are created to be sure no object is
+ * visible and no generation started.
*
- * By default, entries are editable and when focused, any text input by the
- * user will be inserted at the current cursor position. But calling this
- * function with @p editable as EINA_FALSE will prevent the user from
- * inputting text into the entry.
+ * Example of usage:
*
- * The only way to change the text of a non-editable entry is to use
- * elm_object_text_set(), elm_entry_entry_insert() and other related
- * functions.
+ * @code
+ * #include <Elementary.h>
+ * #ifndef ELM_LIB_QUICKLAUNCH
+ * EAPI_MAIN int
+ * elm_main(int argc, char **argv)
+ * {
+ * Ethumb_Client *client;
*
- * @param obj The entry object
- * @param editable If EINA_TRUE, user input will be inserted in the entry,
- * if not, the entry is read-only and no user input is allowed.
- */
- EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
- /**
- * Gets whether the entry is editable or not.
+ * elm_need_ethumb();
*
- * @param obj The entry object
- * @return If true, the entry is editable by the user.
- * If false, it is not editable by the user
+ * // ... your code
*
- * @see elm_entry_editable_set()
- */
- EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * This drops any existing text selection within the entry.
+ * client = elm_thumb_ethumb_client_get();
+ * if (!client)
+ * {
+ * ERR("could not get ethumb_client");
+ * return 1;
+ * }
+ * ethumb_client_size_set(client, 100, 100);
+ * ethumb_client_crop_align_set(client, 0.5, 0.5);
+ * // ... your code
*
- * @param obj The entry object
- */
- EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * This selects all text within the entry.
+ * // Create elm_thumb objects here
*
- * @param obj The entry object
- */
- EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * This moves the cursor one place to the right within the entry.
+ * elm_run();
+ * elm_shutdown();
+ * return 0;
+ * }
+ * #endif
+ * ELM_MAIN()
+ * @endcode
*
- * @param obj The entry object
- * @return EINA_TRUE upon success, EINA_FALSE upon failure
+ * @note There's only one client handle for Ethumb, so once a configuration
+ * change is done to it, any other request for thumbnails (for any thumbnail
+ * object) will use that configuration. Thus, this configuration is global.
+ *
+ * @ingroup Thumb
*/
- EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void *elm_thumb_ethumb_client_get(void);
/**
- * This moves the cursor one place to the left within the entry.
+ * Get the ethumb_client connection state.
*
- * @param obj The entry object
- * @return EINA_TRUE upon success, EINA_FALSE upon failure
+ * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
+ * otherwise.
*/
- EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
/**
- * This moves the cursor one line up within the entry.
+ * Make the thumbnail 'editable'.
*
- * @param obj The entry object
- * @return EINA_TRUE upon success, EINA_FALSE upon failure
+ * @param obj Thumb object.
+ * @param set Turn on or off editability. Default is @c EINA_FALSE.
+ *
+ * This means the thumbnail is a valid drag target for drag and drop, and can be
+ * cut or pasted too.
+ *
+ * @see elm_thumb_editable_get()
+ *
+ * @ingroup Thumb
*/
- EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
/**
- * This moves the cursor one line down within the entry.
+ * Make the thumbnail 'editable'.
*
- * @param obj The entry object
- * @return EINA_TRUE upon success, EINA_FALSE upon failure
+ * @param obj Thumb object.
+ * @return Editability.
+ *
+ * This means the thumbnail is a valid drag target for drag and drop, and can be
+ * cut or pasted too.
+ *
+ * @see elm_thumb_editable_set()
+ *
+ * @ingroup Thumb
*/
- EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * This moves the cursor to the beginning of the entry.
- *
- * @param obj The entry object
+ * @}
*/
- EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * This moves the cursor to the end of the entry.
+ * @defgroup Web Web
*
- * @param obj The entry object
+ * @image html img/widget/web/preview-00.png
+ * @image latex img/widget/web/preview-00.eps
+ *
+ * A web object is used for displaying web pages (HTML/CSS/JS)
+ * using WebKit-EFL. You must have compiled Elementary with
+ * ewebkit support.
+ *
+ * Signals that you can add callbacks for are:
+ * @li "download,request": A file download has been requested. Event info is
+ * a pointer to a Elm_Web_Download
+ * @li "editorclient,contents,changed": Editor client's contents changed
+ * @li "editorclient,selection,changed": Editor client's selection changed
+ * @li "frame,created": A new frame was created. Event info is an
+ * Evas_Object which can be handled with WebKit's ewk_frame API
+ * @li "icon,received": An icon was received by the main frame
+ * @li "inputmethod,changed": Input method changed. Event info is an
+ * Eina_Bool indicating whether it's enabled or not
+ * @li "js,windowobject,clear": JS window object has been cleared
+ * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
+ * is a char *link[2], where the first string contains the URL the link
+ * points to, and the second one the title of the link
+ * @li "link,hover,out": Mouse cursor left the link
+ * @li "load,document,finished": Loading of a document finished. Event info
+ * is the frame that finished loading
+ * @li "load,error": Load failed. Event info is a pointer to
+ * Elm_Web_Frame_Load_Error
+ * @li "load,finished": Load finished. Event info is NULL on success, on
+ * error it's a pointer to Elm_Web_Frame_Load_Error
+ * @li "load,newwindow,show": A new window was created and is ready to be
+ * shown
+ * @li "load,progress": Overall load progress. Event info is a pointer to
+ * a double containing a value between 0.0 and 1.0
+ * @li "load,provisional": Started provisional load
+ * @li "load,started": Loading of a document started
+ * @li "menubar,visible,get": Queries if the menubar is visible. Event info
+ * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
+ * the menubar is visible, or EINA_FALSE in case it's not
+ * @li "menubar,visible,set": Informs menubar visibility. Event info is
+ * an Eina_Bool indicating the visibility
+ * @li "popup,created": A dropdown widget was activated, requesting its
+ * popup menu to be created. Event info is a pointer to Elm_Web_Menu
+ * @li "popup,willdelete": The web object is ready to destroy the popup
+ * object created. Event info is a pointer to Elm_Web_Menu
+ * @li "ready": Page is fully loaded
+ * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
+ * info is a pointer to Eina_Bool where the visibility state should be set
+ * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
+ * is an Eina_Bool with the visibility state set
+ * @li "statusbar,text,set": Text of the statusbar changed. Even info is
+ * a string with the new text
+ * @li "statusbar,visible,get": Queries visibility of the status bar.
+ * Event info is a pointer to Eina_Bool where the visibility state should be
+ * set.
+ * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
+ * an Eina_Bool with the visibility value
+ * @li "title,changed": Title of the main frame changed. Event info is a
+ * string with the new title
+ * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
+ * is a pointer to Eina_Bool where the visibility state should be set
+ * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
+ * info is an Eina_Bool with the visibility state
+ * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
+ * a string with the text to show
+ * @li "uri,changed": URI of the main frame changed. Event info is a string
+ * with the new URI
+ * @li "view,resized": The web object internal's view changed sized
+ * @li "windows,close,request": A JavaScript request to close the current
+ * window was requested
+ * @li "zoom,animated,end": Animated zoom finished
+ *
+ * available styles:
+ * - default
+ *
+ * An example of use of web:
+ *
+ * - @ref web_example_01 TBD
*/
- EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * This moves the cursor to the beginning of the current line.
- *
- * @param obj The entry object
+ * @addtogroup Web
+ * @{
*/
- EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * This moves the cursor to the end of the current line.
+ * Structure used to report load errors.
*
- * @param obj The entry object
+ * Load errors are reported as signal by elm_web. All the strings are
+ * temporary references and should @b not be used after the signal
+ * callback returns. If it's required, make copies with strdup() or
+ * eina_stringshare_add() (they are not even guaranteed to be
+ * stringshared, so must use eina_stringshare_add() and not
+ * eina_stringshare_ref()).
*/
- EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
/**
- * This begins a selection within the entry as though
- * the user were holding down the mouse button to make a selection.
+ * Structure used to report load errors.
*
- * @param obj The entry object
+ * Load errors are reported as signal by elm_web. All the strings are
+ * temporary references and should @b not be used after the signal
+ * callback returns. If it's required, make copies with strdup() or
+ * eina_stringshare_add() (they are not even guaranteed to be
+ * stringshared, so must use eina_stringshare_add() and not
+ * eina_stringshare_ref()).
*/
- EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ struct _Elm_Web_Frame_Load_Error
+ {
+ int code; /**< Numeric error code */
+ Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
+ const char *domain; /**< Error domain name */
+ const char *description; /**< Error description (already localized) */
+ const char *failing_url; /**< The URL that failed to load */
+ Evas_Object *frame; /**< Frame object that produced the error */
+ };
+
/**
- * This ends a selection within the entry as though
- * the user had just released the mouse button while making a selection.
- *
- * @param obj The entry object
+ * The possibles types that the items in a menu can be
*/
- EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Web_Menu_Item_Type Elm_Web_Menu_Item_Type;
/**
- * Gets whether a format node exists at the current cursor position.
- *
- * A format node is anything that defines how the text is rendered. It can
- * be a visible format node, such as a line break or a paragraph separator,
- * or an invisible one, such as bold begin or end tag.
- * This function returns whether any format node exists at the current
- * cursor position.
- *
- * @param obj The entry object
- * @return EINA_TRUE if the current cursor position contains a format node,
- * EINA_FALSE otherwise.
- *
- * @see elm_entry_cursor_is_visible_format_get()
+ * The possibles types that the items in a menu can be
*/
- EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ enum _Elm_Web_Menu_Item_Type
+ {
+ ELM_WEB_MENU_SEPARATOR,
+ ELM_WEB_MENU_GROUP,
+ ELM_WEB_MENU_OPTION
+ };
+
/**
- * Gets if the current cursor position holds a visible format node.
- *
- * @param obj The entry object
- * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
- * if it's an invisible one or no format exists.
- *
- * @see elm_entry_cursor_is_format_get()
+ * Structure describing the items in a menu
*/
- EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
/**
- * Gets the character pointed by the cursor at its current position.
- *
- * This function returns a string with the utf8 character stored at the
- * current cursor position.
- * Only the text is returned, any format that may exist will not be part
- * of the return value.
- *
- * @param obj The entry object
- * @return The text pointed by the cursors.
+ * Structure describing the items in a menu
*/
- EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ struct _Elm_Web_Menu_Item
+ {
+ const char *text; /**< The text for the item */
+ Elm_Web_Menu_Item_Type type; /**< The type of the item */
+ };
+
/**
- * This function returns the geometry of the cursor.
+ * Structure describing the menu of a popup
*
- * It's useful if you want to draw something on the cursor (or where it is),
- * or for example in the case of scrolled entry where you want to show the
- * cursor.
+ * This structure will be passed as the @c event_info for the "popup,create"
+ * signal, which is emitted when a dropdown menu is opened. Users wanting
+ * to handle these popups by themselves should listen to this signal and
+ * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
+ * property as @c EINA_FALSE means that the user will not handle the popup
+ * and the default implementation will be used.
*
- * @param obj The entry object
- * @param x returned geometry
- * @param y returned geometry
- * @param w returned geometry
- * @param h returned geometry
- * @return EINA_TRUE upon success, EINA_FALSE upon failure
+ * When the popup is ready to be dismissed, a "popup,willdelete" signal
+ * will be emitted to notify the user that it can destroy any objects and
+ * free all data related to it.
+ *
+ * @see elm_web_popup_selected_set()
+ * @see elm_web_popup_destroy()
*/
- 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);
+ typedef struct _Elm_Web_Menu Elm_Web_Menu;
/**
- * Sets the cursor position in the entry to the given value
+ * Structure describing the menu of a popup
*
- * The value in @p pos is the index of the character position within the
- * contents of the string as returned by elm_entry_cursor_pos_get().
+ * This structure will be passed as the @c event_info for the "popup,create"
+ * signal, which is emitted when a dropdown menu is opened. Users wanting
+ * to handle these popups by themselves should listen to this signal and
+ * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
+ * property as @c EINA_FALSE means that the user will not handle the popup
+ * and the default implementation will be used.
*
- * @param obj The entry object
- * @param pos The position of the cursor
- */
- EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
- /**
- * Retrieves the current position of the cursor in the entry
+ * When the popup is ready to be dismissed, a "popup,willdelete" signal
+ * will be emitted to notify the user that it can destroy any objects and
+ * free all data related to it.
*
- * @param obj The entry object
- * @return The cursor position
+ * @see elm_web_popup_selected_set()
+ * @see elm_web_popup_destroy()
*/
- EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ struct _Elm_Web_Menu
+ {
+ Eina_List *items; /**< List of #Elm_Web_Menu_Item */
+ int x; /**< The X position of the popup, relative to the elm_web object */
+ int y; /**< The Y position of the popup, relative to the elm_web object */
+ int width; /**< Width of the popup menu */
+ int height; /**< Height of the popup menu */
+
+ Eina_Bool handled : 1; /**< Set to @c EINA_TRUE by the user to indicate that the popup has been handled and the default implementation should be ignored. Leave as @c EINA_FALSE otherwise. */
+ };
+
+ typedef struct _Elm_Web_Download Elm_Web_Download;
+ struct _Elm_Web_Download
+ {
+ const char *url;
+ };
+
/**
- * This executes a "cut" action on the selected text in the entry.
- *
- * @param obj The entry object
+ * Opaque handler containing the features (such as statusbar, menubar, etc)
+ * that are to be set on a newly requested window.
*/
- EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
/**
- * This executes a "copy" action on the selected text in the entry.
+ * Callback type for the create_window hook.
*
- * @param obj The entry object
- */
- EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * This executes a "paste" action in the entry.
+ * The function parameters are:
+ * @li @p data User data pointer set when setting the hook function
+ * @li @p obj The elm_web object requesting the new window
+ * @li @p js Set to @c EINA_TRUE if the request was originated from
+ * JavaScript. @c EINA_FALSE otherwise.
+ * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
+ * the features requested for the new window.
+ *
+ * The returned value of the function should be the @c elm_web widget where
+ * the request will be loaded. That is, if a new window or tab is created,
+ * the elm_web widget in it should be returned, and @b NOT the window
+ * object.
+ * Returning @c NULL should cancel the request.
*
- * @param obj The entry object
- */
- EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ * @see elm_web_window_create_hook_set()
+ */
+ typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
/**
- * This clears and frees the items in a entry's contextual (longpress)
- * menu.
+ * Callback type for the JS alert hook.
*
- * @param obj The entry object
+ * The function parameters are:
+ * @li @p data User data pointer set when setting the hook function
+ * @li @p obj The elm_web object requesting the new window
+ * @li @p message The message to show in the alert dialog
*
- * @see elm_entry_context_menu_item_add()
+ * The function should return the object representing the alert dialog.
+ * Elm_Web will run a second main loop to handle the dialog and normal
+ * flow of the application will be restored when the object is deleted, so
+ * the user should handle the popup properly in order to delete the object
+ * when the action is finished.
+ * If the function returns @c NULL the popup will be ignored.
+ *
+ * @see elm_web_dialog_alert_hook_set()
*/
- EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
/**
- * This adds an item to the entry's contextual menu.
+ * Callback type for the JS confirm hook.
*
- * A longpress on an entry will make the contextual menu show up, if this
- * hasn't been disabled with elm_entry_context_menu_disabled_set().
- * By default, this menu provides a few options like enabling selection mode,
- * which is useful on embedded devices that need to be explicit about it,
- * and when a selection exists it also shows the copy and cut actions.
+ * The function parameters are:
+ * @li @p data User data pointer set when setting the hook function
+ * @li @p obj The elm_web object requesting the new window
+ * @li @p message The message to show in the confirm dialog
+ * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
+ * the user selected @c Ok, @c EINA_FALSE otherwise.
*
- * With this function, developers can add other options to this menu to
- * perform any action they deem necessary.
+ * The function should return the object representing the confirm dialog.
+ * Elm_Web will run a second main loop to handle the dialog and normal
+ * flow of the application will be restored when the object is deleted, so
+ * the user should handle the popup properly in order to delete the object
+ * when the action is finished.
+ * If the function returns @c NULL the popup will be ignored.
*
- * @param obj The entry object
- * @param label The item's text label
- * @param icon_file The item's icon file
- * @param icon_type The item's icon type
- * @param func The callback to execute when the item is clicked
- * @param data The data to associate with the item for related functions
+ * @see elm_web_dialog_confirm_hook_set()
*/
- 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);
+ typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
/**
- * This disables the entry's contextual (longpress) menu.
+ * Callback type for the JS prompt hook.
*
- * @param obj The entry object
- * @param disabled If true, the menu is disabled
+ * The function parameters are:
+ * @li @p data User data pointer set when setting the hook function
+ * @li @p obj The elm_web object requesting the new window
+ * @li @p message The message to show in the prompt dialog
+ * @li @p def_value The default value to present the user in the entry
+ * @li @p value Pointer where to store the value given by the user. Must
+ * be a malloc'ed string or @c NULL if the user cancelled the popup.
+ * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
+ * the user selected @c Ok, @c EINA_FALSE otherwise.
+ *
+ * The function should return the object representing the prompt dialog.
+ * Elm_Web will run a second main loop to handle the dialog and normal
+ * flow of the application will be restored when the object is deleted, so
+ * the user should handle the popup properly in order to delete the object
+ * when the action is finished.
+ * If the function returns @c NULL the popup will be ignored.
+ *
+ * @see elm_web_dialog_prompt_hook_set()
*/
- EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+ typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
/**
- * This returns whether the entry's contextual (longpress) menu is
- * disabled.
+ * Callback type for the JS file selector hook.
*
- * @param obj The entry object
- * @return If true, the menu is disabled
+ * The function parameters are:
+ * @li @p data User data pointer set when setting the hook function
+ * @li @p obj The elm_web object requesting the new window
+ * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
+ * @li @p accept_types Mime types accepted
+ * @li @p selected Pointer where to store the list of malloc'ed strings
+ * containing the path to each file selected. Must be @c NULL if the file
+ * dialog is cancelled
+ * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
+ * the user selected @c Ok, @c EINA_FALSE otherwise.
+ *
+ * The function should return the object representing the file selector
+ * dialog.
+ * Elm_Web will run a second main loop to handle the dialog and normal
+ * flow of the application will be restored when the object is deleted, so
+ * the user should handle the popup properly in order to delete the object
+ * when the action is finished.
+ * If the function returns @c NULL the popup will be ignored.
+ *
+ * @see elm_web_dialog_file selector_hook_set()
*/
- EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, const char *accept_types, Eina_List **selected, Eina_Bool *ret);
/**
- * This appends a custom item provider to the list for that entry
+ * Callback type for the JS console message hook.
*
- * This appends the given callback. The list is walked from beginning to end
- * with each function called given the item href string in the text. If the
- * function returns an object handle other than NULL (it should create an
- * object to do this), then this object is used to replace that item. If
- * not the next provider is called until one provides an item object, or the
- * default provider in entry does.
+ * When a console message is added from JavaScript, any set function to the
+ * console message hook will be called for the user to handle. There is no
+ * default implementation of this hook.
*
- * @param obj The entry object
- * @param func The function called to provide the item object
- * @param data The data passed to @p func
+ * The function parameters are:
+ * @li @p data User data pointer set when setting the hook function
+ * @li @p obj The elm_web object that originated the message
+ * @li @p message The message sent
+ * @li @p line_number The line number
+ * @li @p source_id Source id
*
- * @see @ref entry-items
+ * @see elm_web_console_message_hook_set()
*/
- 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);
+ typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
/**
- * This prepends a custom item provider to the list for that entry
+ * Add a new web object to the parent.
*
- * This prepends the given callback. See elm_entry_item_provider_append() for
- * more information
+ * @param parent The parent object.
+ * @return The new object or NULL if it cannot be created.
*
- * @param obj The entry object
- * @param func The function called to provide the item object
- * @param data The data passed to @p func
+ * @see elm_web_uri_set()
+ * @see elm_web_webkit_view_get()
*/
- 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);
+ EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
- * This removes a custom item provider to the list for that entry
+ * Get internal ewk_view object from web object.
*
- * This removes the given callback. See elm_entry_item_provider_append() for
- * more information
+ * Elementary may not provide some low level features of EWebKit,
+ * instead of cluttering the API with proxy methods we opted to
+ * return the internal reference. Be careful using it as it may
+ * interfere with elm_web behavior.
*
- * @param obj The entry object
- * @param func The function called to provide the item object
- * @param data The data passed to @p func
+ * @param obj The web object.
+ * @return The internal ewk_view object or NULL if it does not
+ * exist. (Failure to create or Elementary compiled without
+ * ewebkit)
+ *
+ * @see elm_web_add()
*/
- 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);
+ EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Append a filter function for text inserted in the entry
+ * Sets the function to call when a new window is requested
*
- * Append the given callback to the list. This functions will be called
- * whenever any text is inserted into the entry, with the text to be inserted
- * as a parameter. The callback function is free to alter the text in any way
- * it wants, but it must remember to free the given pointer and update it.
- * If the new text is to be discarded, the function can free it and set its
- * text parameter to NULL. This will also prevent any following filters from
- * being called.
+ * This hook will be called when a request to create a new window is
+ * issued from the web page loaded.
+ * There is no default implementation for this feature, so leaving this
+ * unset or passing @c NULL in @p func will prevent new windows from
+ * opening.
*
- * @param obj The entry object
- * @param func The function to use as text filter
- * @param data User data to pass to @p func
+ * @param obj The web object where to set the hook function
+ * @param func The hook function to be called when a window is requested
+ * @param data User data
*/
- EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
+ EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
/**
- * Prepend a filter function for text insdrted in the entry
+ * Sets the function to call when an alert dialog
*
- * Prepend the given callback to the list. See elm_entry_text_filter_append()
- * for more information
+ * This hook will be called when a JavaScript alert dialog is requested.
+ * If no function is set or @c NULL is passed in @p func, the default
+ * implementation will take place.
*
- * @param obj The entry object
- * @param func The function to use as text filter
- * @param data User data to pass to @p func
+ * @param obj The web object where to set the hook function
+ * @param func The callback function to be used
+ * @param data User data
+ *
+ * @see elm_web_inwin_mode_set()
*/
- EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
+ EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
/**
- * Remove a filter from the list
+ * Sets the function to call when an confirm dialog
*
- * Removes the given callback from the filter list. See
- * elm_entry_text_filter_append() for more information.
+ * This hook will be called when a JavaScript confirm dialog is requested.
+ * If no function is set or @c NULL is passed in @p func, the default
+ * implementation will take place.
*
- * @param obj The entry object
- * @param func The filter function to remove
- * @param data The user data passed when adding the function
+ * @param obj The web object where to set the hook function
+ * @param func The callback function to be used
+ * @param data User data
+ *
+ * @see elm_web_inwin_mode_set()
*/
- EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
+ EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
/**
- * This converts a markup (HTML-like) string into UTF-8.
+ * Sets the function to call when an prompt dialog
*
- * The returned string is a malloc'ed buffer and it should be freed when
- * not needed anymore.
+ * This hook will be called when a JavaScript prompt dialog is requested.
+ * If no function is set or @c NULL is passed in @p func, the default
+ * implementation will take place.
*
- * @param s The string (in markup) to be converted
- * @return The converted string (in UTF-8). It should be freed.
+ * @param obj The web object where to set the hook function
+ * @param func The callback function to be used
+ * @param data User data
+ *
+ * @see elm_web_inwin_mode_set()
*/
- EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
+ EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
/**
- * This converts a UTF-8 string into markup (HTML-like).
+ * Sets the function to call when an file selector dialog
*
- * The returned string is a malloc'ed buffer and it should be freed when
- * not needed anymore.
+ * This hook will be called when a JavaScript file selector dialog is
+ * requested.
+ * If no function is set or @c NULL is passed in @p func, the default
+ * implementation will take place.
*
- * @param s The string (in UTF-8) to be converted
- * @return The converted string (in markup). It should be freed.
+ * @param obj The web object where to set the hook function
+ * @param func The callback function to be used
+ * @param data User data
+ *
+ * @see elm_web_inwin_mode_set()
*/
- EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
+ EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
/**
- * This sets the file (and implicitly loads it) for the text to display and
- * then edit. All changes are written back to the file after a short delay if
- * the entry object is set to autosave (which is the default).
+ * Sets the function to call when a console message is emitted from JS
*
- * If the entry had any other file set previously, any changes made to it
- * will be saved if the autosave feature is enabled, otherwise, the file
- * will be silently discarded and any non-saved changes will be lost.
+ * This hook will be called when a console message is emitted from
+ * JavaScript. There is no default implementation for this feature.
*
- * @param obj The entry object
- * @param file The path to the file to load and save
- * @param format The file format
+ * @param obj The web object where to set the hook function
+ * @param func The callback function to be used
+ * @param data User data
*/
- EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
+ EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
/**
- * Gets the file being edited by the entry.
+ * Gets the status of the tab propagation
*
- * This function can be used to retrieve any file set on the entry for
- * edition, along with the format used to load and save it.
+ * @param obj The web object to query
+ * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
*
- * @param obj The entry object
- * @param file The path to the file to load and save
- * @param format The file format
+ * @see elm_web_tab_propagate_set()
*/
- EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
/**
- * This function writes any changes made to the file set with
- * elm_entry_file_set()
+ * Sets whether to use tab propagation
*
- * @param obj The entry object
+ * If tab propagation is enabled, whenever the user presses the Tab key,
+ * Elementary will handle it and switch focus to the next widget.
+ * The default value is disabled, where WebKit will handle the Tab key to
+ * cycle focus though its internal objects, jumping to the next widget
+ * only when that cycle ends.
+ *
+ * @param obj The web object
+ * @param propagate Whether to propagate Tab keys to Elementary or not
*/
- EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
/**
- * This sets the entry object to 'autosave' the loaded text file or not.
+ * Sets the URI for the web object
*
- * @param obj The entry object
- * @param autosave Autosave the loaded file or not
+ * It must be a full URI, with resource included, in the form
+ * http://www.enlightenment.org or file:///tmp/something.html
*
- * @see elm_entry_file_set()
+ * @param obj The web object
+ * @param uri The URI to set
+ * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
*/
- EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
/**
- * This gets the entry object's 'autosave' status.
+ * Gets the current URI for the object
*
- * @param obj The entry object
- * @return Autosave the loaded file or not
+ * The returned string must not be freed and is guaranteed to be
+ * stringshared.
*
- * @see elm_entry_file_set()
+ * @param obj The web object
+ * @return A stringshared internal string with the current URI, or NULL on
+ * failure
*/
- EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_web_uri_get(const Evas_Object *obj);
/**
- * Control pasting of text and images for the widget.
- *
- * Normally the entry allows both text and images to be pasted. By setting
- * textonly to be true, this prevents images from being pasted.
+ * Gets the current title
*
- * Note this only changes the behaviour of text.
+ * The returned string must not be freed and is guaranteed to be
+ * stringshared.
*
- * @param obj The entry object
- * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
- * text+image+other.
+ * @param obj The web object
+ * @return A stringshared internal string with the current title, or NULL on
+ * failure
*/
- EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_web_title_get(const Evas_Object *obj);
/**
- * Getting elm_entry text paste/drop mode.
+ * Sets the background color to be used by the web object
*
- * In textonly mode, only text may be pasted or dropped into the widget.
+ * This is the color that will be used by default when the loaded page
+ * does not set it's own. Color values are pre-multiplied.
*
- * @param obj The entry object
- * @return If the widget only accepts text from pastes.
+ * @param obj The web object
+ * @param r Red component
+ * @param g Green component
+ * @param b Blue component
+ * @param a Alpha component
*/
- EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
/**
- * Enable or disable scrolling in entry
+ * Gets the background color to be used by the web object
*
- * Normally the entry is not scrollable unless you enable it with this call.
+ * This is the color that will be used by default when the loaded page
+ * does not set it's own. Color values are pre-multiplied.
*
- * @param obj The entry object
- * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
+ * @param obj The web object
+ * @param r Red component
+ * @param g Green component
+ * @param b Blue component
+ * @param a Alpha component
*/
- EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
+ EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
/**
- * Get the scrollable state of the entry
+ * Gets a copy of the currently selected text
*
- * Normally the entry is not scrollable. This gets the scrollable state
- * of the entry. See elm_entry_scrollable_set() for more information.
+ * The string returned must be freed by the user when it's done with it.
*
- * @param obj The entry object
- * @return The scrollable state
+ * @param obj The web object
+ * @return A newly allocated string, or NULL if nothing is selected or an
+ * error occurred
*/
- EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
+ EAPI char *elm_view_selection_get(const Evas_Object *obj);
/**
- * This sets a widget to be displayed to the left of a scrolled entry.
+ * Tells the web object which index in the currently open popup was selected
*
- * @param obj The scrolled entry object
- * @param icon The widget to display on the left side of the scrolled
- * entry.
+ * When the user handles the popup creation from the "popup,created" signal,
+ * it needs to tell the web object which item was selected by calling this
+ * function with the index corresponding to the item.
*
- * @note A previously set widget will be destroyed.
- * @note If the object being set does not have minimum size hints set,
- * it won't get properly displayed.
+ * @param obj The web object
+ * @param index The index selected
*
- * @see elm_entry_end_set()
+ * @see elm_web_popup_destroy()
*/
- EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
+ EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
/**
- * Gets the leftmost widget of the scrolled entry. This object is
- * owned by the scrolled entry and should not be modified.
+ * Dismisses an open dropdown popup
*
- * @param obj The scrolled entry object
- * @return the left widget inside the scroller
+ * When the popup from a dropdown widget is to be dismissed, either after
+ * selecting an option or to cancel it, this function must be called, which
+ * will later emit an "popup,willdelete" signal to notify the user that
+ * any memory and objects related to this popup can be freed.
+ *
+ * @param obj The web object
+ * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
+ * if there was no menu to destroy
*/
- EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
+ EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
/**
- * Unset the leftmost widget of the scrolled entry, unparenting and
- * returning it.
+ * Searches the given string in a document.
*
- * @param obj The scrolled entry object
- * @return the previously set icon sub-object of this entry, on
- * success.
+ * @param obj The web object where to search the text
+ * @param string String to search
+ * @param case_sensitive If search should be case sensitive or not
+ * @param forward If search is from cursor and on or backwards
+ * @param wrap If search should wrap at the end
*
- * @see elm_entry_icon_set()
+ * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
+ * or failure
*/
- EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
+ EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
/**
- * Sets the visibility of the left-side widget of the scrolled entry,
- * set by @elm_entry_icon_set().
+ * Marks matches of the given string in a document.
*
- * @param obj The scrolled entry object
- * @param setting EINA_TRUE if the object should be displayed,
- * EINA_FALSE if not.
+ * @param obj The web object where to search text
+ * @param string String to match
+ * @param case_sensitive If match should be case sensitive or not
+ * @param highlight If matches should be highlighted
+ * @param limit Maximum amount of matches, or zero to unlimited
+ *
+ * @return number of matched @a string
*/
- EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
+ EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
/**
- * This sets a widget to be displayed to the end of a scrolled entry.
- *
- * @param obj The scrolled entry object
- * @param end The widget to display on the right side of the scrolled
- * entry.
+ * Clears all marked matches in the document
*
- * @note A previously set widget will be destroyed.
- * @note If the object being set does not have minimum size hints set,
- * it won't get properly displayed.
+ * @param obj The web object
*
- * @see elm_entry_icon_set
+ * @return EINA_TRUE on success, EINA_FALSE otherwise
*/
- EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
+ EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
/**
- * Gets the endmost widget of the scrolled entry. This object is owned
- * by the scrolled entry and should not be modified.
+ * Sets whether to highlight the matched marks
*
- * @param obj The scrolled entry object
- * @return the right widget inside the scroller
+ * If enabled, marks set with elm_web_text_matches_mark() will be
+ * highlighted.
+ *
+ * @param obj The web object
+ * @param highlight Whether to highlight the marks or not
+ *
+ * @return EINA_TRUE on success, EINA_FALSE otherwise
*/
- EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
+ EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
/**
- * Unset the endmost widget of the scrolled entry, unparenting and
- * returning it.
+ * Gets whether highlighting marks is enabled
*
- * @param obj The scrolled entry object
- * @return the previously set icon sub-object of this entry, on
- * success.
+ * @param The web object
*
- * @see elm_entry_icon_set()
+ * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
+ * otherwise
*/
- EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
+ EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
/**
- * Sets the visibility of the end widget of the scrolled entry, set by
- * @elm_entry_end_set().
+ * Gets the overall loading progress of the page
*
- * @param obj The scrolled entry object
- * @param setting EINA_TRUE if the object should be displayed,
- * EINA_FALSE if not.
+ * Returns the estimated loading progress of the page, with a value between
+ * 0.0 and 1.0. This is an estimated progress accounting for all the frames
+ * included in the page.
+ *
+ * @param The web object
+ *
+ * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
+ * failure
*/
- EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
+ EAPI double elm_web_load_progress_get(const Evas_Object *obj);
/**
- * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
- * them).
+ * Stops loading the current page
*
- * Setting an entry to single-line mode with elm_entry_single_line_set()
- * will automatically disable the display of scrollbars when the entry
- * moves inside its scroller.
+ * Cancels the loading of the current page in the web object. This will
+ * cause a "load,error" signal to be emitted, with the is_cancellation
+ * flag set to EINA_TRUE.
*
- * @param obj The scrolled entry object
- * @param h The horizontal scrollbar policy to apply
- * @param v The vertical scrollbar policy to apply
+ * @param obj The web object
+ *
+ * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
*/
- EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
+ EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
/**
- * This enables/disables bouncing within the entry.
+ * Requests a reload of the current document in the object
*
- * This function sets whether the entry will bounce when scrolling reaches
- * the end of the contained entry.
+ * @param obj The web object
*
- * @param obj The scrolled entry object
- * @param h The horizontal bounce state
- * @param v The vertical bounce state
+ * @return EINA_TRUE on success, EINA_FALSE otherwise
*/
- EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
+ EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
/**
- * Get the bounce mode
+ * Requests a reload of the current document, avoiding any existing caches
*
- * @param obj The Entry object
- * @param h_bounce Allow bounce horizontally
- * @param v_bounce Allow bounce vertically
+ * @param obj The web object
+ *
+ * @return EINA_TRUE on success, EINA_FALSE otherwise
*/
- EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
-
- /* pre-made filters for entries */
+ EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
/**
- * @typedef Elm_Entry_Filter_Limit_Size
+ * Goes back one step in the browsing history
+ *
+ * This is equivalent to calling elm_web_object_navigate(obj, -1);
*
- * Data for the elm_entry_filter_limit_size() entry filter.
+ * @param obj The web object
+ *
+ * @return EINA_TRUE on success, EINA_FALSE otherwise
+ *
+ * @see elm_web_history_enable_set()
+ * @see elm_web_back_possible()
+ * @see elm_web_forward()
+ * @see elm_web_navigate()
*/
- typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
+ EAPI Eina_Bool elm_web_back(Evas_Object *obj);
/**
- * @struct _Elm_Entry_Filter_Limit_Size
+ * Goes forward one step in the browsing history
*
- * Data for the elm_entry_filter_limit_size() entry filter.
+ * This is equivalent to calling elm_web_object_navigate(obj, 1);
+ *
+ * @param obj The web object
+ *
+ * @return EINA_TRUE on success, EINA_FALSE otherwise
+ *
+ * @see elm_web_history_enable_set()
+ * @see elm_web_forward_possible()
+ * @see elm_web_back()
+ * @see elm_web_navigate()
*/
- struct _Elm_Entry_Filter_Limit_Size
- {
- int max_char_count; /**< The maximum number of characters allowed. */
- int max_byte_count; /**< The maximum number of bytes allowed*/
- };
+ EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
/**
- * Filter inserted text based on user defined character and byte limits
+ * Jumps the given number of steps in the browsing history
*
- * Add this filter to an entry to limit the characters that it will accept
- * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
- * The funtion works on the UTF-8 representation of the string, converting
- * it from the set markup, thus not accounting for any format in it.
+ * The @p steps value can be a negative integer to back in history, or a
+ * positive to move forward.
*
- * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
- * it as data when setting the filter. In it, it's possible to set limits
- * by character count or bytes (any of them is disabled if 0), and both can
- * be set at the same time. In that case, it first checks for characters,
- * then bytes.
+ * @param obj The web object
+ * @param steps The number of steps to jump
*
- * The function will cut the inserted text in order to allow only the first
- * number of characters that are still allowed. The cut is made in
- * characters, even when limiting by bytes, in order to always contain
- * valid ones and avoid half unicode characters making it in.
+ * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
+ * history exists to jump the given number of steps
*
- * This filter, like any others, does not apply when setting the entry text
- * directly with elm_object_text_set() (or the deprecated
- * elm_entry_entry_set()).
+ * @see elm_web_history_enable_set()
+ * @see elm_web_navigate_possible()
+ * @see elm_web_back()
+ * @see elm_web_forward()
*/
- EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
+ EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
/**
- * @typedef Elm_Entry_Filter_Accept_Set
+ * Queries whether it's possible to go back in history
*
- * Data for the elm_entry_filter_accept_set() entry filter.
+ * @param obj The web object
+ *
+ * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
+ * otherwise
*/
- typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
+ EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
/**
- * @struct _Elm_Entry_Filter_Accept_Set
+ * Queries whether it's possible to go forward in history
*
- * Data for the elm_entry_filter_accept_set() entry filter.
+ * @param obj The web object
+ *
+ * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
+ * otherwise
*/
- struct _Elm_Entry_Filter_Accept_Set
- {
- const char *accepted; /**< Set of characters accepted in the entry. */
- const char *rejected; /**< Set of characters rejected from the entry. */
- };
+ EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
/**
- * Filter inserted text based on accepted or rejected sets of characters
- *
- * Add this filter to an entry to restrict the set of accepted characters
- * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
- * This structure contains both accepted and rejected sets, but they are
- * mutually exclusive.
+ * Queries whether it's possible to jump the given number of steps
*
- * The @c accepted set takes preference, so if it is set, the filter will
- * only work based on the accepted characters, ignoring anything in the
- * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
+ * The @p steps value can be a negative integer to back in history, or a
+ * positive to move forward.
*
- * In both cases, the function filters by matching utf8 characters to the
- * raw markup text, so it can be used to remove formatting tags.
+ * @param obj The web object
+ * @param steps The number of steps to check for
*
- * This filter, like any others, does not apply when setting the entry text
- * directly with elm_object_text_set() (or the deprecated
- * elm_entry_entry_set()).
+ * @return EINA_TRUE if enough history exists to perform the given jump,
+ * EINA_FALSE otherwise
*/
- EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
+ EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
/**
- * @}
+ * Gets whether browsing history is enabled for the given object
+ *
+ * @param obj The web object
+ *
+ * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
*/
-
- /* composite widgets - these basically put together basic widgets above
- * in convenient packages that do more than basic stuff */
-
- /* anchorview */
+ EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
/**
- * @defgroup Anchorview Anchorview
+ * Enables or disables the browsing history
*
- * @image html img/widget/anchorview/preview-00.png
- * @image latex img/widget/anchorview/preview-00.eps
+ * @param obj The web object
+ * @param enable Whether to enable or disable the browsing history
+ */
+ EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
+ /**
+ * Gets whether text-only zoom is set
*
- * Anchorview is for displaying text that contains markup with anchors
- * like <c>\<a href=1234\>something\</\></c> in it.
+ * @param obj The web object
*
- * Besides being styled differently, the anchorview widget provides the
- * necessary functionality so that clicking on these anchors brings up a
- * popup with user defined content such as "call", "add to contacts" or
- * "open web page". This popup is provided using the @ref Hover widget.
+ * @return EINA_TRUE if zoom is set to affect only text, EINA_FALSE
+ * otherwise
*
- * This widget is very similar to @ref Anchorblock, so refer to that
- * widget for an example. The only difference Anchorview has is that the
- * widget is already provided with scrolling functionality, so if the
- * text set to it is too large to fit in the given space, it will scroll,
- * whereas the @ref Anchorblock widget will keep growing to ensure all the
- * text can be displayed.
+ * @see elm_web_zoom_text_only_set()
+ */
+ EAPI Eina_Bool elm_web_zoom_text_only_get(const Evas_Object *obj);
+ /**
+ * Enables or disables zoom to affect only text
*
- * This widget emits the following signals:
- * @li "anchor,clicked": will be called when an anchor is clicked. The
- * @p event_info parameter on the callback will be a pointer of type
- * ::Elm_Entry_Anchorview_Info.
+ * If set, then the zoom level set to the page will only be applied on text,
+ * leaving other objects, such as images, at their original size.
*
- * See @ref Anchorblock for an example on how to use both of them.
+ * @param obj The web object
+ * @param setting EINA_TRUE to use text-only zoom, EINA_FALSE to have zoom
+ * affect the entire page
+ */
+ EAPI void elm_web_zoom_text_only_set(Evas_Object *obj, Eina_Bool setting);
+ /**
+ * Sets the default dialogs to use an Inwin instead of a normal window
*
- * @see Anchorblock
- * @see Entry
- * @see Hover
+ * If set, then the default implementation for the JavaScript dialogs and
+ * file selector will be opened in an Inwin. Otherwise they will use a
+ * normal separated window.
*
- * @{
+ * @param obj The web object
+ * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
*/
+ EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
/**
- * @typedef Elm_Entry_Anchorview_Info
+ * Gets whether Inwin mode is set for the current object
*
- * The info sent in the callback for "anchor,clicked" signals emitted by
- * the Anchorview widget.
+ * @param obj The web object
+ *
+ * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
*/
- typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
+ EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
+
+ EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
+ EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
+ EAPI void elm_web_window_features_bool_property_get(const Elm_Web_Window_Features *wf, Eina_Bool *toolbar_visible, Eina_Bool *statusbar_visible, Eina_Bool *scrollbars_visible, Eina_Bool *menubar_visible, Eina_Bool *locationbar_visble, Eina_Bool *fullscreen);
+ EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
+
/**
- * @struct _Elm_Entry_Anchorview_Info
- *
- * The info sent in the callback for "anchor,clicked" signals emitted by
- * the Anchorview widget.
+ * @}
*/
- struct _Elm_Entry_Anchorview_Info
- {
- const char *name; /**< Name of the anchor, as indicated in its href
- attribute */
- int button; /**< The mouse button used to click on it */
- Evas_Object *hover; /**< The hover object to use for the popup */
- struct {
- Evas_Coord x, y, w, h;
- } anchor, /**< Geometry selection of text used as anchor */
- hover_parent; /**< Geometry of the object used as parent by the
- hover */
- Eina_Bool hover_left : 1; /**< Hint indicating if there's space
- for content on the left side of
- the hover. Before calling the
- callback, the widget will make the
- necessary calculations to check
- which sides are fit to be set with
- content, based on the position the
- hover is activated and its distance
- to the edges of its parent object
- */
- Eina_Bool hover_right : 1; /**< Hint indicating content fits on
- the right side of the hover.
- See @ref hover_left */
- Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
- of the hover. See @ref hover_left */
- Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
- below the hover. See @ref
- hover_left */
- };
+
/**
- * Add a new Anchorview object
+ * @defgroup Hoversel Hoversel
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @image html img/widget/hoversel/preview-00.png
+ * @image latex img/widget/hoversel/preview-00.eps
+ *
+ * A hoversel is a button that pops up a list of items (automatically
+ * choosing the direction to display) that have a label and, optionally, an
+ * icon to select from. It is a convenience widget to avoid the need to do
+ * all the piecing together yourself. It is intended for a small number of
+ * items in the hoversel menu (no more than 8), though is capable of many
+ * more.
+ *
+ * Signals that you can add callbacks for are:
+ * "clicked" - the user clicked the hoversel button and popped up the sel
+ * "selected" - an item in the hoversel list is selected. event_info is the item
+ * "dismissed" - the hover is dismissed
+ *
+ * See @ref tutorial_hoversel for an example.
+ * @{
*/
- EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
/**
- * Set the text to show in the anchorview
- *
- * Sets the text of the anchorview to @p text. This text can include markup
- * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
- * text that will be specially styled and react to click events, ended with
- * either of \</a\> or \</\>. When clicked, the anchor will emit an
- * "anchor,clicked" signal that you can attach a callback to with
- * evas_object_smart_callback_add(). The name of the anchor given in the
- * event info struct will be the one set in the href attribute, in this
- * case, anchorname.
+ * @brief Add a new Hoversel object
*
- * Other markup can be used to style the text in different ways, but it's
- * up to the style defined in the theme which tags do what.
- * @deprecated use elm_object_text_set() instead.
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
*/
- EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Get the markup text set for the anchorview
+ * @brief This sets the hoversel to expand horizontally.
*
- * Retrieves the text set on the anchorview, with markup tags included.
+ * @param obj The hoversel object
+ * @param horizontal If true, the hover will expand horizontally to the
+ * right.
*
- * @param obj The anchorview object
- * @return The markup text set or @c NULL if nothing was set or an error
- * occurred
- * @deprecated use elm_object_text_set() instead.
+ * @note The initial button will display horizontally regardless of this
+ * setting.
*/
- EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
/**
- * Set the parent of the hover popup
+ * @brief This returns whether the hoversel is set to expand horizontally.
*
- * Sets the parent object to use by the hover created by the anchorview
- * when an anchor is clicked. See @ref Hover for more details on this.
- * If no parent is set, the same anchorview object will be used.
+ * @param obj The hoversel object
+ * @return If true, the hover will expand horizontally to the right.
*
- * @param obj The anchorview object
- * @param parent The object to use as parent for the hover
+ * @see elm_hoversel_horizontal_set()
*/
- EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the parent of the hover popup
+ * @brief Set the Hover parent
*
- * Get the object used as parent for the hover created by the anchorview
- * widget. See @ref Hover for more details on this.
+ * @param obj The hoversel object
+ * @param parent The parent to use
*
- * @param obj The anchorview object
- * @return The object used as parent for the hover, NULL if none is set.
+ * Sets the hover parent object, the area that will be darkened when the
+ * hoversel is clicked. Should probably be the window that the hoversel is
+ * in. See @ref Hover objects for more information.
*/
- EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Set the style that the hover should use
+ * @brief Get the Hover parent
*
- * When creating the popup hover, anchorview will request that it's
- * themed according to @p style.
+ * @param obj The hoversel object
+ * @return The used parent
*
- * @param obj The anchorview object
- * @param style The style to use for the underlying hover
+ * Gets the hover parent object.
*
- * @see elm_object_style_set()
+ * @see elm_hoversel_hover_parent_set()
*/
- EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the style that the hover should use
+ * @brief Set the hoversel button label
*
- * Get the style the hover created by anchorview will use.
+ * @param obj The hoversel object
+ * @param label The label text.
*
- * @param obj The anchorview object
- * @return The style to use by the hover. NULL means the default is used.
+ * This sets the label of the button that is always visible (before it is
+ * clicked and expanded).
*
- * @see elm_object_style_set()
+ * @deprecated elm_object_text_set()
*/
- EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
/**
- * Ends the hover popup in the anchorview
+ * @brief Get the hoversel button label
*
- * When an anchor is clicked, the anchorview widget will create a hover
- * object to use as a popup with user provided content. This function
- * terminates this popup, returning the anchorview to its normal state.
+ * @param obj The hoversel object
+ * @return The label text.
*
- * @param obj The anchorview object
+ * @deprecated elm_object_text_get()
*/
- EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set bouncing behaviour when the scrolled content reaches an edge
+ * @brief Set the icon of the hoversel button
*
- * Tell the internal scroller object whether it should bounce or not
- * when it reaches the respective edges for each axis.
+ * @param obj The hoversel object
+ * @param icon The icon object
*
- * @param obj The anchorview object
- * @param h_bounce Whether to bounce or not in the horizontal axis
- * @param v_bounce Whether to bounce or not in the vertical axis
+ * Sets the icon of the button that is always visible (before it is clicked
+ * and expanded). Once the icon object is set, a previously set one will be
+ * deleted, if you want to keep that old content object, use the
+ * elm_hoversel_icon_unset() function.
*
- * @see elm_scroller_bounce_set()
+ * @see elm_button_icon_set()
*/
- EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+ EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
/**
- * Get the set bouncing behaviour of the internal scroller
+ * @brief Get the icon of the hoversel button
*
- * Get whether the internal scroller should bounce when the edge of each
- * axis is reached scrolling.
+ * @param obj The hoversel object
+ * @return The icon object
*
- * @param obj The anchorview object
- * @param h_bounce Pointer where to store the bounce state of the horizontal
- * axis
- * @param v_bounce Pointer where to store the bounce state of the vertical
- * axis
+ * Get the icon of the button that is always visible (before it is clicked
+ * and expanded). Also see elm_button_icon_get().
*
- * @see elm_scroller_bounce_get()
+ * @see elm_hoversel_icon_set()
*/
- EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Appends a custom item provider to the given anchorview
- *
- * Appends the given function to the list of items providers. This list is
- * called, one function at a time, with the given @p data pointer, the
- * anchorview object and, in the @p item parameter, the item name as
- * referenced in its href string. Following functions in the list will be
- * called in order until one of them returns something different to NULL,
- * which should be an Evas_Object which will be used in place of the item
- * element.
+ * @brief Get and unparent the icon of the hoversel button
*
- * Items in the markup text take the form \<item relsize=16x16 vsize=full
- * href=item/name\>\</item\>
+ * @param obj The hoversel object
+ * @return The icon object that was being used
*
- * @param obj The anchorview object
- * @param func The function to add to the list of providers
- * @param data User data that will be passed to the callback function
+ * Unparent and return the icon of the button that is always visible
+ * (before it is clicked and expanded).
*
- * @see elm_entry_item_provider_append()
+ * @see elm_hoversel_icon_set()
+ * @see elm_button_icon_unset()
*/
- 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);
+ EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Prepend a custom item provider to the given anchorview
- *
- * Like elm_anchorview_item_provider_append(), but it adds the function
- * @p func to the beginning of the list, instead of the end.
+ * @brief This triggers the hoversel popup from code, the same as if the user
+ * had clicked the button.
*
- * @param obj The anchorview object
- * @param func The function to add to the list of providers
- * @param data User data that will be passed to the callback function
+ * @param obj The hoversel object
*/
- 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);
+ EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Remove a custom item provider from the list of the given anchorview
- *
- * Removes the function and data pairing that matches @p func and @p data.
- * That is, unless the same function and same user data are given, the
- * function will not be removed from the list. This allows us to add the
- * same callback several times, with different @p data pointers and be
- * able to remove them later without conflicts.
+ * @brief This dismisses the hoversel popup as if the user had clicked
+ * outside the hover.
*
- * @param obj The anchorview object
- * @param func The function to remove from the list
- * @param data The data matching the function to remove from the list
+ * @param obj The hoversel object
*/
- 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);
+ EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @}
+ * @brief Returns whether the hoversel is expanded.
+ *
+ * @param obj The hoversel object
+ * @return This will return EINA_TRUE if the hoversel is expanded or
+ * EINA_FALSE if it is not expanded.
*/
-
- /* anchorblock */
+ EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @defgroup Anchorblock Anchorblock
- *
- * @image html img/widget/anchorblock/preview-00.png
- * @image latex img/widget/anchorblock/preview-00.eps
+ * @brief This will remove all the children items from the hoversel.
*
- * Anchorblock is for displaying text that contains markup with anchors
- * like <c>\<a href=1234\>something\</\></c> in it.
+ * @param obj The hoversel object
*
- * Besides being styled differently, the anchorblock widget provides the
- * necessary functionality so that clicking on these anchors brings up a
- * popup with user defined content such as "call", "add to contacts" or
- * "open web page". This popup is provided using the @ref Hover widget.
+ * @warning Should @b not be called while the hoversel is active; use
+ * elm_hoversel_expanded_get() to check first.
*
- * This widget emits the following signals:
- * @li "anchor,clicked": will be called when an anchor is clicked. The
- * @p event_info parameter on the callback will be a pointer of type
- * ::Elm_Entry_Anchorblock_Info.
+ * @see elm_hoversel_item_del_cb_set()
+ * @see elm_hoversel_item_del()
+ */
+ EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the list of items within the given hoversel.
*
- * @see Anchorview
- * @see Entry
- * @see Hover
+ * @param obj The hoversel object
+ * @return Returns a list of Elm_Hoversel_Item*
*
- * Since examples are usually better than plain words, we might as well
- * try @ref tutorial_anchorblock_example "one".
+ * @see elm_hoversel_item_add()
*/
+ EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @addtogroup Anchorblock
- * @{
+ * @brief Add an item to the hoversel button
+ *
+ * @param obj The hoversel object
+ * @param label The text label to use for the item (NULL if not desired)
+ * @param icon_file An image file path on disk to use for the icon or standard
+ * icon name (NULL if not desired)
+ * @param icon_type The icon type if relevant
+ * @param func Convenience function to call when this item is selected
+ * @param data Data to pass to item-related functions
+ * @return A handle to the item added.
+ *
+ * This adds an item to the hoversel to show when it is clicked. Note: if you
+ * need to use an icon from an edje file then use
+ * elm_hoversel_item_icon_set() right after the this function, and set
+ * icon_file to NULL here.
+ *
+ * For more information on what @p icon_file and @p icon_type are see the
+ * @ref Icon "icon documentation".
*/
+ 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);
/**
- * @typedef Elm_Entry_Anchorblock_Info
+ * @brief Delete an item from the hoversel
*
- * The info sent in the callback for "anchor,clicked" signals emitted by
- * the Anchorblock widget.
+ * @param item The item to delete
+ *
+ * This deletes the item from the hoversel (should not be called while the
+ * hoversel is active; use elm_hoversel_expanded_get() to check first).
+ *
+ * @see elm_hoversel_item_add()
+ * @see elm_hoversel_item_del_cb_set()
*/
- typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
+ EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
/**
- * @struct _Elm_Entry_Anchorblock_Info
+ * @brief Set the function to be called when an item from the hoversel is
+ * freed.
*
- * The info sent in the callback for "anchor,clicked" signals emitted by
- * the Anchorblock widget.
+ * @param item The item to set the callback on
+ * @param func The function called
+ *
+ * That function will receive these parameters:
+ * @li void *item_data
+ * @li Evas_Object *the_item_object
+ * @li Elm_Hoversel_Item *the_object_struct
+ *
+ * @see elm_hoversel_item_add()
*/
- struct _Elm_Entry_Anchorblock_Info
- {
- const char *name; /**< Name of the anchor, as indicated in its href
- attribute */
- int button; /**< The mouse button used to click on it */
- Evas_Object *hover; /**< The hover object to use for the popup */
- struct {
- Evas_Coord x, y, w, h;
- } anchor, /**< Geometry selection of text used as anchor */
- hover_parent; /**< Geometry of the object used as parent by the
- hover */
- Eina_Bool hover_left : 1; /**< Hint indicating if there's space
- for content on the left side of
- the hover. Before calling the
- callback, the widget will make the
- necessary calculations to check
- which sides are fit to be set with
- content, based on the position the
- hover is activated and its distance
- to the edges of its parent object
- */
- Eina_Bool hover_right : 1; /**< Hint indicating content fits on
- the right side of the hover.
- See @ref hover_left */
- Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
- of the hover. See @ref hover_left */
- Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
- below the hover. See @ref
- hover_left */
- };
+ EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
/**
- * Add a new Anchorblock object
+ * @brief This returns the data pointer supplied with elm_hoversel_item_add()
+ * that will be passed to associated function callbacks.
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @param item The item to get the data from
+ * @return The data pointer set with elm_hoversel_item_add()
+ *
+ * @see elm_hoversel_item_add()
*/
- EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
/**
- * Set the text to show in the anchorblock
+ * @brief This returns the label text of the given hoversel item.
*
- * Sets the text of the anchorblock to @p text. This text can include markup
- * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
- * of text that will be specially styled and react to click events, ended
- * with either of \</a\> or \</\>. When clicked, the anchor will emit an
- * "anchor,clicked" signal that you can attach a callback to with
- * evas_object_smart_callback_add(). The name of the anchor given in the
- * event info struct will be the one set in the href attribute, in this
- * case, anchorname.
+ * @param item The item to get the label
+ * @return The label text of the hoversel item
*
- * Other markup can be used to style the text in different ways, but it's
- * up to the style defined in the theme which tags do what.
- * @deprecated use elm_object_text_set() instead.
+ * @see elm_hoversel_item_add()
*/
- EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
/**
- * Get the markup text set for the anchorblock
+ * @brief This sets the icon for the given hoversel item.
*
- * Retrieves the text set on the anchorblock, with markup tags included.
+ * @param item The item to set the icon
+ * @param icon_file An image file path on disk to use for the icon or standard
+ * icon name
+ * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
+ * to NULL if the icon is not an edje file
+ * @param icon_type The icon type
*
- * @param obj The anchorblock object
- * @return The markup text set or @c NULL if nothing was set or an error
- * occurred
- * @deprecated use elm_object_text_set() instead.
+ * The icon can be loaded from the standard set, from an image file, or from
+ * an edje file.
+ *
+ * @see elm_hoversel_item_add()
*/
- EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ 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);
/**
- * Set the parent of the hover popup
+ * @brief Get the icon object of the hoversel item
*
- * Sets the parent object to use by the hover created by the anchorblock
- * when an anchor is clicked. See @ref Hover for more details on this.
+ * @param item The item to get the icon from
+ * @param icon_file The image file path on disk used for the icon or standard
+ * icon name
+ * @param icon_group The edje group used if @p icon_file is an edje file. NULL
+ * if the icon is not an edje file
+ * @param icon_type The icon type
*
- * @param obj The anchorblock object
- * @param parent The object to use as parent for the hover
+ * @see elm_hoversel_item_icon_set()
+ * @see elm_hoversel_item_add()
*/
- EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+ 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);
/**
- * Get the parent of the hover popup
- *
- * Get the object used as parent for the hover created by the anchorblock
- * widget. See @ref Hover for more details on this.
- * If no parent is set, the same anchorblock object will be used.
- *
- * @param obj The anchorblock object
- * @return The object used as parent for the hover, NULL if none is set.
+ * @}
*/
- EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set the style that the hover should use
+ * @defgroup Toolbar Toolbar
+ * @ingroup Elementary
*
- * When creating the popup hover, anchorblock will request that it's
- * themed according to @p style.
+ * @image html img/widget/toolbar/preview-00.png
+ * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
*
- * @param obj The anchorblock object
- * @param style The style to use for the underlying hover
+ * @image html img/toolbar.png
+ * @image latex img/toolbar.eps width=\textwidth
*
- * @see elm_object_style_set()
- */
- EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
- /**
- * Get the style that the hover should use
+ * A toolbar is a widget that displays a list of items inside
+ * a box. It can be scrollable, show a menu with items that don't fit
+ * to toolbar size or even crop them.
*
- * Get the style the hover created by anchorblock will use.
+ * Only one item can be selected at a time.
*
- * @param obj The anchorblock object
- * @return The style to use by the hover. NULL means the default is used.
+ * Items can have multiple states, or show menus when selected by the user.
*
- * @see elm_object_style_set()
- */
- EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Ends the hover popup in the anchorblock
+ * Smart callbacks one can listen to:
+ * - "clicked" - when the user clicks on a toolbar item and becomes selected.
*
- * When an anchor is clicked, the anchorblock widget will create a hover
- * object to use as a popup with user provided content. This function
- * terminates this popup, returning the anchorblock to its normal state.
+ * Available styles for it:
+ * - @c "default"
+ * - @c "transparent" - no background or shadow, just show the content
*
- * @param obj The anchorblock object
+ * List of examples:
+ * @li @ref toolbar_example_01
+ * @li @ref toolbar_example_02
+ * @li @ref toolbar_example_03
*/
- EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Appends a custom item provider to the given anchorblock
+ * @addtogroup Toolbar
+ * @{
+ */
+
+ /**
+ * @enum _Elm_Toolbar_Shrink_Mode
+ * @typedef Elm_Toolbar_Shrink_Mode
*
- * Appends the given function to the list of items providers. This list is
- * called, one function at a time, with the given @p data pointer, the
- * anchorblock object and, in the @p item parameter, the item name as
- * referenced in its href string. Following functions in the list will be
- * called in order until one of them returns something different to NULL,
- * which should be an Evas_Object which will be used in place of the item
- * element.
+ * Set toolbar's items display behavior, it can be scrollabel,
+ * show a menu with exceeding items, or simply hide them.
*
- * Items in the markup text take the form \<item relsize=16x16 vsize=full
- * href=item/name\>\</item\>
+ * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
+ * from elm config.
*
- * @param obj The anchorblock object
- * @param func The function to add to the list of providers
- * @param data User data that will be passed to the callback function
+ * Values <b> don't </b> work as bitmask, only one can be choosen.
*
- * @see elm_entry_item_provider_append()
+ * @see elm_toolbar_mode_shrink_set()
+ * @see elm_toolbar_mode_shrink_get()
+ *
+ * @ingroup Toolbar
*/
- 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);
+ typedef enum _Elm_Toolbar_Shrink_Mode
+ {
+ ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
+ ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
+ ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
+ ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
+ } Elm_Toolbar_Shrink_Mode;
+
+ typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item. Can be created with elm_toolbar_item_append(), elm_toolbar_item_prepend() and functions to add items in relative positions, like elm_toolbar_item_insert_before(), and deleted with elm_toolbar_item_del(). */
+
+ typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /**< State of a Elm_Toolbar_Item. Can be created with elm_toolbar_item_state_add() and removed with elm_toolbar_item_state_del(). */
+
/**
- * Prepend a custom item provider to the given anchorblock
+ * Add a new toolbar widget to the given parent Elementary
+ * (container) object.
*
- * Like elm_anchorblock_item_provider_append(), but it adds the function
- * @p func to the beginning of the list, instead of the end.
+ * @param parent The parent object.
+ * @return a new toolbar widget handle or @c NULL, on errors.
*
- * @param obj The anchorblock object
- * @param func The function to add to the list of providers
- * @param data User data that will be passed to the callback function
+ * This function inserts a new toolbar widget on the canvas.
+ *
+ * @ingroup Toolbar
*/
- 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);
+ EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
- * Remove a custom item provider from the list of the given anchorblock
+ * Set the icon size, in pixels, to be used by toolbar items.
*
- * Removes the function and data pairing that matches @p func and @p data.
- * That is, unless the same function and same user data are given, the
- * function will not be removed from the list. This allows us to add the
- * same callback several times, with different @p data pointers and be
- * able to remove them later without conflicts.
+ * @param obj The toolbar object
+ * @param icon_size The icon size in pixels
*
- * @param obj The anchorblock object
- * @param func The function to remove from the list
- * @param data The data matching the function to remove from the list
- */
- 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);
- /**
- * @}
+ * @note Default value is @c 32. It reads value from elm config.
+ *
+ * @see elm_toolbar_icon_size_get()
+ *
+ * @ingroup Toolbar
*/
+ EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
/**
- * @defgroup Bubble Bubble
+ * Get the icon size, in pixels, to be used by toolbar items.
*
- * @image html img/widget/bubble/preview-00.png
- * @image html img/widget/bubble/preview-01.png
- * @image html img/widget/bubble/preview-02.png
+ * @param obj The toolbar object.
+ * @return The icon size in pixels.
*
- * @brief The Bubble is a widget to show text similarly to how speech is
- * represented in comics.
+ * @see elm_toolbar_icon_size_set() for details.
*
- * The bubble widget contains 5 important visual elements:
- * @li The frame is a rectangle with rounded rectangles and an "arrow".
- * @li The @p icon is an image to which the frame's arrow points to.
- * @li The @p label is a text which appears to the right of the icon if the
- * corner is "top_left" or "bottom_left" and is right aligned to the frame
- * otherwise.
- * @li The @p info is a text which appears to the right of the label. Info's
- * font is of a ligther color than label.
- * @li The @p content is an evas object that is shown inside the frame.
+ * @ingroup Toolbar
+ */
+ EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Sets icon lookup order, for toolbar items' icons.
*
- * The position of the arrow, icon, label and info depends on which corner is
- * selected. The four available corners are:
- * @li "top_left" - Default
- * @li "top_right"
- * @li "bottom_left"
- * @li "bottom_right"
+ * @param obj The toolbar object.
+ * @param order The icon lookup order.
*
- * Signals that you can add callbacks for are:
- * @li "clicked" - This is called when a user has clicked the bubble.
+ * Icons added before calling this function will not be affected.
+ * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
*
- * For an example of using a buble see @ref bubble_01_example_page "this".
+ * @see elm_toolbar_icon_order_lookup_get()
*
- * @{
+ * @ingroup Toolbar
*/
+ EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
+
/**
- * Add a new bubble to the parent
+ * Gets the icon lookup order.
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @param obj The toolbar object.
+ * @return The icon lookup order.
*
- * This function adds a text bubble to the given parent evas object.
+ * @see elm_toolbar_icon_order_lookup_set() for details.
+ *
+ * @ingroup Toolbar
*/
- EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set the label of the bubble
+ * Set whether the toolbar should always have an item selected.
*
- * @param obj The bubble object
- * @param label The string to set in the label
+ * @param obj The toolbar object.
+ * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
+ * disable it.
*
- * This function sets the title of the bubble. Where this appears depends on
- * the selected corner.
- * @deprecated use elm_object_text_set() instead.
- */
- EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
- /**
- * Get the label of the bubble
+ * This will cause the toolbar to always have an item selected, and clicking
+ * the selected item will not cause a selected event to be emitted. Enabling this mode
+ * will immediately select the first toolbar item.
*
- * @param obj The bubble object
- * @return The string of set in the label
+ * Always-selected is disabled by default.
*
- * This function gets the title of the bubble.
- * @deprecated use elm_object_text_set() instead.
+ * @see elm_toolbar_always_select_mode_get().
+ *
+ * @ingroup Toolbar
*/
- EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
+
/**
- * Set the info of the bubble
+ * Get whether the toolbar should always have an item selected.
*
- * @param obj The bubble object
- * @param info The given info about the bubble
+ * @param obj The toolbar object.
+ * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
+ * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
*
- * This function sets the info of the bubble. Where this appears depends on
- * the selected corner.
- * @deprecated use elm_object_text_set() instead.
+ * @see elm_toolbar_always_select_mode_set() for details.
+ *
+ * @ingroup Toolbar
*/
- EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the info of the bubble
+ * Set whether the toolbar items' should be selected by the user or not.
*
- * @param obj The bubble object
+ * @param obj The toolbar object.
+ * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
+ * enable it.
*
- * @return The "info" string of the bubble
+ * This will turn off the ability to select items entirely and they will
+ * neither appear selected nor emit selected signals. The clicked
+ * callback function will still be called.
*
- * This function gets the info text.
- * @deprecated use elm_object_text_set() instead.
+ * Selection is enabled by default.
+ *
+ * @see elm_toolbar_no_select_mode_get().
+ *
+ * @ingroup Toolbar
*/
- EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
+
/**
- * Set the content to be shown in the bubble
+ * Set whether the toolbar items' should be selected by the user or not.
*
- * Once the content object is set, a previously set one will be deleted.
- * If you want to keep the old content object, use the
- * elm_bubble_content_unset() function.
+ * @param obj The toolbar object.
+ * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
+ * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
*
- * @param obj The bubble object
- * @param content The given content of the bubble
+ * @see elm_toolbar_no_select_mode_set() for details.
*
- * This function sets the content shown on the middle of the bubble.
+ * @ingroup Toolbar
*/
- EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the content shown in the bubble
+ * Append item to the toolbar.
*
- * Return the content object which is set for this widget.
+ * @param obj The toolbar object.
+ * @param icon A string with icon name or the absolute path of an image file.
+ * @param label The label of the item.
+ * @param func The function to call when the item is clicked.
+ * @param data The data to associate with the item for related callbacks.
+ * @return The created item or @c NULL upon failure.
*
- * @param obj The bubble object
- * @return The content that is being used
- */
- EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Unset the content shown in the bubble
+ * A new item will be created and appended to the toolbar, i.e., will
+ * be set as @b last item.
*
- * Unparent and return the content object which was set for this widget.
+ * Items created with this method can be deleted with
+ * elm_toolbar_item_del().
*
- * @param obj The bubble object
- * @return The content that was being used
- */
- EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Set the icon of the bubble
+ * Associated @p data can be properly freed when item is deleted if a
+ * callback function is set with elm_toolbar_item_del_cb_set().
*
- * Once the icon object is set, a previously set one will be deleted.
- * If you want to keep the old content object, use the
- * elm_icon_content_unset() function.
+ * If a function is passed as argument, it will be called everytime this item
+ * is selected, i.e., the user clicks over an unselected item.
+ * If such function isn't needed, just passing
+ * @c NULL as @p func is enough. The same should be done for @p data.
*
- * @param obj The bubble object
- * @param icon The given icon for the bubble
- */
- EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
- /**
- * Get the icon of the bubble
+ * Toolbar will load icon image from fdo or current theme.
+ * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
+ * If an absolute path is provided it will load it direct from a file.
*
- * @param obj The bubble object
- * @return The icon for the bubble
+ * @see elm_toolbar_item_icon_set()
+ * @see elm_toolbar_item_del()
+ * @see elm_toolbar_item_del_cb_set()
*
- * This function gets the icon shown on the top left of bubble.
+ * @ingroup Toolbar
*/
- EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ 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);
+
/**
- * Unset the icon of the bubble
+ * Prepend item to the toolbar.
*
- * Unparent and return the icon object which was set for this widget.
+ * @param obj The toolbar object.
+ * @param icon A string with icon name or the absolute path of an image file.
+ * @param label The label of the item.
+ * @param func The function to call when the item is clicked.
+ * @param data The data to associate with the item for related callbacks.
+ * @return The created item or @c NULL upon failure.
*
- * @param obj The bubble object
- * @return The icon that was being used
- */
- EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Set the corner of the bubble
+ * A new item will be created and prepended to the toolbar, i.e., will
+ * be set as @b first item.
*
- * @param obj The bubble object.
- * @param corner The given corner for the bubble.
+ * Items created with this method can be deleted with
+ * elm_toolbar_item_del().
*
- * This function sets the corner of the bubble. The corner will be used to
- * determine where the arrow in the frame points to and where label, icon and
- * info arre shown.
+ * Associated @p data can be properly freed when item is deleted if a
+ * callback function is set with elm_toolbar_item_del_cb_set().
*
- * Possible values for corner are:
- * @li "top_left" - Default
- * @li "top_right"
- * @li "bottom_left"
- * @li "bottom_right"
- */
- EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
- /**
- * Get the corner of the bubble
+ * If a function is passed as argument, it will be called everytime this item
+ * is selected, i.e., the user clicks over an unselected item.
+ * If such function isn't needed, just passing
+ * @c NULL as @p func is enough. The same should be done for @p data.
*
- * @param obj The bubble object.
- * @return The given corner for the bubble.
+ * Toolbar will load icon image from fdo or current theme.
+ * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
+ * If an absolute path is provided it will load it direct from a file.
*
- * This function gets the selected corner of the bubble.
- */
- EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @}
- */
-
- /* photo */
- EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
- EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
- EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
- EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
- /* smart callbacks called:
- * "clicked" - the user clicked the icon
- * "drag,start" - Someone started dragging the image out of the object
- * "drag,end" - Dragged item was dropped (somewhere)
+ * @see elm_toolbar_item_icon_set()
+ * @see elm_toolbar_item_del()
+ * @see elm_toolbar_item_del_cb_set()
+ *
+ * @ingroup Toolbar
*/
+ 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);
- /* gesture layer */
/**
- * @defgroup Elm_Gesture_Layer Gesture Layer
- * Gesture Layer Usage:
- *
- * Use Gesture Layer to detect gestures.
- * The advantage is that you don't have to implement
- * gesture detection, just set callbacks of gesture state.
- * By using gesture layer we make standard interface.
- *
- * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
- * with a parent object parameter.
- * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
- * call. Usually with same object as target (2nd parameter).
+ * Insert a new item into the toolbar object before item @p before.
*
- * Now you need to tell gesture layer what gestures you follow.
- * This is done with @ref elm_gesture_layer_cb_set call.
- * By setting the callback you actually saying to gesture layer:
- * I would like to know when the gesture @ref Elm_Gesture_Types
- * switches to state @ref Elm_Gesture_State.
+ * @param obj The toolbar object.
+ * @param before The toolbar item to insert before.
+ * @param icon A string with icon name or the absolute path of an image file.
+ * @param label The label of the item.
+ * @param func The function to call when the item is clicked.
+ * @param data The data to associate with the item for related callbacks.
+ * @return The created item or @c NULL upon failure.
*
- * Next, you need to implement the actual action that follows the input
- * in your callback.
+ * A new item will be created and added to the toolbar. Its position in
+ * this toolbar will be just before item @p before.
*
- * Note that if you like to stop being reported about a gesture, just set
- * all callbacks referring this gesture to NULL.
- * (again with @ref elm_gesture_layer_cb_set)
+ * Items created with this method can be deleted with
+ * elm_toolbar_item_del().
*
- * The information reported by gesture layer to your callback is depending
- * on @ref Elm_Gesture_Types:
- * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
- * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
- * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
+ * Associated @p data can be properly freed when item is deleted if a
+ * callback function is set with elm_toolbar_item_del_cb_set().
*
- * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
- * @ref ELM_GESTURE_MOMENTUM.
+ * If a function is passed as argument, it will be called everytime this item
+ * is selected, i.e., the user clicks over an unselected item.
+ * If such function isn't needed, just passing
+ * @c NULL as @p func is enough. The same should be done for @p data.
*
- * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
- * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
- * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
- * Note that we consider a flick as a line-gesture that should be completed
- * in flick-time-limit as defined in @ref Config.
+ * Toolbar will load icon image from fdo or current theme.
+ * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
+ * If an absolute path is provided it will load it direct from a file.
*
- * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
+ * @see elm_toolbar_item_icon_set()
+ * @see elm_toolbar_item_del()
+ * @see elm_toolbar_item_del_cb_set()
*
- * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
- * */
-
- /**
- * @enum _Elm_Gesture_Types
- * Enum of supported gesture types.
- * @ingroup Elm_Gesture_Layer
+ * @ingroup Toolbar
*/
- enum _Elm_Gesture_Types
- {
- ELM_GESTURE_FIRST = 0,
-
- ELM_GESTURE_N_TAPS, /**< N fingers single taps */
- ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
- ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
- ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
-
- ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
-
- ELM_GESTURE_N_LINES, /**< N fingers line gesture */
- ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
-
- ELM_GESTURE_ZOOM, /**< Zoom */
- ELM_GESTURE_ROTATE, /**< Rotate */
+ 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);
- ELM_GESTURE_LAST
- };
+ /**
+ * Insert a new item into the toolbar object after item @p after.
+ *
+ * @param obj The toolbar object.
+ * @param before The toolbar item to insert before.
+ * @param icon A string with icon name or the absolute path of an image file.
+ * @param label The label of the item.
+ * @param func The function to call when the item is clicked.
+ * @param data The data to associate with the item for related callbacks.
+ * @return The created item or @c NULL upon failure.
+ *
+ * A new item will be created and added to the toolbar. Its position in
+ * this toolbar will be just after item @p after.
+ *
+ * Items created with this method can be deleted with
+ * elm_toolbar_item_del().
+ *
+ * Associated @p data can be properly freed when item is deleted if a
+ * callback function is set with elm_toolbar_item_del_cb_set().
+ *
+ * If a function is passed as argument, it will be called everytime this item
+ * is selected, i.e., the user clicks over an unselected item.
+ * If such function isn't needed, just passing
+ * @c NULL as @p func is enough. The same should be done for @p data.
+ *
+ * Toolbar will load icon image from fdo or current theme.
+ * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
+ * If an absolute path is provided it will load it direct from a file.
+ *
+ * @see elm_toolbar_item_icon_set()
+ * @see elm_toolbar_item_del()
+ * @see elm_toolbar_item_del_cb_set()
+ *
+ * @ingroup Toolbar
+ */
+ 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);
/**
- * @typedef Elm_Gesture_Types
- * gesture types enum
- * @ingroup Elm_Gesture_Layer
+ * Get the first item in the given toolbar widget's list of
+ * items.
+ *
+ * @param obj The toolbar object
+ * @return The first item or @c NULL, if it has no items (and on
+ * errors)
+ *
+ * @see elm_toolbar_item_append()
+ * @see elm_toolbar_last_item_get()
+ *
+ * @ingroup Toolbar
*/
- typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
+ EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @enum _Elm_Gesture_State
- * Enum of gesture states.
- * @ingroup Elm_Gesture_Layer
+ * Get the last item in the given toolbar widget's list of
+ * items.
+ *
+ * @param obj The toolbar object
+ * @return The last item or @c NULL, if it has no items (and on
+ * errors)
+ *
+ * @see elm_toolbar_item_prepend()
+ * @see elm_toolbar_first_item_get()
+ *
+ * @ingroup Toolbar
*/
- enum _Elm_Gesture_State
- {
- ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
- ELM_GESTURE_STATE_START, /**< Gesture STARTed */
- ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
- ELM_GESTURE_STATE_END, /**< Gesture completed */
- ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
- };
+ EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @typedef Elm_Gesture_State
- * gesture states enum
- * @ingroup Elm_Gesture_Layer
+ * Get the item after @p item in toolbar.
+ *
+ * @param item The toolbar item.
+ * @return The item after @p item, or @c NULL if none or on failure.
+ *
+ * @note If it is the last item, @c NULL will be returned.
+ *
+ * @see elm_toolbar_item_append()
+ *
+ * @ingroup Toolbar
*/
- typedef enum _Elm_Gesture_State Elm_Gesture_State;
+ EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
/**
- * @struct _Elm_Gesture_Taps_Info
- * Struct holds taps info for user
- * @ingroup Elm_Gesture_Layer
+ * Get the item before @p item in toolbar.
+ *
+ * @param item The toolbar item.
+ * @return The item before @p item, or @c NULL if none or on failure.
+ *
+ * @note If it is the first item, @c NULL will be returned.
+ *
+ * @see elm_toolbar_item_prepend()
+ *
+ * @ingroup Toolbar
*/
- struct _Elm_Gesture_Taps_Info
- {
- Evas_Coord x, y; /**< Holds center point between fingers */
- unsigned int n; /**< Number of fingers tapped */
- unsigned int timestamp; /**< event timestamp */
- };
+ EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
/**
- * @typedef Elm_Gesture_Taps_Info
- * holds taps info for user
- * @ingroup Elm_Gesture_Layer
+ * Get the toolbar object from an item.
+ *
+ * @param item The item.
+ * @return The toolbar object.
+ *
+ * This returns the toolbar object itself that an item belongs to.
+ *
+ * @ingroup Toolbar
*/
- typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
+ EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
/**
- * @struct _Elm_Gesture_Momentum_Info
- * Struct holds momentum info for user
- * x1 and y1 are not necessarily in sync
- * x1 holds x value of x direction starting point
- * and same holds for y1.
- * This is noticeable when doing V-shape movement
- * @ingroup Elm_Gesture_Layer
+ * Set the priority of a toolbar item.
+ *
+ * @param item The toolbar item.
+ * @param priority The item priority. The default is zero.
+ *
+ * This is used only when the toolbar shrink mode is set to
+ * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
+ * When space is less than required, items with low priority
+ * will be removed from the toolbar and added to a dynamically-created menu,
+ * while items with higher priority will remain on the toolbar,
+ * with the same order they were added.
+ *
+ * @see elm_toolbar_item_priority_get()
+ *
+ * @ingroup Toolbar
*/
- struct _Elm_Gesture_Momentum_Info
- { /* Report line ends, timestamps, and momentum computed */
- Evas_Coord x1; /**< Final-swipe direction starting point on X */
- Evas_Coord y1; /**< Final-swipe direction starting point on Y */
- Evas_Coord x2; /**< Final-swipe direction ending point on X */
- Evas_Coord y2; /**< Final-swipe direction ending point on Y */
-
- unsigned int tx; /**< Timestamp of start of final x-swipe */
- unsigned int ty; /**< Timestamp of start of final y-swipe */
-
- Evas_Coord mx; /**< Momentum on X */
- Evas_Coord my; /**< Momentum on Y */
- };
+ EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
/**
- * @typedef Elm_Gesture_Momentum_Info
- * holds momentum info for user
- * @ingroup Elm_Gesture_Layer
+ * Get the priority of a toolbar item.
+ *
+ * @param item The toolbar item.
+ * @return The @p item priority, or @c 0 on failure.
+ *
+ * @see elm_toolbar_item_priority_set() for details.
+ *
+ * @ingroup Toolbar
*/
- typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
+ EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
/**
- * @struct _Elm_Gesture_Line_Info
- * Struct holds line info for user
- * @ingroup Elm_Gesture_Layer
+ * Get the label of item.
+ *
+ * @param item The item of toolbar.
+ * @return The label of item.
+ *
+ * The return value is a pointer to the label associated to @p item when
+ * it was created, with function elm_toolbar_item_append() or similar,
+ * or later,
+ * with function elm_toolbar_item_label_set. If no label
+ * was passed as argument, it will return @c NULL.
+ *
+ * @see elm_toolbar_item_label_set() for more details.
+ * @see elm_toolbar_item_append()
+ *
+ * @ingroup Toolbar
*/
- struct _Elm_Gesture_Line_Info
- { /* Report line ends, timestamps, and momentum computed */
- Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
- unsigned int n; /**< Number of fingers (lines) */
- /* FIXME should be radians, bot degrees */
- double angle; /**< Angle (direction) of lines */
- };
+ EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
/**
- * @typedef Elm_Gesture_Line_Info
- * Holds line info for user
- * @ingroup Elm_Gesture_Layer
+ * Set the label of item.
+ *
+ * @param item The item of toolbar.
+ * @param text The label of item.
+ *
+ * The label to be displayed by the item.
+ * Label will be placed at icons bottom (if set).
+ *
+ * If a label was passed as argument on item creation, with function
+ * elm_toolbar_item_append() or similar, it will be already
+ * displayed by the item.
+ *
+ * @see elm_toolbar_item_label_get()
+ * @see elm_toolbar_item_append()
+ *
+ * @ingroup Toolbar
*/
- typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
+ EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
/**
- * @struct _Elm_Gesture_Zoom_Info
- * Struct holds zoom info for user
- * @ingroup Elm_Gesture_Layer
+ * Return the data associated with a given toolbar widget item.
+ *
+ * @param item The toolbar widget item handle.
+ * @return The data associated with @p item.
+ *
+ * @see elm_toolbar_item_data_set()
+ *
+ * @ingroup Toolbar
*/
- struct _Elm_Gesture_Zoom_Info
- {
- Evas_Coord x, y; /**< Holds zoom center point reported to user */
- Evas_Coord radius; /**< Holds radius between fingers reported to user */
- double zoom; /**< Zoom value: 1.0 means no zoom */
- double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
- };
+ EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
/**
- * @typedef Elm_Gesture_Zoom_Info
- * Holds zoom info for user
- * @ingroup Elm_Gesture_Layer
+ * Set the data associated with a given toolbar widget item.
+ *
+ * @param item The toolbar widget item handle.
+ * @param data The new data pointer to set to @p item.
+ *
+ * This sets new item data on @p item.
+ *
+ * @warning The old data pointer won't be touched by this function, so
+ * the user had better to free that old data himself/herself.
+ *
+ * @ingroup Toolbar
*/
- typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
+ EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
/**
- * @struct _Elm_Gesture_Rotate_Info
- * Struct holds rotation info for user
- * @ingroup Elm_Gesture_Layer
+ * Returns a pointer to a toolbar item by its label.
+ *
+ * @param obj The toolbar object.
+ * @param label The label of the item to find.
+ *
+ * @return The pointer to the toolbar item matching @p label or @c NULL
+ * on failure.
+ *
+ * @ingroup Toolbar
*/
- struct _Elm_Gesture_Rotate_Info
- {
- Evas_Coord x, y; /**< Holds zoom center point reported to user */
- Evas_Coord radius; /**< Holds radius between fingers reported to user */
- double base_angle; /**< Holds start-angle */
- double angle; /**< Rotation value: 0.0 means no rotation */
- double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
- };
+ EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
+ /*
+ * Get whether the @p item is selected or not.
+ *
+ * @param item The toolbar item.
+ * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
+ * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
+ *
+ * @see elm_toolbar_selected_item_set() for details.
+ * @see elm_toolbar_item_selected_get()
+ *
+ * @ingroup Toolbar
+ */
+ EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
/**
- * @typedef Elm_Gesture_Rotate_Info
- * Holds rotation info for user
- * @ingroup Elm_Gesture_Layer
+ * Set the selected state of an item.
+ *
+ * @param item The toolbar item
+ * @param selected The selected state
+ *
+ * This sets the selected state of the given item @p it.
+ * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
+ *
+ * If a new item is selected the previosly selected will be unselected.
+ * Previoulsy selected item can be get with function
+ * elm_toolbar_selected_item_get().
+ *
+ * Selected items will be highlighted.
+ *
+ * @see elm_toolbar_item_selected_get()
+ * @see elm_toolbar_selected_item_get()
+ *
+ * @ingroup Toolbar
*/
- typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
+ EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
/**
- * @typedef Elm_Gesture_Event_Cb
- * User callback used to stream gesture info from gesture layer
- * @param data user data
- * @param event_info gesture report info
- * Returns a flag field to be applied on the causing event.
- * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
- * upon the event, in an irreversible way.
+ * Get the selected item.
*
- * @ingroup Elm_Gesture_Layer
+ * @param obj The toolbar object.
+ * @return The selected toolbar item.
+ *
+ * The selected item can be unselected with function
+ * elm_toolbar_item_selected_set().
+ *
+ * The selected item always will be highlighted on toolbar.
+ *
+ * @see elm_toolbar_selected_items_get()
+ *
+ * @ingroup Toolbar
*/
- typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
+ EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Use function to set callbacks to be notified about
- * change of state of gesture.
- * When a user registers a callback with this function
- * this means this gesture has to be tested.
+ * Set the icon associated with @p item.
*
- * When ALL callbacks for a gesture are set to NULL
- * it means user isn't interested in gesture-state
- * and it will not be tested.
+ * @param obj The parent of this item.
+ * @param item The toolbar item.
+ * @param icon A string with icon name or the absolute path of an image file.
*
- * @param obj Pointer to gesture-layer.
- * @param idx The gesture you would like to track its state.
- * @param cb callback function pointer.
- * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
- * @param data user info to be sent to callback (usually, Smart Data)
+ * Toolbar will load icon image from fdo or current theme.
+ * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
+ * If an absolute path is provided it will load it direct from a file.
*
- * @ingroup Elm_Gesture_Layer
+ * @see elm_toolbar_icon_order_lookup_set()
+ * @see elm_toolbar_icon_order_lookup_get()
+ *
+ * @ingroup Toolbar
*/
- EAPI void elm_gesture_layer_cb_set(Evas_Object *obj, Elm_Gesture_Types idx, Elm_Gesture_State cb_type, Elm_Gesture_Event_Cb cb, void *data) EINA_ARG_NONNULL(1);
+ EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
/**
- * Call this function to get repeat-events settings.
+ * Get the string used to set the icon of @p item.
*
- * @param obj Pointer to gesture-layer.
+ * @param item The toolbar item.
+ * @return The string associated with the icon object.
*
- * @return repeat events settings.
- * @see elm_gesture_layer_hold_events_set()
- * @ingroup Elm_Gesture_Layer
+ * @see elm_toolbar_item_icon_set() for details.
+ *
+ * @ingroup Toolbar
*/
- EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
/**
- * This function called in order to make gesture-layer repeat events.
- * Set this of you like to get the raw events only if gestures were not detected.
- * Clear this if you like gesture layer to fwd events as testing gestures.
+ * Get the object of @p item.
*
- * @param obj Pointer to gesture-layer.
- * @param r Repeat: TRUE/FALSE
+ * @param item The toolbar item.
+ * @return The object
*
- * @ingroup Elm_Gesture_Layer
+ * @ingroup Toolbar
*/
- EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
/**
- * This function sets step-value for zoom action.
- * Set step to any positive value.
- * Cancel step setting by setting to 0.0
+ * Get the icon object of @p item.
*
- * @param obj Pointer to gesture-layer.
- * @param s new zoom step value.
+ * @param item The toolbar item.
+ * @return The icon object
*
- * @ingroup Elm_Gesture_Layer
+ * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
+ *
+ * @ingroup Toolbar
*/
- EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
/**
- * This function sets step-value for rotate action.
- * Set step to any positive value.
- * Cancel step setting by setting to 0.0
+ * Set the icon associated with @p item to an image in a binary buffer.
*
- * @param obj Pointer to gesture-layer.
- * @param s new roatate step value.
+ * @param item The toolbar item.
+ * @param img The binary data that will be used as an image
+ * @param size The size of binary data @p img
+ * @param format Optional format of @p img to pass to the image loader
+ * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
*
- * @ingroup Elm_Gesture_Layer
+ * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
+ *
+ * @note The icon image set by this function can be changed by
+ * elm_toolbar_item_icon_set().
+ *
+ * @ingroup Toolbar
*/
- EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Toolbar_Item *item, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
/**
- * This function called to attach gesture-layer to an Evas_Object.
- * @param obj Pointer to gesture-layer.
- * @param t Pointer to underlying object (AKA Target)
+ * Delete them item from the toolbar.
*
- * @return TRUE, FALSE on success, failure.
+ * @param item The item of toolbar to be deleted.
*
- * @ingroup Elm_Gesture_Layer
+ * @see elm_toolbar_item_append()
+ * @see elm_toolbar_item_del_cb_set()
+ *
+ * @ingroup Toolbar
*/
- EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
+ EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
/**
- * Call this function to construct a new gesture-layer object.
- * This does not activate the gesture layer. You have to
- * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
+ * Set the function called when a toolbar item is freed.
*
- * @param parent the parent object.
+ * @param item The item to set the callback on.
+ * @param func The function called.
*
- * @return Pointer to new gesture-layer object.
+ * If there is a @p func, then it will be called prior item's memory release.
+ * That will be called with the following arguments:
+ * @li item's data;
+ * @li item's Evas object;
+ * @li item itself;
*
- * @ingroup Elm_Gesture_Layer
+ * This way, a data associated to a toolbar item could be properly freed.
+ *
+ * @ingroup Toolbar
*/
- EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
/**
- * @defgroup Thumb Thumb
+ * Get a value whether toolbar item is disabled or not.
*
- * @image html img/widget/thumb/preview-00.png
- * @image latex img/widget/thumb/preview-00.eps
+ * @param item The item.
+ * @return The disabled state.
*
- * A thumb object is used for displaying the thumbnail of an image or video.
- * You must have compiled Elementary with Ethumb_Client support and the DBus
- * service must be present and auto-activated in order to have thumbnails to
- * be generated.
+ * @see elm_toolbar_item_disabled_set() for more details.
*
- * Once the thumbnail object becomes visible, it will check if there is a
- * previously generated thumbnail image for the file set on it. If not, it
- * will start generating this thumbnail.
+ * @ingroup Toolbar
+ */
+ EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Sets the disabled/enabled state of a toolbar item.
*
- * Different config settings will cause different thumbnails to be generated
- * even on the same file.
+ * @param item The item.
+ * @param disabled The disabled state.
*
- * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
- * Ethumb documentation to change this path, and to see other configuration
- * options.
+ * A disabled item cannot be selected or unselected. It will also
+ * change its appearance (generally greyed out). This sets the
+ * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
+ * enabled).
*
- * Signals that you can add callbacks for are:
+ * @ingroup Toolbar
+ */
+ EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set or unset item as a separator.
*
- * - "clicked" - This is called when a user has clicked the thumb without dragging
- * around.
- * - "clicked,double" - This is called when a user has double-clicked the thumb.
- * - "press" - This is called when a user has pressed down the thumb.
- * - "generate,start" - The thumbnail generation started.
- * - "generate,stop" - The generation process stopped.
- * - "generate,error" - The generation failed.
- * - "load,error" - The thumbnail image loading failed.
+ * @param item The toolbar item.
+ * @param setting @c EINA_TRUE to set item @p item as separator or
+ * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
*
- * available styles:
- * - default
- * - noframe
+ * Items aren't set as separator by default.
*
- * An example of use of thumbnail:
+ * If set as separator it will display separator theme, so won't display
+ * icons or label.
*
- * - @ref thumb_example_01
+ * @see elm_toolbar_item_separator_get()
+ *
+ * @ingroup Toolbar
*/
+ EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
/**
- * @addtogroup Thumb
- * @{
+ * Get a value whether item is a separator or not.
+ *
+ * @param item The toolbar item.
+ * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
+ * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
+ *
+ * @see elm_toolbar_item_separator_set() for details.
+ *
+ * @ingroup Toolbar
*/
+ EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
/**
- * @enum _Elm_Thum_Animation_Setting
- * @typedef Elm_Thumb_Animation_Setting
+ * Set the shrink state of toolbar @p obj.
*
- * Used to set if a video thumbnail is animating or not.
+ * @param obj The toolbar object.
+ * @param shrink_mode Toolbar's items display behavior.
*
- * @ingroup Thumb
+ * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
+ * but will enforce a minimun size so all the items will fit, won't scroll
+ * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
+ * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
+ * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
+ *
+ * @ingroup Toolbar
*/
- typedef enum _Elm_Thumb_Animation_Setting
- {
- ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
- ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
- ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
- ELM_THUMB_ANIMATION_LAST
- } Elm_Thumb_Animation_Setting;
+ EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the shrink mode of toolbar @p obj.
+ *
+ * @param obj The toolbar object.
+ * @return Toolbar's items display behavior.
+ *
+ * @see elm_toolbar_mode_shrink_set() for details.
+ *
+ * @ingroup Toolbar
+ */
+ EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Add a new thumb object to the parent.
+ * Enable/disable homogenous mode.
*
- * @param parent The parent object.
- * @return The new object or NULL if it cannot be created.
+ * @param obj The toolbar object
+ * @param homogeneous Assume the items within the toolbar are of the
+ * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
*
- * @see elm_thumb_file_set()
- * @see elm_thumb_ethumb_client_get()
+ * This will enable the homogeneous mode where items are of the same size.
+ * @see elm_toolbar_homogeneous_get()
*
- * @ingroup Thumb
+ * @ingroup Toolbar
*/
- EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
+
/**
- * Reload thumbnail if it was generated before.
- *
- * @param obj The thumb object to reload
- *
- * This is useful if the ethumb client configuration changed, like its
- * size, aspect or any other property one set in the handle returned
- * by elm_thumb_ethumb_client_get().
+ * Get whether the homogenous mode is enabled.
*
- * If the options didn't change, the thumbnail won't be generated again, but
- * the old one will still be used.
+ * @param obj The toolbar object.
+ * @return Assume the items within the toolbar are of the same height
+ * and width (EINA_TRUE = on, EINA_FALSE = off).
*
- * @see elm_thumb_file_set()
+ * @see elm_toolbar_homogeneous_set()
*
- * @ingroup Thumb
+ * @ingroup Toolbar
*/
- EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set the file that will be used as thumbnail.
+ * Enable/disable homogenous mode.
*
- * @param obj The thumb object.
- * @param file The path to file that will be used as thumb.
- * @param key The key used in case of an EET file.
+ * @param obj The toolbar object
+ * @param homogeneous Assume the items within the toolbar are of the
+ * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
*
- * The file can be an image or a video (in that case, acceptable extensions are:
- * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
- * function elm_thumb_animate().
+ * This will enable the homogeneous mode where items are of the same size.
+ * @see elm_toolbar_homogeneous_get()
*
- * @see elm_thumb_file_get()
- * @see elm_thumb_reload()
- * @see elm_thumb_animate()
+ * @deprecated use elm_toolbar_homogeneous_set() instead.
*
- * @ingroup Thumb
+ * @ingroup Toolbar
*/
- EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
+
/**
- * Get the image or video path and key used to generate the thumbnail.
+ * Get whether the homogenous mode is enabled.
*
- * @param obj The thumb object.
- * @param file Pointer to filename.
- * @param key Pointer to key.
+ * @param obj The toolbar object.
+ * @return Assume the items within the toolbar are of the same height
+ * and width (EINA_TRUE = on, EINA_FALSE = off).
*
- * @see elm_thumb_file_set()
- * @see elm_thumb_path_get()
+ * @see elm_toolbar_homogeneous_set()
+ * @deprecated use elm_toolbar_homogeneous_get() instead.
*
- * @ingroup Thumb
+ * @ingroup Toolbar
*/
- EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the path and key to the image or video generated by ethumb.
+ * Set the parent object of the toolbar items' menus.
*
- * One just need to make sure that the thumbnail was generated before getting
- * its path; otherwise, the path will be NULL. One way to do that is by asking
- * for the path when/after the "generate,stop" smart callback is called.
+ * @param obj The toolbar object.
+ * @param parent The parent of the menu objects.
*
- * @param obj The thumb object.
- * @param file Pointer to thumb path.
- * @param key Pointer to thumb key.
+ * Each item can be set as item menu, with elm_toolbar_item_menu_set().
*
- * @see elm_thumb_file_get()
+ * For more details about setting the parent for toolbar menus, see
+ * elm_menu_parent_set().
*
- * @ingroup Thumb
+ * @see elm_menu_parent_set() for details.
+ * @see elm_toolbar_item_menu_set() for details.
+ *
+ * @ingroup Toolbar
*/
- EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
+ EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
- * Set the animation state for the thumb object. If its content is an animated
- * video, you may start/stop the animation or tell it to play continuously and
- * looping.
+ * Get the parent object of the toolbar items' menus.
*
- * @param obj The thumb object.
- * @param setting The animation setting.
+ * @param obj The toolbar object.
+ * @return The parent of the menu objects.
*
- * @see elm_thumb_file_set()
+ * @see elm_toolbar_menu_parent_set() for details.
*
- * @ingroup Thumb
+ * @ingroup Toolbar
*/
- EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the animation state for the thumb object.
+ * Set the alignment of the items.
*
- * @param obj The thumb object.
- * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
- * on errors.
+ * @param obj The toolbar object.
+ * @param align The new alignment, a float between <tt> 0.0 </tt>
+ * and <tt> 1.0 </tt>.
*
- * @see elm_thumb_animate_set()
+ * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
+ * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
+ * items.
*
- * @ingroup Thumb
+ * Centered items by default.
+ *
+ * @see elm_toolbar_align_get()
+ *
+ * @ingroup Toolbar
*/
- EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
+
/**
- * Get the ethumb_client handle so custom configuration can be made.
- *
- * @return Ethumb_Client instance or NULL.
+ * Get the alignment of the items.
*
- * This must be called before the objects are created to be sure no object is
- * visible and no generation started.
+ * @param obj The toolbar object.
+ * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
+ * <tt> 1.0 </tt>.
*
- * Example of usage:
+ * @see elm_toolbar_align_set() for details.
*
- * @code
- * #include <Elementary.h>
- * #ifndef ELM_LIB_QUICKLAUNCH
- * EAPI int
- * elm_main(int argc, char **argv)
- * {
- * Ethumb_Client *client;
+ * @ingroup Toolbar
+ */
+ EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set whether the toolbar item opens a menu.
*
- * elm_need_ethumb();
+ * @param item The toolbar item.
+ * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
*
- * // ... your code
+ * A toolbar item can be set to be a menu, using this function.
*
- * client = elm_thumb_ethumb_client_get();
- * if (!client)
- * {
- * ERR("could not get ethumb_client");
- * return 1;
- * }
- * ethumb_client_size_set(client, 100, 100);
- * ethumb_client_crop_align_set(client, 0.5, 0.5);
- * // ... your code
+ * Once it is set to be a menu, it can be manipulated through the
+ * menu-like function elm_toolbar_menu_parent_set() and the other
+ * elm_menu functions, using the Evas_Object @c menu returned by
+ * elm_toolbar_item_menu_get().
*
- * // Create elm_thumb objects here
+ * So, items to be displayed in this item's menu should be added with
+ * elm_menu_item_add().
*
- * elm_run();
- * elm_shutdown();
- * return 0;
- * }
- * #endif
- * ELM_MAIN()
+ * The following code exemplifies the most basic usage:
+ * @code
+ * tb = elm_toolbar_add(win)
+ * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
+ * elm_toolbar_item_menu_set(item, EINA_TRUE);
+ * elm_toolbar_menu_parent_set(tb, win);
+ * menu = elm_toolbar_item_menu_get(item);
+ * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
+ * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
+ * NULL);
* @endcode
*
- * @note There's only one client handle for Ethumb, so once a configuration
- * change is done to it, any other request for thumbnails (for any thumbnail
- * object) will use that configuration. Thus, this configuration is global.
+ * @see elm_toolbar_item_menu_get()
*
- * @ingroup Thumb
+ * @ingroup Toolbar
*/
- EAPI void *elm_thumb_ethumb_client_get(void);
+ EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
+
/**
- * Get the ethumb_client connection state.
+ * Get toolbar item's menu.
*
- * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
- * otherwise.
+ * @param item The toolbar item.
+ * @return Item's menu object or @c NULL on failure.
+ *
+ * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
+ * this function will set it.
+ *
+ * @see elm_toolbar_item_menu_set() for details.
+ *
+ * @ingroup Toolbar
*/
- EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
+ EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * Make the thumbnail 'editable'.
+ * Add a new state to @p item.
*
- * @param obj Thumb object.
- * @param set Turn on or off editability. Default is @c EINA_FALSE.
+ * @param item The item.
+ * @param icon A string with icon name or the absolute path of an image file.
+ * @param label The label of the new state.
+ * @param func The function to call when the item is clicked when this
+ * state is selected.
+ * @param data The data to associate with the state.
+ * @return The toolbar item state, or @c NULL upon failure.
*
- * This means the thumbnail is a valid drag target for drag and drop, and can be
- * cut or pasted too.
+ * Toolbar will load icon image from fdo or current theme.
+ * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
+ * If an absolute path is provided it will load it direct from a file.
+ *
+ * States created with this function can be removed with
+ * elm_toolbar_item_state_del().
*
- * @seee elm_thumb_editable_get()
+ * @see elm_toolbar_item_state_del()
+ * @see elm_toolbar_item_state_sel()
+ * @see elm_toolbar_item_state_get()
*
- * @ingroup Thumb
+ * @ingroup Toolbar
*/
- EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
+ 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);
+
/**
- * Make the thumbnail 'editable'.
- *
- * @param obj Thumb object.
- * @return Editability.
- *
- * This means the thumbnail is a valid drag target for drag and drop, and can be
- * cut or pasted too.
+ * Delete a previoulsy added state to @p item.
*
- * @seee elm_thumb_editable_set()
+ * @param item The toolbar item.
+ * @param state The state to be deleted.
+ * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
*
- * @ingroup Thumb
+ * @see elm_toolbar_item_state_add()
*/
- EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
/**
- * @}
+ * Set @p state as the current state of @p it.
+ *
+ * @param it The item.
+ * @param state The state to use.
+ * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
+ *
+ * If @p state is @c NULL, it won't select any state and the default item's
+ * icon and label will be used. It's the same behaviour than
+ * elm_toolbar_item_state_unser().
+ *
+ * @see elm_toolbar_item_state_unset()
+ *
+ * @ingroup Toolbar
*/
+ EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
/**
- * @defgroup Hoversel
+ * Unset the state of @p it.
*
- * @image html img/widget/hoversel/preview-00.png
- * @image latex img/widget/hoversel/preview-00.eps
+ * @param it The item.
*
- * A hoversel is a button that pops up a list of items (automatically
- * choosing the direction to display) that have a label and, optionally, an
- * icon to select from. It is a convenience widget to avoid the need to do
- * all the piecing together yourself. It is intended for a small number of
- * items in the hoversel menu (no more than 8), though is capable of many
- * more.
+ * The default icon and label from this item will be displayed.
*
- * Signals that you can add callbacks for are:
- * "clicked" - the user clicked the hoversel button and popped up the sel
- * "selected" - an item in the hoversel list is selected. event_info is the item
- * "dismissed" - the hover is dismissed
+ * @see elm_toolbar_item_state_set() for more details.
*
- * See @ref tutorial_hoversel for an example.
- * @{
+ * @ingroup Toolbar
*/
- typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
+ EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
+
/**
- * @brief Add a new Hoversel object
+ * Get the current state of @p it.
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
- */
- EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
- /**
- * @brief This sets the hoversel to expand horizontally.
+ * @param item The item.
+ * @return The selected state or @c NULL if none is selected or on failure.
*
- * @param obj The hoversel object
- * @param horizontal If true, the hover will expand horizontally to the
- * right.
+ * @see elm_toolbar_item_state_set() for details.
+ * @see elm_toolbar_item_state_unset()
+ * @see elm_toolbar_item_state_add()
*
- * @note The initial button will display horizontally regardless of this
- * setting.
+ * @ingroup Toolbar
*/
- EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
+ EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
+
/**
- * @brief This returns whether the hoversel is set to expand horizontally.
+ * Get the state after selected state in toolbar's @p item.
*
- * @param obj The hoversel object
- * @return If true, the hover will expand horizontally to the right.
+ * @param it The toolbar item to change state.
+ * @return The state after current state, or @c NULL on failure.
*
- * @see elm_hoversel_horizontal_set()
- */
- EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the Hover parent
+ * If last state is selected, this function will return first state.
*
- * @param obj The hoversel object
- * @param parent The parent to use
+ * @see elm_toolbar_item_state_set()
+ * @see elm_toolbar_item_state_add()
*
- * Sets the hover parent object, the area that will be darkened when the
- * hoversel is clicked. Should probably be the window that the hoversel is
- * in. See @ref Hover objects for more information.
+ * @ingroup Toolbar
*/
- EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the Hover parent
+ * Get the state before selected state in toolbar's @p item.
*
- * @param obj The hoversel object
- * @return The used parent
+ * @param it The toolbar item to change state.
+ * @return The state before current state, or @c NULL on failure.
*
- * Gets the hover parent object.
+ * If first state is selected, this function will return last state.
*
- * @see elm_hoversel_hover_parent_set()
+ * @see elm_toolbar_item_state_set()
+ * @see elm_toolbar_item_state_add()
+ *
+ * @ingroup Toolbar
*/
- EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the hoversel button label
- *
- * @param obj The hoversel object
- * @param label The label text.
+ * Set the text to be shown in a given toolbar item's tooltips.
*
- * This sets the label of the button that is always visible (before it is
- * clicked and expanded).
+ * @param item Target item.
+ * @param text The text to set in the content.
*
- * @deprecated elm_object_text_set()
- */
- EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
- /**
- * @brief Get the hoversel button label
+ * Setup the text as tooltip to object. The item can have only one tooltip,
+ * so any previous tooltip data - set with this function or
+ * elm_toolbar_item_tooltip_content_cb_set() - is removed.
*
- * @param obj The hoversel object
- * @return The label text.
+ * @see elm_object_tooltip_text_set() for more details.
*
- * @deprecated elm_object_text_get()
+ * @ingroup Toolbar
*/
- EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the icon of the hoversel button
+ * Set the content to be shown in the tooltip item.
*
- * @param obj The hoversel object
- * @param icon The icon object
+ * Setup the tooltip to item. The item can have only one tooltip,
+ * so any previous tooltip data is removed. @p func(with @p data) will
+ * be called every time that need show the tooltip and it should
+ * return a valid Evas_Object. This object is then managed fully by
+ * tooltip system and is deleted when the tooltip is gone.
*
- * Sets the icon of the button that is always visible (before it is clicked
- * and expanded). Once the icon object is set, a previously set one will be
- * deleted, if you want to keep that old content object, use the
- * elm_hoversel_icon_unset() function.
+ * @param item the toolbar item being attached a tooltip.
+ * @param func the function used to create the tooltip contents.
+ * @param data what to provide to @a func as callback data/context.
+ * @param del_cb called when data is not needed anymore, either when
+ * another callback replaces @a func, the tooltip is unset with
+ * elm_toolbar_item_tooltip_unset() or the owner @a item
+ * dies. This callback receives as the first parameter the
+ * given @a data, and @c event_info is the item.
*
- * @see elm_button_icon_set()
+ * @see elm_object_tooltip_content_cb_set() for more details.
+ *
+ * @ingroup Toolbar
*/
- EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+ 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);
+
/**
- * @brief Get the icon of the hoversel button
+ * Unset tooltip from item.
*
- * @param obj The hoversel object
- * @return The icon object
+ * @param item toolbar item to remove previously set tooltip.
*
- * Get the icon of the button that is always visible (before it is clicked
- * and expanded). Also see elm_button_icon_get().
+ * Remove tooltip from item. The callback provided as del_cb to
+ * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
+ * it is not used anymore.
*
- * @see elm_hoversel_icon_set()
+ * @see elm_object_tooltip_unset() for more details.
+ * @see elm_toolbar_item_tooltip_content_cb_set()
+ *
+ * @ingroup Toolbar
*/
- EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get and unparent the icon of the hoversel button
+ * Sets a different style for this item tooltip.
*
- * @param obj The hoversel object
- * @return The icon object that was being used
+ * @note before you set a style you should define a tooltip with
+ * elm_toolbar_item_tooltip_content_cb_set() or
+ * elm_toolbar_item_tooltip_text_set()
*
- * Unparent and return the icon of the button that is always visible
- * (before it is clicked and expanded).
+ * @param item toolbar item with tooltip already set.
+ * @param style the theme style to use (default, transparent, ...)
*
- * @see elm_hoversel_icon_set()
- * @see elm_button_icon_unset()
- */
- EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief This triggers the hoversel popup from code, the same as if the user
- * had clicked the button.
+ * @see elm_object_tooltip_style_set() for more details.
*
- * @param obj The hoversel object
+ * @ingroup Toolbar
*/
- EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
+
/**
- * @brief This dismisses the hoversel popup as if the user had clicked
- * outside the hover.
+ * Get the style for this item tooltip.
*
- * @param obj The hoversel object
- */
- EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Returns whether the hoversel is expanded.
+ * @param item toolbar item with tooltip already set.
+ * @return style the theme style in use, defaults to "default". If the
+ * object does not have a tooltip set, then NULL is returned.
*
- * @param obj The hoversel object
- * @return This will return EINA_TRUE if the hoversel is expanded or
- * EINA_FALSE if it is not expanded.
+ * @see elm_object_tooltip_style_get() for more details.
+ * @see elm_toolbar_item_tooltip_style_set()
+ *
+ * @ingroup Toolbar
*/
- EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief This will remove all the children items from the hoversel.
+ * Set the type of mouse pointer/cursor decoration to be shown,
+ * when the mouse pointer is over the given toolbar widget item
*
- * @param obj The hoversel object
+ * @param item toolbar item to customize cursor on
+ * @param cursor the cursor type's name
*
- * @warning Should @b not be called while the hoversel is active; use
- * elm_hoversel_expanded_get() to check first.
+ * This function works analogously as elm_object_cursor_set(), but
+ * here the cursor's changing area is restricted to the item's
+ * area, and not the whole widget's. Note that that item cursors
+ * have precedence over widget cursors, so that a mouse over an
+ * item with custom cursor set will always show @b that cursor.
*
- * @see elm_hoversel_item_del_cb_set()
- * @see elm_hoversel_item_del()
+ * If this function is called twice for an object, a previously set
+ * cursor will be unset on the second call.
+ *
+ * @see elm_object_cursor_set()
+ * @see elm_toolbar_item_cursor_get()
+ * @see elm_toolbar_item_cursor_unset()
+ *
+ * @ingroup Toolbar
*/
- EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Get the list of items within the given hoversel.
+ EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
+
+ /*
+ * Get the type of mouse pointer/cursor decoration set to be shown,
+ * when the mouse pointer is over the given toolbar widget item
+ *
+ * @param item toolbar item with custom cursor set
+ * @return the cursor type's name or @c NULL, if no custom cursors
+ * were set to @p item (and on errors)
*
- * @param obj The hoversel object
- * @return Returns a list of Elm_Hoversel_Item*
+ * @see elm_object_cursor_get()
+ * @see elm_toolbar_item_cursor_set()
+ * @see elm_toolbar_item_cursor_unset()
*
- * @see elm_hoversel_item_add()
+ * @ingroup Toolbar
*/
- EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief Add an item to the hoversel button
+ * Unset any custom mouse pointer/cursor decoration set to be
+ * shown, when the mouse pointer is over the given toolbar widget
+ * item, thus making it show the @b default cursor again.
*
- * @param obj The hoversel object
- * @param label The text label to use for the item (NULL if not desired)
- * @param icon_file An image file path on disk to use for the icon or standard
- * icon name (NULL if not desired)
- * @param icon_type The icon type if relevant
- * @param func Convenience function to call when this item is selected
- * @param data Data to pass to item-related functions
- * @return A handle to the item added.
+ * @param item a toolbar item
*
- * This adds an item to the hoversel to show when it is clicked. Note: if you
- * need to use an icon from an edje file then use
- * elm_hoversel_item_icon_set() right after the this function, and set
- * icon_file to NULL here.
+ * Use this call to undo any custom settings on this item's cursor
+ * decoration, bringing it back to defaults (no custom style set).
*
- * For more information on what @p icon_file and @p icon_type are see the
- * @ref Icon "icon documentation".
+ * @see elm_object_cursor_unset()
+ * @see elm_toolbar_item_cursor_set()
+ *
+ * @ingroup Toolbar
*/
- 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);
+ EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief Delete an item from the hoversel
+ * Set a different @b style for a given custom cursor set for a
+ * toolbar item.
*
- * @param item The item to delete
+ * @param item toolbar item with custom cursor set
+ * @param style the <b>theme style</b> to use (e.g. @c "default",
+ * @c "transparent", etc)
*
- * This deletes the item from the hoversel (should not be called while the
- * hoversel is active; use elm_hoversel_expanded_get() to check first).
+ * This function only makes sense when one is using custom mouse
+ * cursor decorations <b>defined in a theme file</b>, which can have,
+ * given a cursor name/type, <b>alternate styles</b> on it. It
+ * works analogously as elm_object_cursor_style_set(), but here
+ * applyed only to toolbar item objects.
*
- * @see elm_hoversel_item_add()
- * @see elm_hoversel_item_del_cb_set()
+ * @warning Before you set a cursor style you should have definen a
+ * custom cursor previously on the item, with
+ * elm_toolbar_item_cursor_set()
+ *
+ * @see elm_toolbar_item_cursor_engine_only_set()
+ * @see elm_toolbar_item_cursor_style_get()
+ *
+ * @ingroup Toolbar
*/
- EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the function to be called when an item from the hoversel is
- * freed.
+ * Get the current @b style set for a given toolbar item's custom
+ * cursor
*
- * @param item The item to set the callback on
- * @param func The function called
+ * @param item toolbar item with custom cursor set.
+ * @return style the cursor style in use. If the object does not
+ * have a cursor set, then @c NULL is returned.
*
- * That function will receive these parameters:
- * @li void *item_data
- * @li Evas_Object *the_item_object
- * @li Elm_Hoversel_Item *the_object_struct
+ * @see elm_toolbar_item_cursor_style_set() for more details
*
- * @see elm_hoversel_item_add()
+ * @ingroup Toolbar
*/
- EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief This returns the data pointer supplied with elm_hoversel_item_add()
- * that will be passed to associated function callbacks.
+ * Set if the (custom)cursor for a given toolbar item should be
+ * searched in its theme, also, or should only rely on the
+ * rendering engine.
*
- * @param item The item to get the data from
- * @return The data pointer set with elm_hoversel_item_add()
+ * @param item item with custom (custom) cursor already set on
+ * @param engine_only Use @c EINA_TRUE to have cursors looked for
+ * only on those provided by the rendering engine, @c EINA_FALSE to
+ * have them searched on the widget's theme, as well.
*
- * @see elm_hoversel_item_add()
- */
- EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
- /**
- * @brief This returns the label text of the given hoversel item.
+ * @note This call is of use only if you've set a custom cursor
+ * for toolbar items, with elm_toolbar_item_cursor_set().
*
- * @param item The item to get the label
- * @return The label text of the hoversel item
+ * @note By default, cursors will only be looked for between those
+ * provided by the rendering engine.
*
- * @see elm_hoversel_item_add()
+ * @ingroup Toolbar
*/
- EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
+ EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
+
/**
- * @brief This sets the icon for the given hoversel item.
+ * Get if the (custom) cursor for a given toolbar item is being
+ * searched in its theme, also, or is only relying on the rendering
+ * engine.
*
- * @param item The item to set the icon
- * @param icon_file An image file path on disk to use for the icon or standard
- * icon name
- * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
- * to NULL if the icon is not an edje file
- * @param icon_type The icon type
+ * @param item a toolbar item
+ * @return @c EINA_TRUE, if cursors are being looked for only on
+ * those provided by the rendering engine, @c EINA_FALSE if they
+ * are being searched on the widget's theme, as well.
*
- * The icon can be loaded from the standard set, from an image file, or from
- * an edje file.
+ * @see elm_toolbar_item_cursor_engine_only_set(), for more details
*
- * @see elm_hoversel_item_add()
+ * @ingroup Toolbar
*/
- 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);
+ EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the icon object of the hoversel item
- *
- * @param item The item to get the icon from
- * @param icon_file The image file path on disk used for the icon or standard
- * icon name
- * @param icon_group The edje group used if @p icon_file is an edje file. NULL
- * if the icon is not an edje file
- * @param icon_type The icon type
- *
- * @see elm_hoversel_item_icon_set()
- * @see elm_hoversel_item_add()
+ * Change a toolbar's orientation
+ * @param obj The toolbar object
+ * @param vertical If @c EINA_TRUE, the toolbar is vertical
+ * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
+ * @ingroup Toolbar
*/
- 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);
+ EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get a toolbar's orientation
+ * @param obj The toolbar object
+ * @return If @c EINA_TRUE, the toolbar is vertical
+ * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
+ * @ingroup Toolbar
+ */
+ EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
/**
- * @defgroup Toolbar Toolbar
- * @ingroup Elementary
- *
- * @image html img/widget/toolbar/preview-00.png
- * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
- *
- * @image html img/toolbar.png
- * @image latex img/toolbar.eps width=\textwidth
- *
- * A toolbar is a widget that displays a list of items inside
- * a box. It can be scrollable, show a menu with items that don't fit
- * to toolbar size or even crop them.
- *
- * Only one item can be selected at a time.
+ * @defgroup Tooltips Tooltips
*
- * Items can have multiple states, or show menus when selected by the user.
- *
- * Smart callbacks one can listen to:
- * - "clicked" - when the user clicks on a toolbar item and becomes selected.
- *
- * Available styles for it:
- * - @c "default"
- * - @c "transparent" - no background or shadow, just show the content
+ * The Tooltip is an (internal, for now) smart object used to show a
+ * content in a frame on mouse hover of objects(or widgets), with
+ * tips/information about them.
*
- * List of examples:
- * @li @ref toolbar_example_01
- * @li @ref toolbar_example_02
- * @li @ref toolbar_example_03
+ * @{
*/
+ EAPI double elm_tooltip_delay_get(void);
+ EAPI Eina_Bool elm_tooltip_delay_set(double delay);
+ EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
+ 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);
+ EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
+
/**
- * @addtogroup Toolbar
- * @{
+ * @}
*/
/**
- * @enum _Elm_Toolbar_Shrink_Mode
- * @typedef Elm_Toolbar_Shrink_Mode
- *
- * Set toolbar's items display behavior, it can be scrollabel,
- * show a menu with exceeding items, or simply hide them.
- *
- * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
- * from elm config.
+ * @defgroup Cursors Cursors
*
- * Values <b> don't </b> work as bitmaks, only one can be choosen.
+ * The Elementary cursor is an internal smart object used to
+ * customize the mouse cursor displayed over objects (or
+ * widgets). In the most common scenario, the cursor decoration
+ * comes from the graphical @b engine Elementary is running
+ * on. Those engines may provide different decorations for cursors,
+ * and Elementary provides functions to choose them (think of X11
+ * cursors, as an example).
*
- * @see elm_toolbar_mode_shrink_set()
- * @see elm_toolbar_mode_shrink_get()
+ * There's also the possibility of, besides using engine provided
+ * cursors, also use ones coming from Edje theming files. Both
+ * globally and per widget, Elementary makes it possible for one to
+ * make the cursors lookup to be held on engines only or on
+ * Elementary's theme file, too.
*
- * @ingroup Toolbar
+ * @{
*/
- typedef enum _Elm_Toolbar_Shrink_Mode
- {
- ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
- ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
- ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
- ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
- } Elm_Toolbar_Shrink_Mode;
-
- typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item. Can be created with elm_toolbar_item_append(), elm_toolbar_item_prepend() and functions to add items in relative positions, like elm_toolbar_item_insert_before(), and deleted with elm_toolbar_item_del(). */
-
- typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /**< State of a Elm_Toolbar_Item. Can be created with elm_toolbar_item_state_add() and removed with elm_toolbar_item_state_del(). */
/**
- * Add a new toolbar widget to the given parent Elementary
- * (container) object.
+ * Set the cursor to be shown when mouse is over the object
*
- * @param parent The parent object.
- * @return a new toolbar widget handle or @c NULL, on errors.
+ * Set the cursor that will be displayed when mouse is over the
+ * object. The object can have only one cursor set to it, so if
+ * this function is called twice for an object, the previous set
+ * will be unset.
+ * If using X cursors, a definition of all the valid cursor names
+ * is listed on Elementary_Cursors.h. If an invalid name is set
+ * the default cursor will be used.
*
- * This function inserts a new toolbar widget on the canvas.
+ * @param obj the object being set a cursor.
+ * @param cursor the cursor name to be used.
*
- * @ingroup Toolbar
+ * @ingroup Cursors
*/
- EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
/**
- * Set the icon size, in pixels, to be used by toolbar items.
- *
- * @param obj The toolbar object
- * @param icon_size The icon size in pixels
+ * Get the cursor to be shown when mouse is over the object
*
- * @note Default value is @c 32. It reads value from elm config.
- *
- * @see elm_toolbar_icon_size_get()
+ * @param obj an object with cursor already set.
+ * @return the cursor name.
*
- * @ingroup Toolbar
+ * @ingroup Cursors
*/
- EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the icon size, in pixels, to be used by toolbar items.
+ * Unset cursor for object
*
- * @param obj The toolbar object.
- * @return The icon size in pixels.
+ * Unset cursor for object, and set the cursor to default if the mouse
+ * was over this object.
*
- * @see elm_toolbar_icon_size_set() for details.
+ * @param obj Target object
+ * @see elm_object_cursor_set()
*
- * @ingroup Toolbar
+ * @ingroup Cursors
*/
- EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Sets icon lookup order, for toolbar items' icons.
+ * Sets a different style for this object cursor.
*
- * @param obj The toolbar object.
- * @param order The icon lookup order.
- *
- * Icons added before calling this function will not be affected.
- * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
+ * @note before you set a style you should define a cursor with
+ * elm_object_cursor_set()
*
- * @see elm_toolbar_icon_order_lookup_get()
+ * @param obj an object with cursor already set.
+ * @param style the theme style to use (default, transparent, ...)
*
- * @ingroup Toolbar
+ * @ingroup Cursors
*/
- EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
+ EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
/**
- * Gets the icon lookup order.
+ * Get the style for this object cursor.
*
- * @param obj The toolbar object.
- * @return The icon lookup order.
- *
- * @see elm_toolbar_icon_order_lookup_set() for details.
+ * @param obj an object with cursor already set.
+ * @return style the theme style in use, defaults to "default". If the
+ * object does not have a cursor set, then NULL is returned.
*
- * @ingroup Toolbar
+ * @ingroup Cursors
*/
- EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set whether the toolbar items' should be selected by the user or not.
+ * Set if the cursor set should be searched on the theme or should use
+ * the provided by the engine, only.
*
- * @param obj The toolbar object.
- * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
- * enable it.
+ * @note before you set if should look on theme you should define a cursor
+ * with elm_object_cursor_set(). By default it will only look for cursors
+ * provided by the engine.
*
- * This will turn off the ability to select items entirely and they will
- * neither appear selected nor emit selected signals. The clicked
- * callback function will still be called.
+ * @param obj an object with cursor already set.
+ * @param engine_only boolean to define it cursors should be looked only
+ * between the provided by the engine or searched on widget's theme as well.
*
- * Selection is enabled by default.
+ * @ingroup Cursors
+ */
+ EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the cursor engine only usage for this object cursor.
*
- * @see elm_toolbar_no_select_mode_get().
+ * @param obj an object with cursor already set.
+ * @return engine_only boolean to define it cursors should be
+ * looked only between the provided by the engine or searched on
+ * widget's theme as well. If the object does not have a cursor
+ * set, then EINA_FALSE is returned.
*
- * @ingroup Toolbar
+ * @ingroup Cursors
*/
- EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set whether the toolbar items' should be selected by the user or not.
- *
- * @param obj The toolbar object.
- * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
- * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
+ * Get the configured cursor engine only usage
*
- * @see elm_toolbar_no_select_mode_set() for details.
+ * This gets the globally configured exclusive usage of engine cursors.
*
- * @ingroup Toolbar
+ * @return 1 if only engine cursors should be used
+ * @ingroup Cursors
*/
- EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI int elm_cursor_engine_only_get(void);
/**
- * Append item to the toolbar.
- *
- * @param obj The toolbar object.
- * @param icon A string with icon name or the absolute path of an image file.
- * @param label The label of the item.
- * @param func The function to call when the item is clicked.
- * @param data The data to associate with the item for related callbacks.
- * @return The created item or @c NULL upon failure.
+ * Set the configured cursor engine only usage
*
- * A new item will be created and appended to the toolbar, i.e., will
- * be set as @b last item.
+ * This sets the globally configured exclusive usage of engine cursors.
+ * It won't affect cursors set before changing this value.
*
- * Items created with this method can be deleted with
- * elm_toolbar_item_del().
+ * @param engine_only If 1 only engine cursors will be enabled, if 0 will
+ * look for them on theme before.
+ * @return EINA_TRUE if value is valid and setted (0 or 1)
+ * @ingroup Cursors
+ */
+ EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
+
+ /**
+ * @}
+ */
+
+ /**
+ * @defgroup Menu Menu
*
- * Associated @p data can be properly freed when item is deleted if a
- * callback function is set with elm_toolbar_item_del_cb_set().
+ * @image html img/widget/menu/preview-00.png
+ * @image latex img/widget/menu/preview-00.eps
*
- * If a function is passed as argument, it will be called everytime this item
- * is selected, i.e., the user clicks over an unselected item.
- * If such function isn't needed, just passing
- * @c NULL as @p func is enough. The same should be done for @p data.
+ * A menu is a list of items displayed above its parent. When the menu is
+ * showing its parent is darkened. Each item can have a sub-menu. The menu
+ * object can be used to display a menu on a right click event, in a toolbar,
+ * anywhere.
*
- * Toolbar will load icon image from fdo or current theme.
- * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
- * If an absolute path is provided it will load it direct from a file.
+ * Signals that you can add callbacks for are:
+ * @li "clicked" - the user clicked the empty space in the menu to dismiss.
+ * event_info is NULL.
*
- * @see elm_toolbar_item_icon_set()
- * @see elm_toolbar_item_del()
- * @see elm_toolbar_item_del_cb_set()
+ * @see @ref tutorial_menu
+ * @{
+ */
+ typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
+ /**
+ * @brief Add a new menu to the parent
*
- * @ingroup Toolbar
+ * @param parent The parent object.
+ * @return The new object or NULL if it cannot be created.
*/
- 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);
-
+ EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Prepend item to the toolbar.
+ * @brief Set the parent for the given menu widget
*
- * @param obj The toolbar object.
- * @param icon A string with icon name or the absolute path of an image file.
- * @param label The label of the item.
- * @param func The function to call when the item is clicked.
- * @param data The data to associate with the item for related callbacks.
- * @return The created item or @c NULL upon failure.
+ * @param obj The menu object.
+ * @param parent The new parent.
+ */
+ EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the parent for the given menu widget
*
- * A new item will be created and prepended to the toolbar, i.e., will
- * be set as @b first item.
+ * @param obj The menu object.
+ * @return The parent.
*
- * Items created with this method can be deleted with
- * elm_toolbar_item_del().
+ * @see elm_menu_parent_set()
+ */
+ EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Move the menu to a new position
*
- * Associated @p data can be properly freed when item is deleted if a
- * callback function is set with elm_toolbar_item_del_cb_set().
+ * @param obj The menu object.
+ * @param x The new position.
+ * @param y The new position.
*
- * If a function is passed as argument, it will be called everytime this item
- * is selected, i.e., the user clicks over an unselected item.
- * If such function isn't needed, just passing
- * @c NULL as @p func is enough. The same should be done for @p data.
+ * Sets the top-left position of the menu to (@p x,@p y).
*
- * Toolbar will load icon image from fdo or current theme.
- * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
- * If an absolute path is provided it will load it direct from a file.
+ * @note @p x and @p y coordinates are relative to parent.
+ */
+ EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Close a opened menu
*
- * @see elm_toolbar_item_icon_set()
- * @see elm_toolbar_item_del()
- * @see elm_toolbar_item_del_cb_set()
+ * @param obj the menu object
+ * @return void
*
- * @ingroup Toolbar
+ * Hides the menu and all it's sub-menus.
*/
- 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);
-
+ EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Insert a new item into the toolbar object before item @p before.
+ * @brief Returns a list of @p item's items.
*
- * @param obj The toolbar object.
- * @param before The toolbar item to insert before.
- * @param icon A string with icon name or the absolute path of an image file.
- * @param label The label of the item.
- * @param func The function to call when the item is clicked.
- * @param data The data to associate with the item for related callbacks.
- * @return The created item or @c NULL upon failure.
+ * @param obj The menu object
+ * @return An Eina_List* of @p item's items
+ */
+ EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the Evas_Object of an Elm_Menu_Item
*
- * A new item will be created and added to the toolbar. Its position in
- * this toolbar will be just before item @p before.
+ * @param item The menu item object.
+ * @return The edje object containing the swallowed content
*
- * Items created with this method can be deleted with
- * elm_toolbar_item_del().
+ * @warning Don't manipulate this object!
+ */
+ EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Add an item at the end of the given menu widget
*
- * Associated @p data can be properly freed when item is deleted if a
- * callback function is set with elm_toolbar_item_del_cb_set().
+ * @param obj The menu object.
+ * @param parent The parent menu item (optional)
+ * @param icon A icon display on the item. The icon will be destryed by the menu.
+ * @param label The label of the item.
+ * @param func Function called when the user select the item.
+ * @param data Data sent by the callback.
+ * @return Returns the new item.
+ */
+ 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);
+ /**
+ * @brief Add an object swallowed in an item at the end of the given menu
+ * widget
*
- * If a function is passed as argument, it will be called everytime this item
- * is selected, i.e., the user clicks over an unselected item.
- * If such function isn't needed, just passing
- * @c NULL as @p func is enough. The same should be done for @p data.
+ * @param obj The menu object.
+ * @param parent The parent menu item (optional)
+ * @param subobj The object to swallow
+ * @param func Function called when the user select the item.
+ * @param data Data sent by the callback.
+ * @return Returns the new item.
*
- * Toolbar will load icon image from fdo or current theme.
- * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
- * If an absolute path is provided it will load it direct from a file.
+ * Add an evas object as an item to the menu.
+ */
+ EAPI Elm_Menu_Item *elm_menu_item_add_object(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the label of a menu item
*
- * @see elm_toolbar_item_icon_set()
- * @see elm_toolbar_item_del()
- * @see elm_toolbar_item_del_cb_set()
+ * @param item The menu item object.
+ * @param label The label to set for @p item
*
- * @ingroup Toolbar
+ * @warning Don't use this funcion on items created with
+ * elm_menu_item_add_object() or elm_menu_item_separator_add().
*/
- 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);
-
+ EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
/**
- * Insert a new item into the toolbar object after item @p after.
- *
- * @param obj The toolbar object.
- * @param before The toolbar item to insert before.
- * @param icon A string with icon name or the absolute path of an image file.
- * @param label The label of the item.
- * @param func The function to call when the item is clicked.
- * @param data The data to associate with the item for related callbacks.
- * @return The created item or @c NULL upon failure.
+ * @brief Get the label of a menu item
*
- * A new item will be created and added to the toolbar. Its position in
- * this toolbar will be just after item @p after.
+ * @param item The menu item object.
+ * @return The label of @p item
+ */
+ EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the icon of a menu item to the standard icon with name @p icon
*
- * Items created with this method can be deleted with
- * elm_toolbar_item_del().
+ * @param item The menu item object.
+ * @param icon The icon object to set for the content of @p item
*
- * Associated @p data can be properly freed when item is deleted if a
- * callback function is set with elm_toolbar_item_del_cb_set().
+ * Once this icon is set, any previously set icon will be deleted.
+ */
+ EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
+ /**
+ * @brief Get the string representation from the icon of a menu item
*
- * If a function is passed as argument, it will be called everytime this item
- * is selected, i.e., the user clicks over an unselected item.
- * If such function isn't needed, just passing
- * @c NULL as @p func is enough. The same should be done for @p data.
+ * @param item The menu item object.
+ * @return The string representation of @p item's icon or NULL
*
- * Toolbar will load icon image from fdo or current theme.
- * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
- * If an absolute path is provided it will load it direct from a file.
+ * @see elm_menu_item_object_icon_name_set()
+ */
+ EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the content object of a menu item
*
- * @see elm_toolbar_item_icon_set()
- * @see elm_toolbar_item_del()
- * @see elm_toolbar_item_del_cb_set()
+ * @param item The menu item object
+ * @param The content object or NULL
+ * @return EINA_TRUE on success, else EINA_FALSE
*
- * @ingroup Toolbar
+ * Use this function to change the object swallowed by a menu item, deleting
+ * any previously swallowed object.
*/
- 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);
-
+ EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the first item in the given toolbar widget's list of
- * items.
+ * @brief Get the content object of a menu item
*
- * @param obj The toolbar object
- * @return The first item or @c NULL, if it has no items (and on
- * errors)
+ * @param item The menu item object
+ * @return The content object or NULL
+ * @note If @p item was added with elm_menu_item_add_object, this
+ * function will return the object passed, else it will return the
+ * icon object.
*
- * @see elm_toolbar_item_append()
- * @see elm_toolbar_last_item_get()
+ * @see elm_menu_item_object_content_set()
+ */
+ EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the selected state of @p item.
*
- * @ingroup Toolbar
+ * @param item The menu item object.
+ * @param selected The selected/unselected state of the item
*/
- EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
/**
- * Get the last item in the given toolbar widget's list of
- * items.
+ * @brief Get the selected state of @p item.
*
- * @param obj The toolbar object
- * @return The last item or @c NULL, if it has no items (and on
- * errors)
+ * @param item The menu item object.
+ * @return The selected/unselected state of the item
*
- * @see elm_toolbar_item_prepend()
- * @see elm_toolbar_first_item_get()
+ * @see elm_menu_item_selected_set()
+ */
+ EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the disabled state of @p item.
*
- * @ingroup Toolbar
+ * @param item The menu item object.
+ * @param disabled The enabled/disabled state of the item
*/
- EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
/**
- * Get the item after @p item in toolbar.
+ * @brief Get the disabled state of @p item.
*
- * @param item The toolbar item.
- * @return The item after @p item, or @c NULL if none or on failure.
+ * @param item The menu item object.
+ * @return The enabled/disabled state of the item
*
- * @note If it is the last item, @c NULL will be returned.
+ * @see elm_menu_item_disabled_set()
+ */
+ EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Add a separator item to menu @p obj under @p parent.
*
- * @see elm_toolbar_item_append()
+ * @param obj The menu object
+ * @param parent The item to add the separator under
+ * @return The created item or NULL on failure
*
- * @ingroup Toolbar
+ * This is item is a @ref Separator.
*/
- EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
-
+ EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
/**
- * Get the item before @p item in toolbar.
+ * @brief Returns whether @p item is a separator.
*
- * @param item The toolbar item.
- * @return The item before @p item, or @c NULL if none or on failure.
+ * @param item The item to check
+ * @return If true, @p item is a separator
*
- * @note If it is the first item, @c NULL will be returned.
+ * @see elm_menu_item_separator_add()
+ */
+ EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Deletes an item from the menu.
*
- * @see elm_toolbar_item_prepend()
+ * @param item The item to delete.
*
- * @ingroup Toolbar
+ * @see elm_menu_item_add()
*/
- EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
/**
- * Get the toolbar object from an item.
- *
- * @param item The item.
- * @return The toolbar object.
+ * @brief Set the function called when a menu item is deleted.
*
- * This returns the toolbar object itself that an item belongs to.
+ * @param item The item to set the callback on
+ * @param func The function called
*
- * @ingroup Toolbar
+ * @see elm_menu_item_add()
+ * @see elm_menu_item_del()
*/
- EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
/**
- * Set the priority of a toolbar item.
+ * @brief Returns the data associated with menu item @p item.
*
- * @param item The toolbar item.
- * @param priority The item priority. The default is zero.
+ * @param item The item
+ * @return The data associated with @p item or NULL if none was set.
*
- * This is used only when the toolbar shrink mode is set to
- * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
- * When space is less than required, items with low priority
- * will be removed from the toolbar and added to a dynamically-created menu,
- * while items with higher priority will remain on the toolbar,
- * with the same order they were added.
+ * This is the data set with elm_menu_add() or elm_menu_item_data_set().
+ */
+ EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Sets the data to be associated with menu item @p item.
*
- * @see elm_toolbar_item_priority_get()
+ * @param item The item
+ * @param data The data to be associated with @p item
+ */
+ EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Returns a list of @p item's subitems.
*
- * @ingroup Toolbar
+ * @param item The item
+ * @return An Eina_List* of @p item's subitems
+ *
+ * @see elm_menu_add()
*/
- EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
-
+ EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
/**
- * Get the priority of a toolbar item.
+ * @brief Get the position of a menu item
*
- * @param item The toolbar item.
- * @return The @p item priority, or @c 0 on failure.
+ * @param item The menu item
+ * @return The item's index
*
- * @see elm_toolbar_item_priority_set() for details.
+ * This function returns the index position of a menu item in a menu.
+ * For a sub-menu, this number is relative to the first item in the sub-menu.
*
- * @ingroup Toolbar
+ * @note Index values begin with 0
*/
- EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
-
+ EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
/**
- * Get the label of item.
+ * @brief @brief Return a menu item's owner menu
*
- * @param item The item of toolbar.
- * @return The label of item.
+ * @param item The menu item
+ * @return The menu object owning @p item, or NULL on failure
*
- * The return value is a pointer to the label associated to @p item when
- * it was created, with function elm_toolbar_item_append() or similar,
- * or later,
- * with function elm_toolbar_item_label_set. If no label
- * was passed as argument, it will return @c NULL.
+ * Use this function to get the menu object owning an item.
+ */
+ EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
+ /**
+ * @brief Get the selected item in the menu
*
- * @see elm_toolbar_item_label_set() for more details.
- * @see elm_toolbar_item_append()
+ * @param obj The menu object
+ * @return The selected item, or NULL if none
*
- * @ingroup Toolbar
+ * @see elm_menu_item_selected_get()
+ * @see elm_menu_item_selected_set()
*/
- EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
-
+ EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
/**
- * Set the label of item.
- *
- * @param item The item of toolbar.
- * @param text The label of item.
+ * @brief Get the last item in the menu
*
- * The label to be displayed by the item.
- * Label will be placed at icons bottom (if set).
+ * @param obj The menu object
+ * @return The last item, or NULL if none
+ */
+ EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the first item in the menu
*
- * If a label was passed as argument on item creation, with function
- * elm_toolbar_item_append() or similar, it will be already
- * displayed by the item.
+ * @param obj The menu object
+ * @return The first item, or NULL if none
+ */
+ EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the next item in the menu.
*
- * @see elm_toolbar_item_label_get()
- * @see elm_toolbar_item_append()
+ * @param item The menu item object.
+ * @return The item after it, or NULL if none
+ */
+ EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the previous item in the menu.
*
- * @ingroup Toolbar
+ * @param item The menu item object.
+ * @return The item before it, or NULL if none
+ */
+ EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
+ /**
+ * @}
*/
- EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
/**
- * Return the data associated with a given toolbar widget item.
+ * @defgroup List List
+ * @ingroup Elementary
*
- * @param item The toolbar widget item handle.
- * @return The data associated with @p item.
+ * @image html img/widget/list/preview-00.png
+ * @image latex img/widget/list/preview-00.eps width=\textwidth
+ *
+ * @image html img/list.png
+ * @image latex img/list.eps width=\textwidth
+ *
+ * A list widget is a container whose children are displayed vertically or
+ * horizontally, in order, and can be selected.
+ * The list can accept only one or multiple items selection. Also has many
+ * modes of items displaying.
+ *
+ * A list is a very simple type of list widget. For more robust
+ * lists, @ref Genlist should probably be used.
+ *
+ * Smart callbacks one can listen to:
+ * - @c "activated" - The user has double-clicked or pressed
+ * (enter|return|spacebar) on an item. The @c event_info parameter
+ * is the item that was activated.
+ * - @c "clicked,double" - The user has double-clicked an item.
+ * The @c event_info parameter is the item that was double-clicked.
+ * - "selected" - when the user selected an item
+ * - "unselected" - when the user unselected an item
+ * - "longpressed" - an item in the list is long-pressed
+ * - "scroll,edge,top" - the list is scrolled until the top edge
+ * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
+ * - "scroll,edge,left" - the list is scrolled until the left edge
+ * - "scroll,edge,right" - the list is scrolled until the right edge
*
- * @see elm_toolbar_item_data_set()
+ * Available styles for it:
+ * - @c "default"
*
- * @ingroup Toolbar
+ * List of examples:
+ * @li @ref list_example_01
+ * @li @ref list_example_02
+ * @li @ref list_example_03
*/
- EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
/**
- * Set the data associated with a given toolbar widget item.
- *
- * @param item The toolbar widget item handle.
- * @param data The new data pointer to set to @p item.
- *
- * This sets new item data on @p item.
- *
- * @warning The old data pointer won't be touched by this function, so
- * the user had better to free that old data himself/herself.
- *
- * @ingroup Toolbar
+ * @addtogroup List
+ * @{
*/
- EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
/**
- * Returns a pointer to a toolbar item by its label.
- *
- * @param obj The toolbar object.
- * @param label The label of the item to find.
+ * @enum _Elm_List_Mode
+ * @typedef Elm_List_Mode
*
- * @return The pointer to the toolbar item matching @p label or @c NULL
- * on failure.
+ * Set list's resize behavior, transverse axis scroll and
+ * items cropping. See each mode's description for more details.
*
- * @ingroup Toolbar
- */
- EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
-
- /*
- * Get whether the @p item is selected or not.
+ * @note Default value is #ELM_LIST_SCROLL.
*
- * @param item The toolbar item.
- * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
- * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
+ * Values <b> don't </b> work as bitmask, only one can be choosen.
*
- * @see elm_toolbar_selected_item_set() for details.
- * @see elm_toolbar_item_selected_get()
+ * @see elm_list_mode_set()
+ * @see elm_list_mode_get()
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_List_Mode
+ {
+ ELM_LIST_COMPRESS = 0, /**< Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. */
+ ELM_LIST_SCROLL, /**< Default value. Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction (large items will get cropped). */
+ ELM_LIST_LIMIT, /**< Set a minimun size hint on the list object, so that containers may respect it (and resize itself to fit the child properly). More specifically, a minimum size hint will be set for its transverse axis, so that the @b largest item in that direction fits well. Can have effects bounded by setting the list object's maximum size hints. */
+ ELM_LIST_EXPAND, /**< Besides setting a minimum size on the transverse axis, just like the previous mode, will set a minimum size on the longitudinal axis too, trying to reserve space to all its children to be visible at a time. Can have effects bounded by setting the list object's maximum size hints. */
+ ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
+ } Elm_List_Mode;
+
+ typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item. Can be created with elm_list_item_append(), elm_list_item_prepend() and functions to add items in relative positions, like elm_list_item_insert_before(), and deleted with elm_list_item_del(). */
/**
- * Set the selected state of an item.
- *
- * @param item The toolbar item
- * @param selected The selected state
- *
- * This sets the selected state of the given item @p it.
- * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
- *
- * If a new item is selected the previosly selected will be unselected.
- * Previoulsy selected item can be get with function
- * elm_toolbar_selected_item_get().
+ * Add a new list widget to the given parent Elementary
+ * (container) object.
*
- * Selected items will be highlighted.
+ * @param parent The parent object.
+ * @return a new list widget handle or @c NULL, on errors.
*
- * @see elm_toolbar_item_selected_get()
- * @see elm_toolbar_selected_item_get()
+ * This function inserts a new list widget on the canvas.
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Get the selected item.
- *
- * @param obj The toolbar object.
- * @return The selected toolbar item.
+ * Starts the list.
*
- * The selected item can be unselected with function
- * elm_toolbar_item_selected_set().
+ * @param obj The list object
*
- * The selected item always will be highlighted on toolbar.
+ * @note Call before running show() on the list object.
+ * @warning If not called, it won't display the list properly.
*
- * @see elm_toolbar_selected_items_get()
+ * @code
+ * li = elm_list_add(win);
+ * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
+ * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
+ * elm_list_go(li);
+ * evas_object_show(li);
+ * @endcode
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the icon associated with @p item.
- *
- * @param obj The parent of this item.
- * @param item The toolbar item.
- * @param icon A string with icon name or the absolute path of an image file.
- *
- * Toolbar will load icon image from fdo or current theme.
- * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
- * If an absolute path is provided it will load it direct from a file.
+ * Enable or disable multiple items selection on the list object.
*
- * @see elm_toolbar_icon_order_lookup_set()
- * @see elm_toolbar_icon_order_lookup_get()
+ * @param obj The list object
+ * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
+ * disable it.
*
- * @ingroup Toolbar
- */
- EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
-
- /**
- * Get the string used to set the icon of @p item.
+ * Disabled by default. If disabled, the user can select a single item of
+ * the list each time. Selected items are highlighted on list.
+ * If enabled, many items can be selected.
*
- * @param item The toolbar item.
- * @return The string associated with the icon object.
+ * If a selected item is selected again, it will be unselected.
*
- * @see elm_toolbar_item_icon_set() for details.
+ * @see elm_list_multi_select_get()
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
/**
- * Delete them item from the toolbar.
+ * Get a value whether multiple items selection is enabled or not.
*
- * @param item The item of toolbar to be deleted.
+ * @see elm_list_multi_select_set() for details.
*
- * @see elm_toolbar_item_append()
- * @see elm_toolbar_item_del_cb_set()
+ * @param obj The list object.
+ * @return @c EINA_TRUE means multiple items selection is enabled.
+ * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
+ * @c EINA_FALSE is returned.
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the function called when a toolbar item is freed.
- *
- * @param item The item to set the callback on.
- * @param func The function called.
+ * Set which mode to use for the list object.
*
- * If there is a @p func, then it will be called prior item's memory release.
- * That will be called with the following arguments:
- * @li item's data;
- * @li item's Evas object;
- * @li item itself;
+ * @param obj The list object
+ * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
+ * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
*
- * This way, a data associated to a toolbar item could be properly freed.
+ * Set list's resize behavior, transverse axis scroll and
+ * items cropping. See each mode's description for more details.
*
- * @ingroup Toolbar
- */
- EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
-
- /**
- * Get a value whether toolbar item is disabled or not.
+ * @note Default value is #ELM_LIST_SCROLL.
*
- * @param item The item.
- * @return The disabled state.
+ * Only one can be set, if a previous one was set, it will be changed
+ * by the new mode set. Bitmask won't work as well.
*
- * @see elm_toolbar_item_disabled_set() for more details.
+ * @see elm_list_mode_get()
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
/**
- * Sets the disabled/enabled state of a toolbar item.
+ * Get the mode the list is at.
*
- * @param item The item.
- * @param disabled The disabled state.
+ * @param obj The list object
+ * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
+ * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
*
- * A disabled item cannot be selected or unselected. It will also
- * change its appearance (generally greyed out). This sets the
- * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
- * enabled).
+ * @note see elm_list_mode_set() for more information.
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+ EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set or unset item as a separator.
+ * Enable or disable horizontal mode on the list object.
*
- * @param item The toolbar item.
- * @param setting @c EINA_TRUE to set item @p item as separator or
- * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
+ * @param obj The list object.
+ * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
+ * disable it, i.e., to enable vertical mode.
*
- * Items aren't set as separator by default.
+ * @note Vertical mode is set by default.
*
- * If set as separator it will display separator theme, so won't display
- * icons or label.
+ * On horizontal mode items are displayed on list from left to right,
+ * instead of from top to bottom. Also, the list will scroll horizontally.
+ * Each item will presents left icon on top and right icon, or end, at
+ * the bottom.
*
- * @see elm_toolbar_item_separator_get()
+ * @see elm_list_horizontal_get()
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
/**
- * Get a value whether item is a separator or not.
+ * Get a value whether horizontal mode is enabled or not.
*
- * @param item The toolbar item.
- * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
- * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
+ * @param obj The list object.
+ * @return @c EINA_TRUE means horizontal mode selection is enabled.
+ * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
+ * @c EINA_FALSE is returned.
*
- * @see elm_toolbar_item_separator_set() for details.
+ * @see elm_list_horizontal_set() for details.
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the shrink state of toolbar @p obj.
+ * Enable or disable always select mode on the list object.
*
- * @param obj The toolbar object.
- * @param shrink_mode Toolbar's items display behavior.
+ * @param obj The list object
+ * @param always_select @c EINA_TRUE to enable always select mode or
+ * @c EINA_FALSE to disable it.
+ *
+ * @note Always select mode is disabled by default.
+ *
+ * Default behavior of list items is to only call its callback function
+ * the first time it's pressed, i.e., when it is selected. If a selected
+ * item is pressed again, and multi-select is disabled, it won't call
+ * this function (if multi-select is enabled it will unselect the item).
+ *
+ * If always select is enabled, it will call the callback function
+ * everytime a item is pressed, so it will call when the item is selected,
+ * and again when a selected item is pressed.
*
- * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
- * but will enforce a minimun size so all the items will fit, won't scroll
- * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
- * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
- * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
+ * @see elm_list_always_select_mode_get()
+ * @see elm_list_multi_select_set()
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
/**
- * Get the shrink mode of toolbar @p obj.
+ * Get a value whether always select mode is enabled or not, meaning that
+ * an item will always call its callback function, even if already selected.
*
- * @param obj The toolbar object.
- * @return Toolbar's items display behavior.
+ * @param obj The list object
+ * @return @c EINA_TRUE means horizontal mode selection is enabled.
+ * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
+ * @c EINA_FALSE is returned.
*
- * @see elm_toolbar_mode_shrink_set() for details.
+ * @see elm_list_always_select_mode_set() for details.
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Enable/disable homogenous mode.
+ * Set bouncing behaviour when the scrolled content reaches an edge.
*
- * @param obj The toolbar object
- * @param homogeneous Assume the items within the toolbar are of the
- * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
+ * Tell the internal scroller object whether it should bounce or not
+ * when it reaches the respective edges for each axis.
*
- * This will enable the homogeneous mode where items are of the same size.
- * @see elm_toolbar_homogeneous_get()
+ * @param obj The list object
+ * @param h_bounce Whether to bounce or not in the horizontal axis.
+ * @param v_bounce Whether to bounce or not in the vertical axis.
*
- * @ingroup Toolbar
+ * @see elm_scroller_bounce_set()
+ *
+ * @ingroup List
*/
- EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
/**
- * Get whether the homogenous mode is enabled.
+ * Get the bouncing behaviour of the internal scroller.
*
- * @param obj The toolbar object.
- * @return Assume the items within the toolbar are of the same height
- * and width (EINA_TRUE = on, EINA_FALSE = off).
+ * Get whether the internal scroller should bounce when the edge of each
+ * axis is reached scrolling.
*
- * @see elm_toolbar_homogeneous_set()
+ * @param obj The list object.
+ * @param h_bounce Pointer where to store the bounce state of the horizontal
+ * axis.
+ * @param v_bounce Pointer where to store the bounce state of the vertical
+ * axis.
*
- * @ingroup Toolbar
+ * @see elm_scroller_bounce_get()
+ * @see elm_list_bounce_set()
+ *
+ * @ingroup List
*/
- EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
/**
- * Enable/disable homogenous mode.
+ * Set the scrollbar policy.
*
- * @param obj The toolbar object
- * @param homogeneous Assume the items within the toolbar are of the
- * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
+ * @param obj The list object
+ * @param policy_h Horizontal scrollbar policy.
+ * @param policy_v Vertical scrollbar policy.
*
- * This will enable the homogeneous mode where items are of the same size.
- * @see elm_toolbar_homogeneous_get()
+ * This sets the scrollbar visibility policy for the given scroller.
+ * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
+ * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
+ * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
+ * This applies respectively for the horizontal and vertical scrollbars.
*
- * @deprecated use elm_toolbar_homogeneous_set() instead.
+ * The both are disabled by default, i.e., are set to
+ * #ELM_SCROLLER_POLICY_OFF.
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
/**
- * Get whether the homogenous mode is enabled.
+ * Get the scrollbar policy.
*
- * @param obj The toolbar object.
- * @return Assume the items within the toolbar are of the same height
- * and width (EINA_TRUE = on, EINA_FALSE = off).
+ * @see elm_list_scroller_policy_get() for details.
*
- * @see elm_toolbar_homogeneous_set()
- * @deprecated use elm_toolbar_homogeneous_get() instead.
+ * @param obj The list object.
+ * @param policy_h Pointer where to store horizontal scrollbar policy.
+ * @param policy_v Pointer where to store vertical scrollbar policy.
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ 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);
/**
- * Set the parent object of the toolbar items' menus.
+ * Append a new item to the list object.
*
- * @param obj The toolbar object.
- * @param parent The parent of the menu objects.
+ * @param obj The list object.
+ * @param label The label of the list item.
+ * @param icon The icon object to use for the left side of the item. An
+ * icon can be any Evas object, but usually it is an icon created
+ * with elm_icon_add().
+ * @param end The icon object to use for the right side of the item. An
+ * icon can be any Evas object.
+ * @param func The function to call when the item is clicked.
+ * @param data The data to associate with the item for related callbacks.
*
- * Each item can be set as item menu, with elm_toolbar_item_menu_set().
+ * @return The created item or @c NULL upon failure.
*
- * For more details about setting the parent for toolbar menus, see
- * elm_menu_parent_set().
+ * A new item will be created and appended to the list, i.e., will
+ * be set as @b last item.
*
- * @see elm_menu_parent_set() for details.
- * @see elm_toolbar_item_menu_set() for details.
+ * Items created with this method can be deleted with
+ * elm_list_item_del().
*
- * @ingroup Toolbar
- */
- EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
-
- /**
- * Get the parent object of the toolbar items' menus.
+ * Associated @p data can be properly freed when item is deleted if a
+ * callback function is set with elm_list_item_del_cb_set().
*
- * @param obj The toolbar object.
- * @return The parent of the menu objects.
+ * If a function is passed as argument, it will be called everytime this item
+ * is selected, i.e., the user clicks over an unselected item.
+ * If always select is enabled it will call this function every time
+ * user clicks over an item (already selected or not).
+ * If such function isn't needed, just passing
+ * @c NULL as @p func is enough. The same should be done for @p data.
*
- * @see elm_toolbar_menu_parent_set() for details.
+ * Simple example (with no function callback or data associated):
+ * @code
+ * li = elm_list_add(win);
+ * ic = elm_icon_add(win);
+ * elm_icon_file_set(ic, "path/to/image", NULL);
+ * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
+ * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
+ * elm_list_go(li);
+ * evas_object_show(li);
+ * @endcode
*
- * @ingroup Toolbar
+ * @see elm_list_always_select_mode_set()
+ * @see elm_list_item_del()
+ * @see elm_list_item_del_cb_set()
+ * @see elm_list_clear()
+ * @see elm_icon_add()
+ *
+ * @ingroup List
*/
- EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ 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);
/**
- * Set the alignment of the items.
+ * Prepend a new item to the list object.
*
- * @param obj The toolbar object.
- * @param align The new alignment, a float between <tt> 0.0 </tt>
- * and <tt> 1.0 </tt>.
+ * @param obj The list object.
+ * @param label The label of the list item.
+ * @param icon The icon object to use for the left side of the item. An
+ * icon can be any Evas object, but usually it is an icon created
+ * with elm_icon_add().
+ * @param end The icon object to use for the right side of the item. An
+ * icon can be any Evas object.
+ * @param func The function to call when the item is clicked.
+ * @param data The data to associate with the item for related callbacks.
*
- * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
- * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
- * items.
+ * @return The created item or @c NULL upon failure.
*
- * Centered items by default.
+ * A new item will be created and prepended to the list, i.e., will
+ * be set as @b first item.
*
- * @see elm_toolbar_align_get()
+ * Items created with this method can be deleted with
+ * elm_list_item_del().
*
- * @ingroup Toolbar
- */
- EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
-
- /**
- * Get the alignment of the items.
+ * Associated @p data can be properly freed when item is deleted if a
+ * callback function is set with elm_list_item_del_cb_set().
*
- * @param obj The toolbar object.
- * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
- * <tt> 1.0 </tt>.
+ * If a function is passed as argument, it will be called everytime this item
+ * is selected, i.e., the user clicks over an unselected item.
+ * If always select is enabled it will call this function every time
+ * user clicks over an item (already selected or not).
+ * If such function isn't needed, just passing
+ * @c NULL as @p func is enough. The same should be done for @p data.
*
- * @see elm_toolbar_align_set() for details.
+ * @see elm_list_item_append() for a simple code example.
+ * @see elm_list_always_select_mode_set()
+ * @see elm_list_item_del()
+ * @see elm_list_item_del_cb_set()
+ * @see elm_list_clear()
+ * @see elm_icon_add()
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ 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);
/**
- * Set whether the toolbar item opens a menu.
+ * Insert a new item into the list object before item @p before.
*
- * @param item The toolbar item.
- * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
+ * @param obj The list object.
+ * @param before The list item to insert before.
+ * @param label The label of the list item.
+ * @param icon The icon object to use for the left side of the item. An
+ * icon can be any Evas object, but usually it is an icon created
+ * with elm_icon_add().
+ * @param end The icon object to use for the right side of the item. An
+ * icon can be any Evas object.
+ * @param func The function to call when the item is clicked.
+ * @param data The data to associate with the item for related callbacks.
*
- * A toolbar item can be set to be a menu, using this function.
+ * @return The created item or @c NULL upon failure.
*
- * Once it is set to be a menu, it can be manipulated through the
- * menu-like function elm_toolbar_menu_parent_set() and the other
- * elm_menu functions, using the Evas_Object @c menu returned by
- * elm_toolbar_item_menu_get().
+ * A new item will be created and added to the list. Its position in
+ * this list will be just before item @p before.
*
- * So, items to be displayed in this item's menu should be added with
- * elm_menu_item_add().
+ * Items created with this method can be deleted with
+ * elm_list_item_del().
*
- * The following code exemplifies the most basic usage:
- * @code
- * tb = elm_toolbar_add(win)
- * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
- * elm_toolbar_item_menu_set(item, EINA_TRUE);
- * elm_toolbar_menu_parent_set(tb, win);
- * menu = elm_toolbar_item_menu_get(item);
- * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
- * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
- * NULL);
- * @endcode
+ * Associated @p data can be properly freed when item is deleted if a
+ * callback function is set with elm_list_item_del_cb_set().
+ *
+ * If a function is passed as argument, it will be called everytime this item
+ * is selected, i.e., the user clicks over an unselected item.
+ * If always select is enabled it will call this function every time
+ * user clicks over an item (already selected or not).
+ * If such function isn't needed, just passing
+ * @c NULL as @p func is enough. The same should be done for @p data.
*
- * @see elm_toolbar_item_menu_get()
+ * @see elm_list_item_append() for a simple code example.
+ * @see elm_list_always_select_mode_set()
+ * @see elm_list_item_del()
+ * @see elm_list_item_del_cb_set()
+ * @see elm_list_clear()
+ * @see elm_icon_add()
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
+ 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);
/**
- * Get toolbar item's menu.
- *
- * @param item The toolbar item.
- * @return Item's menu object or @c NULL on failure.
+ * Insert a new item into the list object after item @p after.
*
- * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
- * this function will set it.
+ * @param obj The list object.
+ * @param after The list item to insert after.
+ * @param label The label of the list item.
+ * @param icon The icon object to use for the left side of the item. An
+ * icon can be any Evas object, but usually it is an icon created
+ * with elm_icon_add().
+ * @param end The icon object to use for the right side of the item. An
+ * icon can be any Evas object.
+ * @param func The function to call when the item is clicked.
+ * @param data The data to associate with the item for related callbacks.
*
- * @see elm_toolbar_item_menu_set() for details.
+ * @return The created item or @c NULL upon failure.
*
- * @ingroup Toolbar
- */
- EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
-
- /**
- * Add a new state to @p item.
+ * A new item will be created and added to the list. Its position in
+ * this list will be just after item @p after.
*
- * @param item The item.
- * @param icon A string with icon name or the absolute path of an image file.
- * @param label The label of the new state.
- * @param func The function to call when the item is clicked when this
- * state is selected.
- * @param data The data to associate with the state.
- * @return The toolbar item state, or @c NULL upon failure.
+ * Items created with this method can be deleted with
+ * elm_list_item_del().
*
- * Toolbar will load icon image from fdo or current theme.
- * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
- * If an absolute path is provided it will load it direct from a file.
+ * Associated @p data can be properly freed when item is deleted if a
+ * callback function is set with elm_list_item_del_cb_set().
*
- * States created with this function can be removed with
- * elm_toolbar_item_state_del().
+ * If a function is passed as argument, it will be called everytime this item
+ * is selected, i.e., the user clicks over an unselected item.
+ * If always select is enabled it will call this function every time
+ * user clicks over an item (already selected or not).
+ * If such function isn't needed, just passing
+ * @c NULL as @p func is enough. The same should be done for @p data.
*
- * @see elm_toolbar_item_state_del()
- * @see elm_toolbar_item_state_sel()
- * @see elm_toolbar_item_state_get()
+ * @see elm_list_item_append() for a simple code example.
+ * @see elm_list_always_select_mode_set()
+ * @see elm_list_item_del()
+ * @see elm_list_item_del_cb_set()
+ * @see elm_list_clear()
+ * @see elm_icon_add()
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- 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);
+ 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);
/**
- * Delete a previoulsy added state to @p item.
+ * Insert a new item into the sorted list object.
*
- * @param item The toolbar item.
- * @param state The state to be deleted.
- * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
+ * @param obj The list object.
+ * @param label The label of the list item.
+ * @param icon The icon object to use for the left side of the item. An
+ * icon can be any Evas object, but usually it is an icon created
+ * with elm_icon_add().
+ * @param end The icon object to use for the right side of the item. An
+ * icon can be any Evas object.
+ * @param func The function to call when the item is clicked.
+ * @param data The data to associate with the item for related callbacks.
+ * @param cmp_func The comparing function to be used to sort list
+ * items <b>by #Elm_List_Item item handles</b>. This function will
+ * receive two items and compare them, returning a non-negative integer
+ * if the second item should be place after the first, or negative value
+ * if should be placed before.
*
- * @see elm_toolbar_item_state_add()
- */
- EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
-
- /**
- * Set @p state as the current state of @p it.
+ * @return The created item or @c NULL upon failure.
*
- * @param it The item.
- * @param state The state to use.
- * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
+ * @note This function inserts values into a list object assuming it was
+ * sorted and the result will be sorted.
*
- * If @p state is @c NULL, it won't select any state and the default item's
- * icon and label will be used. It's the same behaviour than
- * elm_toolbar_item_state_unser().
+ * A new item will be created and added to the list. Its position in
+ * this list will be found comparing the new item with previously inserted
+ * items using function @p cmp_func.
*
- * @see elm_toolbar_item_state_unset()
+ * Items created with this method can be deleted with
+ * elm_list_item_del().
*
- * @ingroup Toolbar
+ * Associated @p data can be properly freed when item is deleted if a
+ * callback function is set with elm_list_item_del_cb_set().
+ *
+ * If a function is passed as argument, it will be called everytime this item
+ * is selected, i.e., the user clicks over an unselected item.
+ * If always select is enabled it will call this function every time
+ * user clicks over an item (already selected or not).
+ * If such function isn't needed, just passing
+ * @c NULL as @p func is enough. The same should be done for @p data.
+ *
+ * @see elm_list_item_append() for a simple code example.
+ * @see elm_list_always_select_mode_set()
+ * @see elm_list_item_del()
+ * @see elm_list_item_del_cb_set()
+ * @see elm_list_clear()
+ * @see elm_icon_add()
+ *
+ * @ingroup List
*/
- EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
+ 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);
/**
- * Unset the state of @p it.
- *
- * @param it The item.
+ * Remove all list's items.
*
- * The default icon and label from this item will be displayed.
+ * @param obj The list object
*
- * @see elm_toolbar_item_state_set() for more details.
+ * @see elm_list_item_del()
+ * @see elm_list_item_append()
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the current state of @p it.
+ * Get a list of all the list items.
*
- * @param item The item.
- * @return The selected state or @c NULL if none is selected or on failure.
+ * @param obj The list object
+ * @return An @c Eina_List of list items, #Elm_List_Item,
+ * or @c NULL on failure.
*
- * @see elm_toolbar_item_state_set() for details.
- * @see elm_toolbar_item_state_unset()
- * @see elm_toolbar_item_state_add()
+ * @see elm_list_item_append()
+ * @see elm_list_item_del()
+ * @see elm_list_clear()
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
+ EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the state after selected state in toolbar's @p item.
+ * Get the selected item.
*
- * @param it The toolbar item to change state.
- * @return The state after current state, or @c NULL on failure.
+ * @param obj The list object.
+ * @return The selected list item.
*
- * If last state is selected, this function will return first state.
+ * The selected item can be unselected with function
+ * elm_list_item_selected_set().
*
- * @see elm_toolbar_item_state_set()
- * @see elm_toolbar_item_state_add()
+ * The selected item always will be highlighted on list.
*
- * @ingroup Toolbar
+ * @see elm_list_selected_items_get()
+ *
+ * @ingroup List
*/
- EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
+ EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the state before selected state in toolbar's @p item.
+ * Return a list of the currently selected list items.
*
- * @param it The toolbar item to change state.
- * @return The state before current state, or @c NULL on failure.
+ * @param obj The list object.
+ * @return An @c Eina_List of list items, #Elm_List_Item,
+ * or @c NULL on failure.
*
- * If first state is selected, this function will return last state.
+ * Multiple items can be selected if multi select is enabled. It can be
+ * done with elm_list_multi_select_set().
*
- * @see elm_toolbar_item_state_set()
- * @see elm_toolbar_item_state_add()
+ * @see elm_list_selected_item_get()
+ * @see elm_list_multi_select_set()
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
+ EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the text to be shown in a given toolbar item's tooltips.
+ * Set the selected state of an item.
*
- * @param item Target item.
- * @param text The text to set in the content.
+ * @param item The list item
+ * @param selected The selected state
*
- * Setup the text as tooltip to object. The item can have only one tooltip,
- * so any previous tooltip data - set with this function or
- * elm_toolbar_item_tooltip_content_cb_set() - is removed.
+ * This sets the selected state of the given item @p it.
+ * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
*
- * @see elm_object_tooltip_text_set() for more details.
+ * If a new item is selected the previosly selected will be unselected,
+ * unless multiple selection is enabled with elm_list_multi_select_set().
+ * Previoulsy selected item can be get with function
+ * elm_list_selected_item_get().
*
- * @ingroup Toolbar
+ * Selected items will be highlighted.
+ *
+ * @see elm_list_item_selected_get()
+ * @see elm_list_selected_item_get()
+ * @see elm_list_multi_select_set()
+ *
+ * @ingroup List
*/
- EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
- /**
- * Set the content to be shown in the tooltip item.
- *
- * Setup the tooltip to item. The item can have only one tooltip,
- * so any previous tooltip data is removed. @p func(with @p data) will
- * be called every time that need show the tooltip and it should
- * return a valid Evas_Object. This object is then managed fully by
- * tooltip system and is deleted when the tooltip is gone.
+ /*
+ * Get whether the @p item is selected or not.
*
- * @param item the toolbar item being attached a tooltip.
- * @param func the function used to create the tooltip contents.
- * @param data what to provide to @a func as callback data/context.
- * @param del_cb called when data is not needed anymore, either when
- * another callback replaces @a func, the tooltip is unset with
- * elm_toolbar_item_tooltip_unset() or the owner @a item
- * dies. This callback receives as the first parameter the
- * given @a data, and @c event_info is the item.
+ * @param item The list item.
+ * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
+ * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
*
- * @see elm_object_tooltip_content_cb_set() for more details.
+ * @see elm_list_selected_item_set() for details.
+ * @see elm_list_item_selected_get()
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- 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);
+ EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
/**
- * Unset tooltip from item.
+ * Set or unset item as a separator.
*
- * @param item toolbar item to remove previously set tooltip.
+ * @param it The list item.
+ * @param setting @c EINA_TRUE to set item @p it as separator or
+ * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
*
- * Remove tooltip from item. The callback provided as del_cb to
- * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
- * it is not used anymore.
+ * Items aren't set as separator by default.
*
- * @see elm_object_tooltip_unset() for more details.
- * @see elm_toolbar_item_tooltip_content_cb_set()
+ * If set as separator it will display separator theme, so won't display
+ * icons or label.
*
- * @ingroup Toolbar
+ * @see elm_list_item_separator_get()
+ *
+ * @ingroup List
*/
- EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
/**
- * Sets a different style for this item tooltip.
- *
- * @note before you set a style you should define a tooltip with
- * elm_toolbar_item_tooltip_content_cb_set() or
- * elm_toolbar_item_tooltip_text_set()
+ * Get a value whether item is a separator or not.
*
- * @param item toolbar item with tooltip already set.
- * @param style the theme style to use (default, transparent, ...)
+ * @see elm_list_item_separator_set() for details.
*
- * @see elm_object_tooltip_style_set() for more details.
+ * @param it The list item.
+ * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
+ * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
/**
- * Get the style for this item tooltip.
+ * Show @p item in the list view.
*
- * @param item toolbar item with tooltip already set.
- * @return style the theme style in use, defaults to "default". If the
- * object does not have a tooltip set, then NULL is returned.
+ * @param item The list item to be shown.
*
- * @see elm_object_tooltip_style_get() for more details.
- * @see elm_toolbar_item_tooltip_style_set()
+ * It won't animate list until item is visible. If such behavior is wanted,
+ * use elm_list_bring_in() intead.
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
/**
- * Set the type of mouse pointer/cursor decoration to be shown,
- * when the mouse pointer is over the given toolbar widget item
+ * Bring in the given item to list view.
*
- * @param item toolbar item to customize cursor on
- * @param cursor the cursor type's name
+ * @param item The item.
*
- * This function works analogously as elm_object_cursor_set(), but
- * here the cursor's changing area is restricted to the item's
- * area, and not the whole widget's. Note that that item cursors
- * have precedence over widget cursors, so that a mouse over an
- * item with custom cursor set will always show @b that cursor.
+ * This causes list to jump to the given item @p item and show it
+ * (by scrolling), if it is not fully visible.
*
- * If this function is called twice for an object, a previously set
- * cursor will be unset on the second call.
+ * This may use animation to do so and take a period of time.
*
- * @see elm_object_cursor_set()
- * @see elm_toolbar_item_cursor_get()
- * @see elm_toolbar_item_cursor_unset()
+ * If animation isn't wanted, elm_list_item_show() can be used.
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
- /*
- * Get the type of mouse pointer/cursor decoration set to be shown,
- * when the mouse pointer is over the given toolbar widget item
+ /**
+ * Delete them item from the list.
*
- * @param item toolbar item with custom cursor set
- * @return the cursor type's name or @c NULL, if no custom cursors
- * were set to @p item (and on errors)
+ * @param item The item of list to be deleted.
*
- * @see elm_object_cursor_get()
- * @see elm_toolbar_item_cursor_set()
- * @see elm_toolbar_item_cursor_unset()
+ * If deleting all list items is required, elm_list_clear()
+ * should be used instead of getting items list and deleting each one.
*
- * @ingroup Toolbar
+ * @see elm_list_clear()
+ * @see elm_list_item_append()
+ * @see elm_list_item_del_cb_set()
+ *
+ * @ingroup List
*/
- EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
/**
- * Unset any custom mouse pointer/cursor decoration set to be
- * shown, when the mouse pointer is over the given toolbar widget
- * item, thus making it show the @b default cursor again.
+ * Set the function called when a list item is freed.
*
- * @param item a toolbar item
+ * @param item The item to set the callback on
+ * @param func The function called
*
- * Use this call to undo any custom settings on this item's cursor
- * decoration, bringing it back to defaults (no custom style set).
+ * If there is a @p func, then it will be called prior item's memory release.
+ * That will be called with the following arguments:
+ * @li item's data;
+ * @li item's Evas object;
+ * @li item itself;
*
- * @see elm_object_cursor_unset()
- * @see elm_toolbar_item_cursor_set()
+ * This way, a data associated to a list item could be properly freed.
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
/**
- * Set a different @b style for a given custom cursor set for a
- * toolbar item.
- *
- * @param item toolbar item with custom cursor set
- * @param style the <b>theme style</b> to use (e.g. @c "default",
- * @c "transparent", etc)
+ * Get the data associated to the item.
*
- * This function only makes sense when one is using custom mouse
- * cursor decorations <b>defined in a theme file</b>, which can have,
- * given a cursor name/type, <b>alternate styles</b> on it. It
- * works analogously as elm_object_cursor_style_set(), but here
- * applyed only to toolbar item objects.
+ * @param item The list item
+ * @return The data associated to @p item
*
- * @warning Before you set a cursor style you should have definen a
- * custom cursor previously on the item, with
- * elm_toolbar_item_cursor_set()
+ * The return value is a pointer to data associated to @p item when it was
+ * created, with function elm_list_item_append() or similar. If no data
+ * was passed as argument, it will return @c NULL.
*
- * @see elm_toolbar_item_cursor_engine_only_set()
- * @see elm_toolbar_item_cursor_style_get()
+ * @see elm_list_item_append()
*
- * @ingroup Toolbar
+ * @ingroup List
*/
- EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
+ EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
/**
- * Get the current @b style set for a given toolbar item's custom
- * cursor
+ * Get the left side icon associated to the item.
*
- * @param item toolbar item with custom cursor set.
- * @return style the cursor style in use. If the object does not
- * have a cursor set, then @c NULL is returned.
+ * @param item The list item
+ * @return The left side icon associated to @p item
*
- * @see elm_toolbar_item_cursor_style_set() for more details
+ * The return value is a pointer to the icon associated to @p item when
+ * it was
+ * created, with function elm_list_item_append() or similar, or later
+ * with function elm_list_item_icon_set(). If no icon
+ * was passed as argument, it will return @c NULL.
*
- * @ingroup Toolbar
+ * @see elm_list_item_append()
+ * @see elm_list_item_icon_set()
+ *
+ * @ingroup List
*/
- EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
/**
- * Set if the (custom)cursor for a given toolbar item should be
- * searched in its theme, also, or should only rely on the
- * rendering engine.
+ * Set the left side icon associated to the item.
*
- * @param item item with custom (custom) cursor already set on
- * @param engine_only Use @c EINA_TRUE to have cursors looked for
- * only on those provided by the rendering engine, @c EINA_FALSE to
- * have them searched on the widget's theme, as well.
+ * @param item The list item
+ * @param icon The left side icon object to associate with @p item
*
- * @note This call is of use only if you've set a custom cursor
- * for toolbar items, with elm_toolbar_item_cursor_set().
+ * The icon object to use at left side of the item. An
+ * icon can be any Evas object, but usually it is an icon created
+ * with elm_icon_add().
*
- * @note By default, cursors will only be looked for between those
- * provided by the rendering engine.
+ * Once the icon object is set, a previously set one will be deleted.
+ * @warning Setting the same icon for two items will cause the icon to
+ * dissapear from the first item.
*
- * @ingroup Toolbar
+ * If an icon was passed as argument on item creation, with function
+ * elm_list_item_append() or similar, it will be already
+ * associated to the item.
+ *
+ * @see elm_list_item_append()
+ * @see elm_list_item_icon_get()
+ *
+ * @ingroup List
*/
- EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
/**
- * Get if the (custom) cursor for a given toolbar item is being
- * searched in its theme, also, or is only relying on the rendering
- * engine.
+ * Get the right side icon associated to the item.
*
- * @param item a toolbar item
- * @return @c EINA_TRUE, if cursors are being looked for only on
- * those provided by the rendering engine, @c EINA_FALSE if they
- * are being searched on the widget's theme, as well.
+ * @param item The list item
+ * @return The right side icon associated to @p item
*
- * @see elm_toolbar_item_cursor_engine_only_set(), for more details
+ * The return value is a pointer to the icon associated to @p item when
+ * it was
+ * created, with function elm_list_item_append() or similar, or later
+ * with function elm_list_item_icon_set(). If no icon
+ * was passed as argument, it will return @c NULL.
*
- * @ingroup Toolbar
- */
- EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
-
- /**
- * @}
+ * @see elm_list_item_append()
+ * @see elm_list_item_icon_set()
+ *
+ * @ingroup List
*/
-
- /* tooltip */
- EAPI double elm_tooltip_delay_get(void);
- EAPI Eina_Bool elm_tooltip_delay_set(double delay);
- EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
- 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);
- EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
- EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
- EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
- EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
-
- /* cursors */
- EAPI int elm_cursor_engine_only_get(void);
- EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
+ EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
/**
- * @defgroup Menu Menu
+ * Set the right side icon associated to the item.
+ *
+ * @param item The list item
+ * @param end The right side icon object to associate with @p item
+ *
+ * The icon object to use at right side of the item. An
+ * icon can be any Evas object, but usually it is an icon created
+ * with elm_icon_add().
*
- * @image html img/widget/menu/preview-00.png
- * @image latex img/widget/menu/preview-00.eps
+ * Once the icon object is set, a previously set one will be deleted.
+ * @warning Setting the same icon for two items will cause the icon to
+ * dissapear from the first item.
*
- * A menu is a list of items displayed above its parent. When the menu is
- * showing its parent is darkened. Each item can have a sub-menu. The menu
- * object can be used to display a menu on a right click event, in a toolbar,
- * anywhere.
+ * If an icon was passed as argument on item creation, with function
+ * elm_list_item_append() or similar, it will be already
+ * associated to the item.
*
- * Signals that you can add callbacks for are:
- * @li "clicked" - the user clicked the empty space in the menu to dismiss.
- * event_info is NULL.
+ * @see elm_list_item_append()
+ * @see elm_list_item_end_get()
*
- * @see @ref tutorial_menu
- * @{
+ * @ingroup List
*/
- typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
+ EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
+
/**
- * @brief Add a new menu to the parent
+ * Gets the base object of the item.
*
- * @param parent The parent object.
- * @return The new object or NULL if it cannot be created.
- */
- EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the parent for the given menu widget
+ * @param item The list item
+ * @return The base object associated with @p item
*
- * @param obj The menu object.
- * @param parent The new parent.
+ * Base object is the @c Evas_Object that represents that item.
+ *
+ * @ingroup List
*/
- EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the parent for the given menu widget
+ * Get the label of item.
*
- * @param obj The menu object.
- * @return The parent.
+ * @param item The item of list.
+ * @return The label of item.
*
- * @see elm_menu_parent_set()
+ * The return value is a pointer to the label associated to @p item when
+ * it was created, with function elm_list_item_append(), or later
+ * with function elm_list_item_label_set. If no label
+ * was passed as argument, it will return @c NULL.
+ *
+ * @see elm_list_item_label_set() for more details.
+ * @see elm_list_item_append()
+ *
+ * @ingroup List
*/
- EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief Move the menu to a new position
+ * Set the label of item.
*
- * @param obj The menu object.
- * @param x The new position.
- * @param y The new position.
+ * @param item The item of list.
+ * @param text The label of item.
*
- * Sets the top-left position of the menu to (@p x,@p y).
+ * The label to be displayed by the item.
+ * Label will be placed between left and right side icons (if set).
*
- * @note @p x and @p y coordinates are relative to parent.
- */
- EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
- /**
- * @brief Close a opened menu
+ * If a label was passed as argument on item creation, with function
+ * elm_list_item_append() or similar, it will be already
+ * displayed by the item.
*
- * @param obj the menu object
- * @return void
+ * @see elm_list_item_label_get()
+ * @see elm_list_item_append()
*
- * Hides the menu and all it's sub-menus.
+ * @ingroup List
*/
- EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
+
+
/**
- * @brief Returns a list of @p item's items.
+ * Get the item before @p it in list.
*
- * @param obj The menu object
- * @return An Eina_List* of @p item's items
- */
- EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Get the Evas_Object of an Elm_Menu_Item
+ * @param it The list item.
+ * @return The item before @p it, or @c NULL if none or on failure.
*
- * @param item The menu item object.
- * @return The edje object containing the swallowed content
+ * @note If it is the first item, @c NULL will be returned.
*
- * @warning Don't manipulate this object!
- */
- EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
- /**
- * @brief Add an item at the end of the given menu widget
+ * @see elm_list_item_append()
+ * @see elm_list_items_get()
*
- * @param obj The menu object.
- * @param parent The parent menu item (optional)
- * @param icon A icon display on the item. The icon will be destryed by the menu.
- * @param label The label of the item.
- * @param func Function called when the user select the item.
- * @param data Data sent by the callback.
- * @return Returns the new item.
+ * @ingroup List
*/
- 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);
+ EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
+
/**
- * @brief Add an object swallowed in an item at the end of the given menu
- * widget
+ * Get the item after @p it in list.
*
- * @param obj The menu object.
- * @param parent The parent menu item (optional)
- * @param subobj The object to swallow
- * @param func Function called when the user select the item.
- * @param data Data sent by the callback.
- * @return Returns the new item.
+ * @param it The list item.
+ * @return The item after @p it, or @c NULL if none or on failure.
*
- * Add an evas object as an item to the menu.
- */
- EAPI Elm_Menu_Item *elm_menu_item_add_object(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the label of a menu item
+ * @note If it is the last item, @c NULL will be returned.
*
- * @param item The menu item object.
- * @param label The label to set for @p item
+ * @see elm_list_item_append()
+ * @see elm_list_items_get()
*
- * @warning Don't use this funcion on items created with
- * elm_menu_item_add_object() or elm_menu_item_separator_add().
+ * @ingroup List
*/
- EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
+ EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the label of a menu item
+ * Sets the disabled/enabled state of a list item.
*
- * @param item The menu item object.
- * @return The label of @p item
+ * @param it The item.
+ * @param disabled The disabled state.
+ *
+ * A disabled item cannot be selected or unselected. It will also
+ * change its appearance (generally greyed out). This sets the
+ * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
+ * enabled).
+ *
+ * @ingroup List
*/
- EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the icon of a menu item to the standard icon with name @p icon
+ * Get a value whether list item is disabled or not.
*
- * @param item The menu item object.
- * @param icon The icon object to set for the content of @p item
+ * @param it The item.
+ * @return The disabled state.
*
- * Once this icon is set, any previously set icon will be deleted.
+ * @see elm_list_item_disabled_set() for more details.
+ *
+ * @ingroup List
*/
- EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
+ EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the string representation from the icon of a menu item
+ * Set the text to be shown in a given list item's tooltips.
*
- * @param item The menu item object.
- * @return The string representation of @p item's icon or NULL
+ * @param item Target item.
+ * @param text The text to set in the content.
*
- * @see elm_menu_item_object_icon_name_set()
+ * Setup the text as tooltip to object. The item can have only one tooltip,
+ * so any previous tooltip data - set with this function or
+ * elm_list_item_tooltip_content_cb_set() - is removed.
+ *
+ * @see elm_object_tooltip_text_set() for more details.
+ *
+ * @ingroup List
*/
- EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
+
+
/**
- * @deprecated Use elm_menu_item_object_icon_name_set()
+ * @brief Disable size restrictions on an object's tooltip
+ * @param item The tooltip's anchor object
+ * @param disable If EINA_TRUE, size restrictions are disabled
+ * @return EINA_FALSE on failure, EINA_TRUE on success
+ *
+ * This function allows a tooltip to expand beyond its parant window's canvas.
+ * It will instead be limited only by the size of the display.
*/
- EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2) EINA_DEPRECATED;
+ EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
/**
- * @deprecated Use elm_menu_item_object_icon_name_get()
+ * @brief Retrieve size restriction state of an object's tooltip
+ * @param obj The tooltip's anchor object
+ * @return If EINA_TRUE, size restrictions are disabled
+ *
+ * This function returns whether a tooltip is allowed to expand beyond
+ * its parant window's canvas.
+ * It will instead be limited only by the size of the display.
*/
- EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
+ EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the content object of a menu item
+ * Set the content to be shown in the tooltip item.
*
- * @param item The menu item object
- * @param The content object or NULL
- * @return EINA_TRUE on success, else EINA_FALSE
+ * Setup the tooltip to item. The item can have only one tooltip,
+ * so any previous tooltip data is removed. @p func(with @p data) will
+ * be called every time that need show the tooltip and it should
+ * return a valid Evas_Object. This object is then managed fully by
+ * tooltip system and is deleted when the tooltip is gone.
*
- * Use this function to change the object swallowed by a menu item, deleting
- * any previously swallowed object.
- */
- EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Get the content object of a menu item
+ * @param item the list item being attached a tooltip.
+ * @param func the function used to create the tooltip contents.
+ * @param data what to provide to @a func as callback data/context.
+ * @param del_cb called when data is not needed anymore, either when
+ * another callback replaces @a func, the tooltip is unset with
+ * elm_list_item_tooltip_unset() or the owner @a item
+ * dies. This callback receives as the first parameter the
+ * given @a data, and @c event_info is the item.
*
- * @param item The menu item object
- * @return The content object or NULL
- * @note If @p item was added with elm_menu_item_add_object, this
- * function will return the object passed, else it will return the
- * icon object.
+ * @see elm_object_tooltip_content_cb_set() for more details.
*
- * @see elm_menu_item_object_content_set()
- */
- EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
- /**
- * @deprecated Use elm_menu_item_object_content_get() instead.
+ * @ingroup List
*/
- EAPI Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
+ 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);
+
/**
- * @brief Set the selected state of @p item.
+ * Unset tooltip from item.
+ *
+ * @param item list item to remove previously set tooltip.
+ *
+ * Remove tooltip from item. The callback provided as del_cb to
+ * elm_list_item_tooltip_content_cb_set() will be called to notify
+ * it is not used anymore.
+ *
+ * @see elm_object_tooltip_unset() for more details.
+ * @see elm_list_item_tooltip_content_cb_set()
*
- * @param item The menu item object.
- * @param selected The selected/unselected state of the item
+ * @ingroup List
*/
- EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the selected state of @p item.
+ * Sets a different style for this item tooltip.
*
- * @param item The menu item object.
- * @return The selected/unselected state of the item
+ * @note before you set a style you should define a tooltip with
+ * elm_list_item_tooltip_content_cb_set() or
+ * elm_list_item_tooltip_text_set()
*
- * @see elm_menu_item_selected_set()
- */
- EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the disabled state of @p item.
+ * @param item list item with tooltip already set.
+ * @param style the theme style to use (default, transparent, ...)
*
- * @param item The menu item object.
- * @param disabled The enabled/disabled state of the item
+ * @see elm_object_tooltip_style_set() for more details.
+ *
+ * @ingroup List
*/
- EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the disabled state of @p item.
+ * Get the style for this item tooltip.
*
- * @param item The menu item object.
- * @return The enabled/disabled state of the item
+ * @param item list item with tooltip already set.
+ * @return style the theme style in use, defaults to "default". If the
+ * object does not have a tooltip set, then NULL is returned.
*
- * @see elm_menu_item_disabled_set()
+ * @see elm_object_tooltip_style_get() for more details.
+ * @see elm_list_item_tooltip_style_set()
+ *
+ * @ingroup List
*/
- EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief Add a separator item to menu @p obj under @p parent.
+ * Set the type of mouse pointer/cursor decoration to be shown,
+ * when the mouse pointer is over the given list widget item
*
- * @param obj The menu object
- * @param parent The item to add the separator under
- * @return The created item or NULL on failure
+ * @param item list item to customize cursor on
+ * @param cursor the cursor type's name
*
- * This is item is a @ref Separator.
- */
- EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
- /**
- * @brief Returns whether @p item is a separator.
+ * This function works analogously as elm_object_cursor_set(), but
+ * here the cursor's changing area is restricted to the item's
+ * area, and not the whole widget's. Note that that item cursors
+ * have precedence over widget cursors, so that a mouse over an
+ * item with custom cursor set will always show @b that cursor.
*
- * @param item The item to check
- * @return If true, @p item is a separator
+ * If this function is called twice for an object, a previously set
+ * cursor will be unset on the second call.
*
- * @see elm_menu_item_separator_add()
+ * @see elm_object_cursor_set()
+ * @see elm_list_item_cursor_get()
+ * @see elm_list_item_cursor_unset()
+ *
+ * @ingroup List
*/
- EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
- /**
- * @brief Deletes an item from the menu.
+ EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
+
+ /*
+ * Get the type of mouse pointer/cursor decoration set to be shown,
+ * when the mouse pointer is over the given list widget item
*
- * @param item The item to delete.
+ * @param item list item with custom cursor set
+ * @return the cursor type's name or @c NULL, if no custom cursors
+ * were set to @p item (and on errors)
*
- * @see elm_menu_item_add()
+ * @see elm_object_cursor_get()
+ * @see elm_list_item_cursor_set()
+ * @see elm_list_item_cursor_unset()
+ *
+ * @ingroup List
*/
- EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the function called when a menu item is deleted.
+ * Unset any custom mouse pointer/cursor decoration set to be
+ * shown, when the mouse pointer is over the given list widget
+ * item, thus making it show the @b default cursor again.
*
- * @param item The item to set the callback on
- * @param func The function called
+ * @param item a list item
*
- * @see elm_menu_item_add()
- * @see elm_menu_item_del()
- */
- EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
- /**
- * @brief Returns the data associated with menu item @p item.
+ * Use this call to undo any custom settings on this item's cursor
+ * decoration, bringing it back to defaults (no custom style set).
*
- * @param item The item
- * @return The data associated with @p item or NULL if none was set.
+ * @see elm_object_cursor_unset()
+ * @see elm_list_item_cursor_set()
*
- * This is the data set with elm_menu_add() or elm_menu_item_data_set().
+ * @ingroup List
*/
- EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief Sets the data to be associated with menu item @p item.
+ * Set a different @b style for a given custom cursor set for a
+ * list item.
*
- * @param item The item
- * @param data The data to be associated with @p item
- */
- EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
- /**
- * @brief Returns a list of @p item's subitems.
+ * @param item list item with custom cursor set
+ * @param style the <b>theme style</b> to use (e.g. @c "default",
+ * @c "transparent", etc)
*
- * @param item The item
- * @return An Eina_List* of @p item's subitems
+ * This function only makes sense when one is using custom mouse
+ * cursor decorations <b>defined in a theme file</b>, which can have,
+ * given a cursor name/type, <b>alternate styles</b> on it. It
+ * works analogously as elm_object_cursor_style_set(), but here
+ * applyed only to list item objects.
*
- * @see elm_menu_add()
+ * @warning Before you set a cursor style you should have definen a
+ * custom cursor previously on the item, with
+ * elm_list_item_cursor_set()
+ *
+ * @see elm_list_item_cursor_engine_only_set()
+ * @see elm_list_item_cursor_style_get()
+ *
+ * @ingroup List
*/
- EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the position of a menu item
+ * Get the current @b style set for a given list item's custom
+ * cursor
*
- * @param item The menu item
- * @return The item's index
+ * @param item list item with custom cursor set.
+ * @return style the cursor style in use. If the object does not
+ * have a cursor set, then @c NULL is returned.
*
- * This function returns the index position of a menu item in a menu.
- * For a sub-menu, this number is relative to the first item in the sub-menu.
+ * @see elm_list_item_cursor_style_set() for more details
*
- * @note Index values begin with 0
+ * @ingroup List
*/
- EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
+ EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief @brief Return a menu item's owner menu
+ * Set if the (custom)cursor for a given list item should be
+ * searched in its theme, also, or should only rely on the
+ * rendering engine.
*
- * @param item The menu item
- * @return The menu object owning @p item, or NULL on failure
+ * @param item item with custom (custom) cursor already set on
+ * @param engine_only Use @c EINA_TRUE to have cursors looked for
+ * only on those provided by the rendering engine, @c EINA_FALSE to
+ * have them searched on the widget's theme, as well.
*
- * Use this function to get the menu object owning an item.
- */
- EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
- /**
- * @brief Get the selected item in the menu
+ * @note This call is of use only if you've set a custom cursor
+ * for list items, with elm_list_item_cursor_set().
*
- * @param obj The menu object
- * @return The selected item, or NULL if none
+ * @note By default, cursors will only be looked for between those
+ * provided by the rendering engine.
*
- * @see elm_menu_item_selected_get()
- * @see elm_menu_item_selected_set()
+ * @ingroup List
*/
- EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the last item in the menu
+ * Get if the (custom) cursor for a given list item is being
+ * searched in its theme, also, or is only relying on the rendering
+ * engine.
*
- * @param obj The menu object
- * @return The last item, or NULL if none
- */
- EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Get the first item in the menu
+ * @param item a list item
+ * @return @c EINA_TRUE, if cursors are being looked for only on
+ * those provided by the rendering engine, @c EINA_FALSE if they
+ * are being searched on the widget's theme, as well.
*
- * @param obj The menu object
- * @return The first item, or NULL if none
+ * @see elm_list_item_cursor_engine_only_set(), for more details
+ *
+ * @ingroup List
*/
- EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the next item in the menu.
- *
- * @param item The menu item object.
- * @return The item after it, or NULL if none
+ * @}
*/
- EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the previous item in the menu.
+ * @defgroup Slider Slider
+ * @ingroup Elementary
+ *
+ * @image html img/widget/slider/preview-00.png
+ * @image latex img/widget/slider/preview-00.eps width=\textwidth
+ *
+ * The slider adds a dragable “slider” widget for selecting the value of
+ * something within a range.
+ *
+ * A slider can be horizontal or vertical. It can contain an Icon and has a
+ * primary label as well as a units label (that is formatted with floating
+ * point values and thus accepts a printf-style format string, like
+ * “%1.2f units”. There is also an indicator string that may be somewhere
+ * else (like on the slider itself) that also accepts a format string like
+ * units. Label, Icon Unit and Indicator strings/objects are optional.
+ *
+ * A slider may be inverted which means values invert, with high vales being
+ * on the left or top and low values on the right or bottom (as opposed to
+ * normally being low on the left or top and high on the bottom and right).
+ *
+ * The slider should have its minimum and maximum values set by the
+ * application with elm_slider_min_max_set() and value should also be set by
+ * the application before use with elm_slider_value_set(). The span of the
+ * slider is its length (horizontally or vertically). This will be scaled by
+ * the object or applications scaling factor. At any point code can query the
+ * slider for its value with elm_slider_value_get().
+ *
+ * Smart callbacks one can listen to:
+ * - "changed" - Whenever the slider value is changed by the user.
+ * - "slider,drag,start" - dragging the slider indicator around has started.
+ * - "slider,drag,stop" - dragging the slider indicator around has stopped.
+ * - "delay,changed" - A short time after the value is changed by the user.
+ * This will be called only when the user stops dragging for
+ * a very short period or when they release their
+ * finger/mouse, so it avoids possibly expensive reactions to
+ * the value change.
*
- * @param item The menu item object.
- * @return The item before it, or NULL if none
+ * Available styles for it:
+ * - @c "default"
+ *
+ * Here is an example on its usage:
+ * @li @ref slider_example
*/
- EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
+
/**
- * @}
+ * @addtogroup Slider
+ * @{
*/
/**
- * @defgroup List List
- * @ingroup Elementary
+ * Add a new slider widget to the given parent Elementary
+ * (container) object.
*
- * @image html img/widget/list/preview-00.png
- * @image latex img/widget/list/preview-00.eps width=\textwidth
+ * @param parent The parent object.
+ * @return a new slider widget handle or @c NULL, on errors.
*
- * @image html img/list.png
- * @image latex img/list.eps width=\textwidth
+ * This function inserts a new slider widget on the canvas.
*
- * A list widget is a container whose children are displayed vertically or
- * horizontally, in order, and can be selected.
- * The list can accept only one or multiple items selection. Also has many
- * modes of items displaying.
+ * @ingroup Slider
+ */
+ EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the label of a given slider widget
*
- * A list is a very simple type of list widget. For more robust
- * lists, @ref Genlist should probably be used.
+ * @param obj The progress bar object
+ * @param label The text label string, in UTF-8
*
- * Smart callbacks one can listen to:
- * - @c "activated" - The user has double-clicked or pressed
- * (enter|return|spacebar) on an item. The @c event_info parameter
- * is the item that was activated.
- * - @c "clicked,double" - The user has double-clicked an item.
- * The @c event_info parameter is the item that was double-clicked.
- * - "selected" - when the user selected an item
- * - "unselected" - when the user unselected an item
- * - "longpressed" - an item in the list is long-pressed
- * - "scroll,edge,top" - the list is scrolled until the top edge
- * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
- * - "scroll,edge,left" - the list is scrolled until the left edge
- * - "scroll,edge,right" - the list is scrolled until the right edge
+ * @ingroup Slider
+ * @deprecated use elm_object_text_set() instead.
+ */
+ EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the label of a given slider widget
*
- * Available styles for it:
- * - @c "default"
+ * @param obj The progressbar object
+ * @return The text label string, in UTF-8
*
- * List of examples:
- * @li @ref list_example_01
- * @li @ref list_example_02
- * @li @ref list_example_03
+ * @ingroup Slider
+ * @deprecated use elm_object_text_get() instead.
*/
+ EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @addtogroup List
- * @{
+ * Set the icon object of the slider object.
+ *
+ * @param obj The slider object.
+ * @param icon The icon object.
+ *
+ * On horizontal mode, icon is placed at left, and on vertical mode,
+ * placed at top.
+ *
+ * @note Once the icon object is set, a previously set one will be deleted.
+ * If you want to keep that old content object, use the
+ * elm_slider_icon_unset() function.
+ *
+ * @warning If the object being set does not have minimum size hints set,
+ * it won't get properly displayed.
+ *
+ * @ingroup Slider
*/
+ EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
/**
- * @enum _Elm_List_Mode
- * @typedef Elm_List_Mode
+ * Unset an icon set on a given slider widget.
*
- * Set list's resize behavior, transverse axis scroll and
- * items cropping. See each mode's description for more details.
+ * @param obj The slider object.
+ * @return The icon object that was being used, if any was set, or
+ * @c NULL, otherwise (and on errors).
*
- * @note Default value is #ELM_LIST_SCROLL.
+ * On horizontal mode, icon is placed at left, and on vertical mode,
+ * placed at top.
*
- * Values <b> don't </b> work as bitmaks, only one can be choosen.
+ * This call will unparent and return the icon object which was set
+ * for this widget, previously, on success.
*
- * @see elm_list_mode_set()
- * @see elm_list_mode_get()
+ * @see elm_slider_icon_set() for more details
+ * @see elm_slider_icon_get()
*
- * @ingroup List
+ * @ingroup Slider
*/
- typedef enum _Elm_List_Mode
- {
- ELM_LIST_COMPRESS = 0, /**< Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. */
- ELM_LIST_SCROLL, /**< Default value. Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction (large items will get cropped). */
- ELM_LIST_LIMIT, /**< Set a minimun size hint on the list object, so that containers may respect it (and resize itself to fit the child properly). More specifically, a minimum size hint will be set for its transverse axis, so that the @b largest item in that direction fits well. Can have effects bounded by setting the list object's maximum size hints. */
- ELM_LIST_EXPAND, /**< Besides setting a minimum size on the transverse axis, just like the previous mode, will set a minimum size on the longitudinal axis too, trying to reserve space to all its children to be visible at a time. Can have effects bounded by setting the list object's maximum size hints. */
- ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
- } Elm_List_Mode;
-
- typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item. Can be created with elm_list_item_append(), elm_list_item_prepend() and functions to add items in relative positions, like elm_list_item_insert_before(), and deleted with elm_list_item_del(). */
+ EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Add a new list widget to the given parent Elementary
- * (container) object.
+ * Retrieve the icon object set for a given slider widget.
*
- * @param parent The parent object.
- * @return a new list widget handle or @c NULL, on errors.
+ * @param obj The slider object.
+ * @return The icon object's handle, if @p obj had one set, or @c NULL,
+ * otherwise (and on errors).
*
- * This function inserts a new list widget on the canvas.
+ * On horizontal mode, icon is placed at left, and on vertical mode,
+ * placed at top.
*
- * @ingroup List
+ * @see elm_slider_icon_set() for more details
+ * @see elm_slider_icon_unset()
+ *
+ * @ingroup Slider
*/
- EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Starts the list.
+ * Set the end object of the slider object.
*
- * @param obj The list object
+ * @param obj The slider object.
+ * @param end The end object.
*
- * @note Call before running show() on the list object.
- * @warning If not called, it won't display the list properly.
+ * On horizontal mode, end is placed at left, and on vertical mode,
+ * placed at bottom.
*
- * @code
- * li = elm_list_add(win);
- * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
- * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
- * elm_list_go(li);
- * evas_object_show(li);
- * @endcode
+ * @note Once the icon object is set, a previously set one will be deleted.
+ * If you want to keep that old content object, use the
+ * elm_slider_end_unset() function.
*
- * @ingroup List
+ * @warning If the object being set does not have minimum size hints set,
+ * it won't get properly displayed.
+ *
+ * @ingroup Slider
*/
- EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
/**
- * Enable or disable multiple items selection on the list object.
+ * Unset an end object set on a given slider widget.
*
- * @param obj The list object
- * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
- * disable it.
+ * @param obj The slider object.
+ * @return The end object that was being used, if any was set, or
+ * @c NULL, otherwise (and on errors).
*
- * Disabled by default. If disabled, the user can select a single item of
- * the list each time. Selected items are highlighted on list.
- * If enabled, many items can be selected.
+ * On horizontal mode, end is placed at left, and on vertical mode,
+ * placed at bottom.
*
- * If a selected item is selected again, it will be unselected.
+ * This call will unparent and return the icon object which was set
+ * for this widget, previously, on success.
*
- * @see elm_list_multi_select_get()
+ * @see elm_slider_end_set() for more details.
+ * @see elm_slider_end_get()
*
- * @ingroup List
+ * @ingroup Slider
*/
- EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get a value whether multiple items selection is enabled or not.
+ * Retrieve the end object set for a given slider widget.
*
- * @see elm_list_multi_select_set() for details.
+ * @param obj The slider object.
+ * @return The end object's handle, if @p obj had one set, or @c NULL,
+ * otherwise (and on errors).
*
- * @param obj The list object.
- * @return @c EINA_TRUE means multiple items selection is enabled.
- * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
- * @c EINA_FALSE is returned.
+ * On horizontal mode, icon is placed at right, and on vertical mode,
+ * placed at bottom.
*
- * @ingroup List
+ * @see elm_slider_end_set() for more details.
+ * @see elm_slider_end_unset()
+ *
+ * @ingroup Slider
*/
- EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set which mode to use for the list object.
- *
- * @param obj The list object
- * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
- * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
+ * Set the (exact) length of the bar region of a given slider widget.
*
- * Set list's resize behavior, transverse axis scroll and
- * items cropping. See each mode's description for more details.
+ * @param obj The slider object.
+ * @param size The length of the slider's bar region.
*
- * @note Default value is #ELM_LIST_SCROLL.
+ * This sets the minimum width (when in horizontal mode) or height
+ * (when in vertical mode) of the actual bar area of the slider
+ * @p obj. This in turn affects the object's minimum size. Use
+ * this when you're not setting other size hints expanding on the
+ * given direction (like weight and alignment hints) and you would
+ * like it to have a specific size.
*
- * Only one can be set, if a previous one was set, it will be changed
- * by the new mode set. Bitmask won't work as well.
+ * @note Icon, end, label, indicator and unit text around @p obj
+ * will require their
+ * own space, which will make @p obj to require more the @p size,
+ * actually.
*
- * @see elm_list_mode_get()
+ * @see elm_slider_span_size_get()
*
- * @ingroup List
+ * @ingroup Slider
*/
- EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
+ EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
/**
- * Get the mode the list is at.
+ * Get the length set for the bar region of a given slider widget
*
- * @param obj The list object
- * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
- * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
+ * @param obj The slider object.
+ * @return The length of the slider's bar region.
*
- * @note see elm_list_mode_set() for more information.
+ * If that size was not set previously, with
+ * elm_slider_span_size_set(), this call will return @c 0.
*
- * @ingroup List
+ * @ingroup Slider
*/
- EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Enable or disable horizontal mode on the list object.
+ * Set the format string for the unit label.
+ *
+ * @param obj The slider object.
+ * @param format The format string for the unit display.
+ *
+ * Unit label is displayed all the time, if set, after slider's bar.
+ * In horizontal mode, at right and in vertical mode, at bottom.
*
- * @param obj The list object.
- * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
- * disable it, i.e., to enable vertical mode.
+ * If @c NULL, unit label won't be visible. If not it sets the format
+ * string for the label text. To the label text is provided a floating point
+ * value, so the label text can display up to 1 floating point value.
+ * Note that this is optional.
*
- * @note Vertical mode is set by default.
+ * Use a format string such as "%1.2f meters" for example, and it will
+ * display values like: "3.14 meters" for a value equal to 3.14159.
*
- * On horizontal mode items are displayed on list from left to right,
- * instead of from top to bottom. Also, the list will scroll horizontally.
- * Each item will presents left icon on top and right icon, or end, at
- * the bottom.
+ * Default is unit label disabled.
*
- * @see elm_list_horizontal_get()
+ * @see elm_slider_indicator_format_get()
*
- * @ingroup List
+ * @ingroup Slider
*/
- EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
+ EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
/**
- * Get a value whether horizontal mode is enabled or not.
+ * Get the unit label format of the slider.
*
- * @param obj The list object.
- * @return @c EINA_TRUE means horizontal mode selection is enabled.
- * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
- * @c EINA_FALSE is returned.
+ * @param obj The slider object.
+ * @return The unit label format string in UTF-8.
*
- * @see elm_list_horizontal_set() for details.
+ * Unit label is displayed all the time, if set, after slider's bar.
+ * In horizontal mode, at right and in vertical mode, at bottom.
*
- * @ingroup List
+ * @see elm_slider_unit_format_set() for more
+ * information on how this works.
+ *
+ * @ingroup Slider
*/
- EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Enable or disable always select mode on the list object.
+ * Set the format string for the indicator label.
*
- * @param obj The list object
- * @param always_select @c EINA_TRUE to enable always select mode or
- * @c EINA_FALSE to disable it.
+ * @param obj The slider object.
+ * @param indicator The format string for the indicator display.
*
- * @note Always select mode is disabled by default.
+ * The slider may display its value somewhere else then unit label,
+ * for example, above the slider knob that is dragged around. This function
+ * sets the format string used for this.
*
- * Default behavior of list items is to only call its callback function
- * the first time it's pressed, i.e., when it is selected. If a selected
- * item is pressed again, and multi-select is disabled, it won't call
- * this function (if multi-select is enabled it will unselect the item).
+ * If @c NULL, indicator label won't be visible. If not it sets the format
+ * string for the label text. To the label text is provided a floating point
+ * value, so the label text can display up to 1 floating point value.
+ * Note that this is optional.
*
- * If always select is enabled, it will call the callback function
- * everytime a item is pressed, so it will call when the item is selected,
- * and again when a selected item is pressed.
+ * Use a format string such as "%1.2f meters" for example, and it will
+ * display values like: "3.14 meters" for a value equal to 3.14159.
*
- * @see elm_list_always_select_mode_get()
- * @see elm_list_multi_select_set()
+ * Default is indicator label disabled.
*
- * @ingroup List
+ * @see elm_slider_indicator_format_get()
+ *
+ * @ingroup Slider
*/
- EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
+ EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
/**
- * Get a value whether always select mode is enabled or not, meaning that
- * an item will always call its callback function, even if already selected.
+ * Get the indicator label format of the slider.
*
- * @param obj The list object
- * @return @c EINA_TRUE means horizontal mode selection is enabled.
- * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
- * @c EINA_FALSE is returned.
+ * @param obj The slider object.
+ * @return The indicator label format string in UTF-8.
*
- * @see elm_list_always_select_mode_set() for details.
+ * The slider may display its value somewhere else then unit label,
+ * for example, above the slider knob that is dragged around. This function
+ * gets the format string used for this.
*
- * @ingroup List
+ * @see elm_slider_indicator_format_set() for more
+ * information on how this works.
+ *
+ * @ingroup Slider
*/
- EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set bouncing behaviour when the scrolled content reaches an edge.
+ * Set the format function pointer for the indicator label
*
- * Tell the internal scroller object whether it should bounce or not
- * when it reaches the respective edges for each axis.
+ * @param obj The slider object.
+ * @param func The indicator format function.
+ * @param free_func The freeing function for the format string.
*
- * @param obj The list object
- * @param h_bounce Whether to bounce or not in the horizontal axis.
- * @param v_bounce Whether to bounce or not in the vertical axis.
+ * Set the callback function to format the indicator string.
*
- * @see elm_scroller_bounce_set()
+ * @see elm_slider_indicator_format_set() for more info on how this works.
*
- * @ingroup List
+ * @ingroup Slider
*/
- EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+ EAPI void elm_slider_indicator_format_function_set(Evas_Object *obj, const char *(*func)(double val), void (*free_func)(const char *str)) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the format function pointer for the units label
+ *
+ * @param obj The slider object.
+ * @param func The units format function.
+ * @param free_func The freeing function for the format string.
+ *
+ * Set the callback function to format the indicator string.
+ *
+ * @see elm_slider_units_format_set() for more info on how this works.
+ *
+ * @ingroup Slider
+ */
+ EAPI void elm_slider_units_format_function_set(Evas_Object *obj, const char *(*func)(double val), void (*free_func)(const char *str)) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the orientation of a given slider widget.
+ *
+ * @param obj The slider object.
+ * @param horizontal Use @c EINA_TRUE to make @p obj to be
+ * @b horizontal, @c EINA_FALSE to make it @b vertical.
+ *
+ * Use this function to change how your slider is to be
+ * disposed: vertically or horizontally.
+ *
+ * By default it's displayed horizontally.
+ *
+ * @see elm_slider_horizontal_get()
+ *
+ * @ingroup Slider
+ */
+ EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
/**
- * Get the bouncing behaviour of the internal scroller.
- *
- * Get whether the internal scroller should bounce when the edge of each
- * axis is reached scrolling.
+ * Retrieve the orientation of a given slider widget
*
- * @param obj The list object.
- * @param h_bounce Pointer where to store the bounce state of the horizontal
- * axis.
- * @param v_bounce Pointer where to store the bounce state of the vertical
- * axis.
+ * @param obj The slider object.
+ * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
+ * @c EINA_FALSE if it's @b vertical (and on errors).
*
- * @see elm_scroller_bounce_get()
- * @see elm_list_bounce_set()
+ * @see elm_slider_horizontal_set() for more details.
*
- * @ingroup List
+ * @ingroup Slider
*/
- EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the scrollbar policy.
+ * Set the minimum and maximum values for the slider.
*
- * @param obj The list object
- * @param policy_h Horizontal scrollbar policy.
- * @param policy_v Vertical scrollbar policy.
+ * @param obj The slider object.
+ * @param min The minimum value.
+ * @param max The maximum value.
*
- * This sets the scrollbar visibility policy for the given scroller.
- * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
- * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
- * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
- * This applies respectively for the horizontal and vertical scrollbars.
+ * Define the allowed range of values to be selected by the user.
*
- * The both are disabled by default, i.e., are set to
- * #ELM_SCROLLER_POLICY_OFF.
+ * If actual value is less than @p min, it will be updated to @p min. If it
+ * is bigger then @p max, will be updated to @p max. Actual value can be
+ * get with elm_slider_value_get().
*
- * @ingroup List
- */
- EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
-
- /**
- * Get the scrollbar policy.
+ * By default, min is equal to 0.0, and max is equal to 1.0.
*
- * @see elm_list_scroller_policy_get() for details.
+ * @warning Maximum must be greater than minimum, otherwise behavior
+ * is undefined.
*
- * @param obj The list object.
- * @param policy_h Pointer where to store horizontal scrollbar policy.
- * @param policy_v Pointer where to store vertical scrollbar policy.
+ * @see elm_slider_min_max_get()
*
- * @ingroup List
+ * @ingroup Slider
*/
- 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);
+ EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
/**
- * Append a new item to the list object.
+ * Get the minimum and maximum values of the slider.
*
- * @param obj The list object.
- * @param label The label of the list item.
- * @param icon The icon object to use for the left side of the item. An
- * icon can be any Evas object, but usually it is an icon created
- * with elm_icon_add().
- * @param end The icon object to use for the right side of the item. An
- * icon can be any Evas object.
- * @param func The function to call when the item is clicked.
- * @param data The data to associate with the item for related callbacks.
+ * @param obj The slider object.
+ * @param min Pointer where to store the minimum value.
+ * @param max Pointer where to store the maximum value.
*
- * @return The created item or @c NULL upon failure.
+ * @note If only one value is needed, the other pointer can be passed
+ * as @c NULL.
*
- * A new item will be created and appended to the list, i.e., will
- * be set as @b last item.
+ * @see elm_slider_min_max_set() for details.
*
- * Items created with this method can be deleted with
- * elm_list_item_del().
+ * @ingroup Slider
+ */
+ EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the value the slider displays.
*
- * Associated @p data can be properly freed when item is deleted if a
- * callback function is set with elm_list_item_del_cb_set().
+ * @param obj The slider object.
+ * @param val The value to be displayed.
*
- * If a function is passed as argument, it will be called everytime this item
- * is selected, i.e., the user clicks over an unselected item.
- * If always select is enabled it will call this function every time
- * user clicks over an item (already selected or not).
- * If such function isn't needed, just passing
- * @c NULL as @p func is enough. The same should be done for @p data.
+ * Value will be presented on the unit label following format specified with
+ * elm_slider_unit_format_set() and on indicator with
+ * elm_slider_indicator_format_set().
*
- * Simple example (with no function callback or data associated):
- * @code
- * li = elm_list_add(win);
- * ic = elm_icon_add(win);
- * elm_icon_file_set(ic, "path/to/image", NULL);
- * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
- * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
- * elm_list_go(li);
- * evas_object_show(li);
- * @endcode
+ * @warning The value must to be between min and max values. This values
+ * are set by elm_slider_min_max_set().
*
- * @see elm_list_always_select_mode_set()
- * @see elm_list_item_del()
- * @see elm_list_item_del_cb_set()
- * @see elm_list_clear()
- * @see elm_icon_add()
+ * @see elm_slider_value_get()
+ * @see elm_slider_unit_format_set()
+ * @see elm_slider_indicator_format_set()
+ * @see elm_slider_min_max_set()
*
- * @ingroup List
+ * @ingroup Slider
*/
- 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);
+ EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
/**
- * Prepend a new item to the list object.
- *
- * @param obj The list object.
- * @param label The label of the list item.
- * @param icon The icon object to use for the left side of the item. An
- * icon can be any Evas object, but usually it is an icon created
- * with elm_icon_add().
- * @param end The icon object to use for the right side of the item. An
- * icon can be any Evas object.
- * @param func The function to call when the item is clicked.
- * @param data The data to associate with the item for related callbacks.
+ * Get the value displayed by the spinner.
*
- * @return The created item or @c NULL upon failure.
+ * @param obj The spinner object.
+ * @return The value displayed.
*
- * A new item will be created and prepended to the list, i.e., will
- * be set as @b first item.
+ * @see elm_spinner_value_set() for details.
*
- * Items created with this method can be deleted with
- * elm_list_item_del().
+ * @ingroup Slider
+ */
+ EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Invert a given slider widget's displaying values order
*
- * Associated @p data can be properly freed when item is deleted if a
- * callback function is set with elm_list_item_del_cb_set().
+ * @param obj The slider object.
+ * @param inverted Use @c EINA_TRUE to make @p obj inverted,
+ * @c EINA_FALSE to bring it back to default, non-inverted values.
*
- * If a function is passed as argument, it will be called everytime this item
- * is selected, i.e., the user clicks over an unselected item.
- * If always select is enabled it will call this function every time
- * user clicks over an item (already selected or not).
- * If such function isn't needed, just passing
- * @c NULL as @p func is enough. The same should be done for @p data.
+ * A slider may be @b inverted, in which state it gets its
+ * values inverted, with high vales being on the left or top and
+ * low values on the right or bottom, as opposed to normally have
+ * the low values on the former and high values on the latter,
+ * respectively, for horizontal and vertical modes.
*
- * @see elm_list_item_append() for a simple code example.
- * @see elm_list_always_select_mode_set()
- * @see elm_list_item_del()
- * @see elm_list_item_del_cb_set()
- * @see elm_list_clear()
- * @see elm_icon_add()
+ * @see elm_slider_inverted_get()
*
- * @ingroup List
+ * @ingroup Slider
*/
- 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);
+ EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
/**
- * Insert a new item into the list object before item @p before.
- *
- * @param obj The list object.
- * @param before The list item to insert before.
- * @param label The label of the list item.
- * @param icon The icon object to use for the left side of the item. An
- * icon can be any Evas object, but usually it is an icon created
- * with elm_icon_add().
- * @param end The icon object to use for the right side of the item. An
- * icon can be any Evas object.
- * @param func The function to call when the item is clicked.
- * @param data The data to associate with the item for related callbacks.
+ * Get whether a given slider widget's displaying values are
+ * inverted or not.
*
- * @return The created item or @c NULL upon failure.
+ * @param obj The slider object.
+ * @return @c EINA_TRUE, if @p obj has inverted values,
+ * @c EINA_FALSE otherwise (and on errors).
*
- * A new item will be created and added to the list. Its position in
- * this list will be just before item @p before.
+ * @see elm_slider_inverted_set() for more details.
*
- * Items created with this method can be deleted with
- * elm_list_item_del().
+ * @ingroup Slider
+ */
+ EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set whether to enlarge slider indicator (augmented knob) or not.
*
- * Associated @p data can be properly freed when item is deleted if a
- * callback function is set with elm_list_item_del_cb_set().
+ * @param obj The slider object.
+ * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
+ * let the knob always at default size.
*
- * If a function is passed as argument, it will be called everytime this item
- * is selected, i.e., the user clicks over an unselected item.
- * If always select is enabled it will call this function every time
- * user clicks over an item (already selected or not).
- * If such function isn't needed, just passing
- * @c NULL as @p func is enough. The same should be done for @p data.
+ * By default, indicator will be bigger while dragged by the user.
*
- * @see elm_list_item_append() for a simple code example.
- * @see elm_list_always_select_mode_set()
- * @see elm_list_item_del()
- * @see elm_list_item_del_cb_set()
- * @see elm_list_clear()
- * @see elm_icon_add()
+ * @warning It won't display values set with
+ * elm_slider_indicator_format_set() if you disable indicator.
*
- * @ingroup List
+ * @ingroup Slider
*/
- 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);
+ EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
/**
- * Insert a new item into the list object after item @p after.
+ * Get whether a given slider widget's enlarging indicator or not.
*
- * @param obj The list object.
- * @param after The list item to insert after.
- * @param label The label of the list item.
- * @param icon The icon object to use for the left side of the item. An
- * icon can be any Evas object, but usually it is an icon created
- * with elm_icon_add().
- * @param end The icon object to use for the right side of the item. An
- * icon can be any Evas object.
- * @param func The function to call when the item is clicked.
- * @param data The data to associate with the item for related callbacks.
+ * @param obj The slider object.
+ * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
+ * @c EINA_FALSE otherwise (and on errors).
*
- * @return The created item or @c NULL upon failure.
+ * @see elm_slider_indicator_show_set() for details.
*
- * A new item will be created and added to the list. Its position in
- * this list will be just after item @p after.
+ * @ingroup Slider
+ */
+ EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * @}
+ */
+
+ /**
+ * @addtogroup Actionslider Actionslider
*
- * Items created with this method can be deleted with
- * elm_list_item_del().
+ * @image html img/widget/actionslider/preview-00.png
+ * @image latex img/widget/actionslider/preview-00.eps
*
- * Associated @p data can be properly freed when item is deleted if a
- * callback function is set with elm_list_item_del_cb_set().
+ * A actionslider is a switcher for 2 or 3 labels with customizable magnet
+ * properties. The indicator is the element the user drags to choose a label.
+ * When the position is set with magnet, when released the indicator will be
+ * moved to it if it's nearest the magnetized position.
*
- * If a function is passed as argument, it will be called everytime this item
- * is selected, i.e., the user clicks over an unselected item.
- * If always select is enabled it will call this function every time
- * user clicks over an item (already selected or not).
- * If such function isn't needed, just passing
- * @c NULL as @p func is enough. The same should be done for @p data.
+ * @note By default all positions are set as enabled.
*
- * @see elm_list_item_append() for a simple code example.
- * @see elm_list_always_select_mode_set()
- * @see elm_list_item_del()
- * @see elm_list_item_del_cb_set()
- * @see elm_list_clear()
- * @see elm_icon_add()
+ * Signals that you can add callbacks for are:
*
- * @ingroup List
+ * "selected" - when user selects an enabled position (the label is passed
+ * as event info)".
+ * @n
+ * "pos_changed" - when the indicator reaches any of the positions("left",
+ * "right" or "center").
+ *
+ * See an example of actionslider usage @ref actionslider_example_page "here"
+ * @{
*/
- 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);
+ typedef enum _Elm_Actionslider_Pos
+ {
+ ELM_ACTIONSLIDER_NONE = 0,
+ ELM_ACTIONSLIDER_LEFT = 1 << 0,
+ ELM_ACTIONSLIDER_CENTER = 1 << 1,
+ ELM_ACTIONSLIDER_RIGHT = 1 << 2,
+ ELM_ACTIONSLIDER_ALL = (1 << 3) -1
+ } Elm_Actionslider_Pos;
/**
- * Insert a new item into the sorted list object.
- *
- * @param obj The list object.
- * @param label The label of the list item.
- * @param icon The icon object to use for the left side of the item. An
- * icon can be any Evas object, but usually it is an icon created
- * with elm_icon_add().
- * @param end The icon object to use for the right side of the item. An
- * icon can be any Evas object.
- * @param func The function to call when the item is clicked.
- * @param data The data to associate with the item for related callbacks.
- * @param cmp_func The comparing function to be used to sort list
- * items <b>by #Elm_List_Item item handles</b>. This function will
- * receive two items and compare them, returning a non-negative integer
- * if the second item should be place after the first, or negative value
- * if should be placed before.
- *
- * @return The created item or @c NULL upon failure.
- *
- * @note This function inserts values into a list object assuming it was
- * sorted and the result will be sorted.
- *
- * A new item will be created and added to the list. Its position in
- * this list will be found comparing the new item with previously inserted
- * items using function @p cmp_func.
+ * Add a new actionslider to the parent.
*
- * Items created with this method can be deleted with
- * elm_list_item_del().
+ * @param parent The parent object
+ * @return The new actionslider object or NULL if it cannot be created
+ */
+ EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * Set actionslider labels.
*
- * Associated @p data can be properly freed when item is deleted if a
- * callback function is set with elm_list_item_del_cb_set().
+ * @param obj The actionslider object
+ * @param left_label The label to be set on the left.
+ * @param center_label The label to be set on the center.
+ * @param right_label The label to be set on the right.
+ * @deprecated use elm_object_text_set() instead.
+ */
+ EINA_DEPRECATED 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);
+ /**
+ * Get actionslider labels.
*
- * If a function is passed as argument, it will be called everytime this item
- * is selected, i.e., the user clicks over an unselected item.
- * If always select is enabled it will call this function every time
- * user clicks over an item (already selected or not).
- * If such function isn't needed, just passing
- * @c NULL as @p func is enough. The same should be done for @p data.
+ * @param obj The actionslider object
+ * @param left_label A char** to place the left_label of @p obj into.
+ * @param center_label A char** to place the center_label of @p obj into.
+ * @param right_label A char** to place the right_label of @p obj into.
+ * @deprecated use elm_object_text_set() instead.
+ */
+ EINA_DEPRECATED 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);
+ /**
+ * Get actionslider selected label.
*
- * @see elm_list_item_append() for a simple code example.
- * @see elm_list_always_select_mode_set()
- * @see elm_list_item_del()
- * @see elm_list_item_del_cb_set()
- * @see elm_list_clear()
- * @see elm_icon_add()
+ * @param obj The actionslider object
+ * @return The selected label
+ */
+ EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set actionslider indicator position.
*
- * @ingroup List
+ * @param obj The actionslider object.
+ * @param pos The position of the indicator.
*/
- 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);
-
+ EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
/**
- * Remove all list's items.
- *
- * @param obj The list object
- *
- * @see elm_list_item_del()
- * @see elm_list_item_append()
+ * Get actionslider indicator position.
*
- * @ingroup List
+ * @param obj The actionslider object.
+ * @return The position of the indicator.
*/
- EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get a list of all the list items.
- *
- * @param obj The list object
- * @return An @c Eina_List of list items, #Elm_List_Item,
- * or @c NULL on failure.
- *
- * @see elm_list_item_append()
- * @see elm_list_item_del()
- * @see elm_list_clear()
+ * Set actionslider magnet position. To make multiple positions magnets @c or
+ * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
*
- * @ingroup List
+ * @param obj The actionslider object.
+ * @param pos Bit mask indicating the magnet positions.
*/
- EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
/**
- * Get the selected item.
- *
- * @param obj The list object.
- * @return The selected list item.
- *
- * The selected item can be unselected with function
- * elm_list_item_selected_set().
- *
- * The selected item always will be highlighted on list.
- *
- * @see elm_list_selected_items_get()
+ * Get actionslider magnet position.
*
- * @ingroup List
+ * @param obj The actionslider object.
+ * @return The positions with magnet property.
*/
- EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Return a list of the currently selected list items.
- *
- * @param obj The list object.
- * @return An @c Eina_List of list items, #Elm_List_Item,
- * or @c NULL on failure.
- *
- * Multiple items can be selected if multi select is enabled. It can be
- * done with elm_list_multi_select_set().
+ * Set actionslider enabled position. To set multiple positions as enabled @c or
+ * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
*
- * @see elm_list_selected_item_get()
- * @see elm_list_multi_select_set()
+ * @note All the positions are enabled by default.
*
- * @ingroup List
+ * @param obj The actionslider object.
+ * @param pos Bit mask indicating the enabled positions.
*/
- EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
/**
- * Set the selected state of an item.
- *
- * @param item The list item
- * @param selected The selected state
- *
- * This sets the selected state of the given item @p it.
- * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
- *
- * If a new item is selected the previosly selected will be unselected,
- * unless multiple selection is enabled with elm_list_multi_select_set().
- * Previoulsy selected item can be get with function
- * elm_list_selected_item_get().
- *
- * Selected items will be highlighted.
- *
- * @see elm_list_item_selected_get()
- * @see elm_list_selected_item_get()
- * @see elm_list_multi_select_set()
+ * Get actionslider enabled position.
*
- * @ingroup List
+ * @param obj The actionslider object.
+ * @return The enabled positions.
*/
- EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
-
- /*
- * Get whether the @p item is selected or not.
- *
- * @param item The list item.
- * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
- * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
+ EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the label used on the indicator.
*
- * @see elm_list_selected_item_set() for details.
- * @see elm_list_item_selected_get()
+ * @param obj The actionslider object
+ * @param label The label to be set on the indicator.
+ * @deprecated use elm_object_text_set() instead.
+ */
+ EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+ /**
+ * Get the label used on the indicator object.
*
- * @ingroup List
+ * @param obj The actionslider object
+ * @return The indicator label
+ * @deprecated use elm_object_text_get() instead.
+ */
+ EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @}
*/
- EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
/**
- * Set or unset item as a separator.
- *
- * @param it The list item.
- * @param setting @c EINA_TRUE to set item @p it as separator or
- * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
- *
- * Items aren't set as separator by default.
+ * @defgroup Genlist Genlist
*
- * If set as separator it will display separator theme, so won't display
- * icons or label.
+ * @image html img/widget/genlist/preview-00.png
+ * @image latex img/widget/genlist/preview-00.eps
+ * @image html img/genlist.png
+ * @image latex img/genlist.eps
*
- * @see elm_list_item_separator_get()
+ * This widget aims to have more expansive list than the simple list in
+ * Elementary that could have more flexible items and allow many more entries
+ * while still being fast and low on memory usage. At the same time it was
+ * also made to be able to do tree structures. But the price to pay is more
+ * complexity when it comes to usage. If all you want is a simple list with
+ * icons and a single label, use the normal @ref List object.
*
- * @ingroup List
- */
- EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
-
- /**
- * Get a value whether item is a separator or not.
+ * Genlist has a fairly large API, mostly because it's relatively complex,
+ * trying to be both expansive, powerful and efficient. First we will begin
+ * an overview on the theory behind genlist.
*
- * @see elm_list_item_separator_set() for details.
+ * @section Genlist_Item_Class Genlist item classes - creating items
*
- * @param it The list item.
- * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
- * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
+ * In order to have the ability to add and delete items on the fly, genlist
+ * implements a class (callback) system where the application provides a
+ * structure with information about that type of item (genlist may contain
+ * multiple different items with different classes, states and styles).
+ * Genlist will call the functions in this struct (methods) when an item is
+ * "realized" (i.e., created dynamically, while the user is scrolling the
+ * grid). All objects will simply be deleted when no longer needed with
+ * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
+ * following members:
+ * - @c item_style - This is a constant string and simply defines the name
+ * of the item style. It @b must be specified and the default should be @c
+ * "default".
+ * - @c mode_item_style - This is a constant string and simply defines the
+ * name of the style that will be used for mode animations. It can be left
+ * as @c NULL if you don't plan to use Genlist mode. See
+ * elm_genlist_item_mode_set() for more info.
*
- * @ingroup List
- */
- EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
-
- /**
- * Show @p item in the list view.
+ * - @c func - A struct with pointers to functions that will be called when
+ * an item is going to be actually created. All of them receive a @c data
+ * parameter that will point to the same data passed to
+ * elm_genlist_item_append() and related item creation functions, and a @c
+ * obj parameter that points to the genlist object itself.
*
- * @param item The list item to be shown.
+ * The function pointers inside @c func are @c label_get, @c icon_get, @c
+ * state_get and @c del. The 3 first functions also receive a @c part
+ * parameter described below. A brief description of these functions follows:
*
- * It won't animate list until item is visible. If such behavior is wanted,
- * use elm_list_bring_in() intead.
+ * - @c label_get - The @c part parameter is the name string of one of the
+ * existing text parts in the Edje group implementing the item's theme.
+ * This function @b must return a strdup'()ed string, as the caller will
+ * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
+ * - @c icon_get - The @c part parameter is the name string of one of the
+ * existing (icon) swallow parts in the Edje group implementing the item's
+ * theme. It must return @c NULL, when no icon is desired, or a valid
+ * object handle, otherwise. The object will be deleted by the genlist on
+ * its deletion or when the item is "unrealized". See
+ * #Elm_Genlist_Item_Icon_Get_Cb.
+ * - @c func.state_get - The @c part parameter is the name string of one of
+ * the state parts in the Edje group implementing the item's theme. Return
+ * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
+ * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
+ * and @c "elm" as "emission" and "source" arguments, respectively, when
+ * the state is true (the default is false), where @c XXX is the name of
+ * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
+ * - @c func.del - This is intended for use when genlist items are deleted,
+ * so any data attached to the item (e.g. its data parameter on creation)
+ * can be deleted. See #Elm_Genlist_Item_Del_Cb.
*
- * @ingroup List
- */
- EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
-
- /**
- * Bring in the given item to list view.
+ * available item styles:
+ * - default
+ * - default_style - The text part is a textblock
*
- * @param item The item.
+ * @image html img/widget/genlist/preview-04.png
+ * @image latex img/widget/genlist/preview-04.eps
*
- * This causes list to jump to the given item @p item and show it
- * (by scrolling), if it is not fully visible.
+ * - double_label
*
- * This may use animation to do so and take a period of time.
+ * @image html img/widget/genlist/preview-01.png
+ * @image latex img/widget/genlist/preview-01.eps
*
- * If animation isn't wanted, elm_list_item_show() can be used.
+ * - icon_top_text_bottom
*
- * @ingroup List
- */
- EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
-
- /**
- * Delete them item from the list.
+ * @image html img/widget/genlist/preview-02.png
+ * @image latex img/widget/genlist/preview-02.eps
*
- * @param item The item of list to be deleted.
+ * - group_index
*
- * If deleting all list items is required, elm_list_clear()
- * should be used instead of getting items list and deleting each one.
+ * @image html img/widget/genlist/preview-03.png
+ * @image latex img/widget/genlist/preview-03.eps
*
- * @see elm_list_clear()
- * @see elm_list_item_append()
- * @see elm_list_item_del_cb_set()
+ * @section Genlist_Items Structure of items
*
- * @ingroup List
- */
- EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
-
- /**
- * Set the function called when a list item is freed.
+ * An item in a genlist can have 0 or more text labels (they can be regular
+ * text or textblock Evas objects - that's up to the style to determine), 0
+ * or more icons (which are simply objects swallowed into the genlist item's
+ * theming Edje object) and 0 or more <b>boolean states</b>, which have the
+ * behavior left to the user to define. The Edje part names for each of
+ * these properties will be looked up, in the theme file for the genlist,
+ * under the Edje (string) data items named @c "labels", @c "icons" and @c
+ * "states", respectively. For each of those properties, if more than one
+ * part is provided, they must have names listed separated by spaces in the
+ * data fields. For the default genlist item theme, we have @b one label
+ * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
+ * "elm.swallow.end") and @b no state parts.
*
- * @param item The item to set the callback on
- * @param func The function called
+ * A genlist item may be at one of several styles. Elementary provides one
+ * by default - "default", but this can be extended by system or application
+ * custom themes/overlays/extensions (see @ref Theme "themes" for more
+ * details).
*
- * If there is a @p func, then it will be called prior item's memory release.
- * That will be called with the following arguments:
- * @li item's data;
- * @li item's Evas object;
- * @li item itself;
+ * @section Genlist_Manipulation Editing and Navigating
*
- * This way, a data associated to a list item could be properly freed.
+ * Items can be added by several calls. All of them return a @ref
+ * Elm_Genlist_Item handle that is an internal member inside the genlist.
+ * They all take a data parameter that is meant to be used for a handle to
+ * the applications internal data (eg the struct with the original item
+ * data). The parent parameter is the parent genlist item this belongs to if
+ * it is a tree or an indexed group, and NULL if there is no parent. The
+ * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
+ * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
+ * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
+ * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
+ * is set then this item is group index item that is displayed at the top
+ * until the next group comes. The func parameter is a convenience callback
+ * that is called when the item is selected and the data parameter will be
+ * the func_data parameter, obj be the genlist object and event_info will be
+ * the genlist item.
*
- * @ingroup List
- */
- EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
-
- /**
- * Get the data associated to the item.
+ * elm_genlist_item_append() adds an item to the end of the list, or if
+ * there is a parent, to the end of all the child items of the parent.
+ * elm_genlist_item_prepend() is the same but adds to the beginning of
+ * the list or children list. elm_genlist_item_insert_before() inserts at
+ * item before another item and elm_genlist_item_insert_after() inserts after
+ * the indicated item.
*
- * @param item The list item
- * @return The data associated to @p item
+ * The application can clear the list with elm_genlist_clear() which deletes
+ * all the items in the list and elm_genlist_item_del() will delete a specific
+ * item. elm_genlist_item_subitems_clear() will clear all items that are
+ * children of the indicated parent item.
*
- * The return value is a pointer to data associated to @p item when it was
- * created, with function elm_list_item_append() or similar. If no data
- * was passed as argument, it will return @c NULL.
+ * To help inspect list items you can jump to the item at the top of the list
+ * with elm_genlist_first_item_get() which will return the item pointer, and
+ * similarly elm_genlist_last_item_get() gets the item at the end of the list.
+ * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
+ * and previous items respectively relative to the indicated item. Using
+ * these calls you can walk the entire item list/tree. Note that as a tree
+ * the items are flattened in the list, so elm_genlist_item_parent_get() will
+ * let you know which item is the parent (and thus know how to skip them if
+ * wanted).
*
- * @see elm_list_item_append()
+ * @section Genlist_Muti_Selection Multi-selection
*
- * @ingroup List
- */
- EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
-
- /**
- * Get the left side icon associated to the item.
+ * If the application wants multiple items to be able to be selected,
+ * elm_genlist_multi_select_set() can enable this. If the list is
+ * single-selection only (the default), then elm_genlist_selected_item_get()
+ * will return the selected item, if any, or NULL I none is selected. If the
+ * list is multi-select then elm_genlist_selected_items_get() will return a
+ * list (that is only valid as long as no items are modified (added, deleted,
+ * selected or unselected)).
*
- * @param item The list item
- * @return The left side icon associated to @p item
+ * @section Genlist_Usage_Hints Usage hints
*
- * The return value is a pointer to the icon associated to @p item when
- * it was
- * created, with function elm_list_item_append() or similar, or later
- * with function elm_list_item_icon_set(). If no icon
- * was passed as argument, it will return @c NULL.
+ * There are also convenience functions. elm_genlist_item_genlist_get() will
+ * return the genlist object the item belongs to. elm_genlist_item_show()
+ * will make the scroller scroll to show that specific item so its visible.
+ * elm_genlist_item_data_get() returns the data pointer set by the item
+ * creation functions.
*
- * @see elm_list_item_append()
- * @see elm_list_item_icon_set()
+ * If an item changes (state of boolean changes, label or icons change),
+ * then use elm_genlist_item_update() to have genlist update the item with
+ * the new state. Genlist will re-realize the item thus call the functions
+ * in the _Elm_Genlist_Item_Class for that item.
*
- * @ingroup List
- */
- EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
-
- /**
- * Set the left side icon associated to the item.
+ * To programmatically (un)select an item use elm_genlist_item_selected_set().
+ * To get its selected state use elm_genlist_item_selected_get(). Similarly
+ * to expand/contract an item and get its expanded state, use
+ * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
+ * again to make an item disabled (unable to be selected and appear
+ * differently) use elm_genlist_item_disabled_set() to set this and
+ * elm_genlist_item_disabled_get() to get the disabled state.
*
- * @param item The list item
- * @param icon The left side icon object to associate with @p item
+ * In general to indicate how the genlist should expand items horizontally to
+ * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
+ * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
+ * mode means that if items are too wide to fit, the scroller will scroll
+ * horizontally. Otherwise items are expanded to fill the width of the
+ * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
+ * to the viewport width and limited to that size. This can be combined with
+ * a different style that uses edjes' ellipsis feature (cutting text off like
+ * this: "tex...").
*
- * The icon object to use at left side of the item. An
- * icon can be any Evas object, but usually it is an icon created
- * with elm_icon_add().
+ * Items will only call their selection func and callback when first becoming
+ * selected. Any further clicks will do nothing, unless you enable always
+ * select with elm_genlist_always_select_mode_set(). This means even if
+ * selected, every click will make the selected callbacks be called.
+ * elm_genlist_no_select_mode_set() will turn off the ability to select
+ * items entirely and they will neither appear selected nor call selected
+ * callback functions.
*
- * Once the icon object is set, a previously set one will be deleted.
- * @warning Setting the same icon for two items will cause the icon to
- * dissapear from the first item.
+ * Remember that you can create new styles and add your own theme augmentation
+ * per application with elm_theme_extension_add(). If you absolutely must
+ * have a specific style that overrides any theme the user or system sets up
+ * you can use elm_theme_overlay_add() to add such a file.
*
- * If an icon was passed as argument on item creation, with function
- * elm_list_item_append() or similar, it will be already
- * associated to the item.
+ * @section Genlist_Implementation Implementation
*
- * @see elm_list_item_append()
- * @see elm_list_item_icon_get()
+ * Evas tracks every object you create. Every time it processes an event
+ * (mouse move, down, up etc.) it needs to walk through objects and find out
+ * what event that affects. Even worse every time it renders display updates,
+ * in order to just calculate what to re-draw, it needs to walk through many
+ * many many objects. Thus, the more objects you keep active, the more
+ * overhead Evas has in just doing its work. It is advisable to keep your
+ * active objects to the minimum working set you need. Also remember that
+ * object creation and deletion carries an overhead, so there is a
+ * middle-ground, which is not easily determined. But don't keep massive lists
+ * of objects you can't see or use. Genlist does this with list objects. It
+ * creates and destroys them dynamically as you scroll around. It groups them
+ * into blocks so it can determine the visibility etc. of a whole block at
+ * once as opposed to having to walk the whole list. This 2-level list allows
+ * for very large numbers of items to be in the list (tests have used up to
+ * 2,000,000 items). Also genlist employs a queue for adding items. As items
+ * may be different sizes, every item added needs to be calculated as to its
+ * size and thus this presents a lot of overhead on populating the list, this
+ * genlist employs a queue. Any item added is queued and spooled off over
+ * time, actually appearing some time later, so if your list has many members
+ * you may find it takes a while for them to all appear, with your process
+ * consuming a lot of CPU while it is busy spooling.
*
- * @ingroup List
- */
- EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
-
- /**
- * Get the right side icon associated to the item.
+ * Genlist also implements a tree structure, but it does so with callbacks to
+ * the application, with the application filling in tree structures when
+ * requested (allowing for efficient building of a very deep tree that could
+ * even be used for file-management). See the above smart signal callbacks for
+ * details.
*
- * @param item The list item
- * @return The right side icon associated to @p item
+ * @section Genlist_Smart_Events Genlist smart events
*
- * The return value is a pointer to the icon associated to @p item when
- * it was
- * created, with function elm_list_item_append() or similar, or later
- * with function elm_list_item_icon_set(). If no icon
- * was passed as argument, it will return @c NULL.
+ * Signals that you can add callbacks for are:
+ * - @c "activated" - The user has double-clicked or pressed
+ * (enter|return|spacebar) on an item. The @c event_info parameter is the
+ * item that was activated.
+ * - @c "clicked,double" - The user has double-clicked an item. The @c
+ * event_info parameter is the item that was double-clicked.
+ * - @c "selected" - This is called when a user has made an item selected.
+ * The event_info parameter is the genlist item that was selected.
+ * - @c "unselected" - This is called when a user has made an item
+ * unselected. The event_info parameter is the genlist item that was
+ * unselected.
+ * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
+ * called and the item is now meant to be expanded. The event_info
+ * parameter is the genlist item that was indicated to expand. It is the
+ * job of this callback to then fill in the child items.
+ * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
+ * called and the item is now meant to be contracted. The event_info
+ * parameter is the genlist item that was indicated to contract. It is the
+ * job of this callback to then delete the child items.
+ * - @c "expand,request" - This is called when a user has indicated they want
+ * to expand a tree branch item. The callback should decide if the item can
+ * expand (has any children) and then call elm_genlist_item_expanded_set()
+ * appropriately to set the state. The event_info parameter is the genlist
+ * item that was indicated to expand.
+ * - @c "contract,request" - This is called when a user has indicated they
+ * want to contract a tree branch item. The callback should decide if the
+ * item can contract (has any children) and then call
+ * elm_genlist_item_expanded_set() appropriately to set the state. The
+ * event_info parameter is the genlist item that was indicated to contract.
+ * - @c "realized" - This is called when the item in the list is created as a
+ * real evas object. event_info parameter is the genlist item that was
+ * created. The object may be deleted at any time, so it is up to the
+ * caller to not use the object pointer from elm_genlist_item_object_get()
+ * in a way where it may point to freed objects.
+ * - @c "unrealized" - This is called just before an item is unrealized.
+ * After this call icon objects provided will be deleted and the item
+ * object itself delete or be put into a floating cache.
+ * - @c "drag,start,up" - This is called when the item in the list has been
+ * dragged (not scrolled) up.
+ * - @c "drag,start,down" - This is called when the item in the list has been
+ * dragged (not scrolled) down.
+ * - @c "drag,start,left" - This is called when the item in the list has been
+ * dragged (not scrolled) left.
+ * - @c "drag,start,right" - This is called when the item in the list has
+ * been dragged (not scrolled) right.
+ * - @c "drag,stop" - This is called when the item in the list has stopped
+ * being dragged.
+ * - @c "drag" - This is called when the item in the list is being dragged.
+ * - @c "longpressed" - This is called when the item is pressed for a certain
+ * amount of time. By default it's 1 second.
+ * - @c "scroll,anim,start" - This is called when scrolling animation has
+ * started.
+ * - @c "scroll,anim,stop" - This is called when scrolling animation has
+ * stopped.
+ * - @c "scroll,drag,start" - This is called when dragging the content has
+ * started.
+ * - @c "scroll,drag,stop" - This is called when dragging the content has
+ * stopped.
+ * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
+ * the top edge.
+ * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
+ * until the bottom edge.
+ * - @c "scroll,edge,left" - This is called when the genlist is scrolled
+ * until the left edge.
+ * - @c "scroll,edge,right" - This is called when the genlist is scrolled
+ * until the right edge.
+ * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
+ * swiped left.
+ * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
+ * swiped right.
+ * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
+ * swiped up.
+ * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
+ * swiped down.
+ * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
+ * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
+ * multi-touch pinched in.
+ * - @c "swipe" - This is called when the genlist is swiped.
*
- * @see elm_list_item_append()
- * @see elm_list_item_icon_set()
+ * @section Genlist_Examples Examples
*
- * @ingroup List
+ * Here is a list of examples that use the genlist, trying to show some of
+ * its capabilities:
+ * - @ref genlist_example_01
+ * - @ref genlist_example_02
+ * - @ref genlist_example_03
+ * - @ref genlist_example_04
+ * - @ref genlist_example_05
*/
- EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
/**
- * Set the right side icon associated to the item.
- *
- * @param item The list item
- * @param end The right side icon object to associate with @p item
- *
- * The icon object to use at right side of the item. An
- * icon can be any Evas object, but usually it is an icon created
- * with elm_icon_add().
- *
- * Once the icon object is set, a previously set one will be deleted.
- * @warning Setting the same icon for two items will cause the icon to
- * dissapear from the first item.
- *
- * If an icon was passed as argument on item creation, with function
- * elm_list_item_append() or similar, it will be already
- * associated to the item.
- *
- * @see elm_list_item_append()
- * @see elm_list_item_end_get()
- *
- * @ingroup List
+ * @addtogroup Genlist
+ * @{
*/
- EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
/**
- * Gets the base object of the item.
- *
- * @param item The list item
- * @return The base object associated with @p item
+ * @enum _Elm_Genlist_Item_Flags
+ * @typedef Elm_Genlist_Item_Flags
*
- * Base object is the @c Evas_Object that represents that item.
+ * Defines if the item is of any special type (has subitems or it's the
+ * index of a group), or is just a simple item.
*
- * @ingroup List
+ * @ingroup Genlist
*/
- EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Genlist_Item_Flags
+ {
+ ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
+ ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
+ ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
+ } Elm_Genlist_Item_Flags;
+ typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
+ typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
+ typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
+ typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
+ typedef Evas_Object *(*Elm_Genlist_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
+ typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
+ typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
+ typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
- /**
- * Get the label of item.
- *
- * @param item The item of list.
- * @return The label of item.
- *
- * The return value is a pointer to the label associated to @p item when
- * it was created, with function elm_list_item_append(), or later
- * with function elm_list_item_label_set. If no label
- * was passed as argument, it will return @c NULL.
- *
- * @see elm_list_item_label_set() for more details.
- * @see elm_list_item_append()
- *
- * @ingroup List
- */
- EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
+ typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
+ typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
+ typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
+ typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
/**
- * Set the label of item.
- *
- * @param item The item of list.
- * @param text The label of item.
- *
- * The label to be displayed by the item.
- * Label will be placed between left and right side icons (if set).
+ * @struct _Elm_Genlist_Item_Class
*
- * If a label was passed as argument on item creation, with function
- * elm_list_item_append() or similar, it will be already
- * displayed by the item.
+ * Genlist item class definition structs.
*
- * @see elm_list_item_label_get()
- * @see elm_list_item_append()
+ * This struct contains the style and fetching functions that will define the
+ * contents of each item.
*
- * @ingroup List
+ * @see @ref Genlist_Item_Class
*/
- EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
-
+ struct _Elm_Genlist_Item_Class
+ {
+ const char *item_style; /**< style of this class. */
+ struct
+ {
+ Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
+ Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
+ Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
+ Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
+ GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
+ } func;
+ const char *mode_item_style;
+ };
/**
- * Get the item before @p it in list.
+ * Add a new genlist widget to the given parent Elementary
+ * (container) object
*
- * @param it The list item.
- * @return The item before @p it, or @c NULL if none or on failure.
+ * @param parent The parent object
+ * @return a new genlist widget handle or @c NULL, on errors
*
- * @note If it is the first item, @c NULL will be returned.
+ * This function inserts a new genlist widget on the canvas.
*
- * @see elm_list_item_append()
- * @see elm_list_items_get()
+ * @see elm_genlist_item_append()
+ * @see elm_genlist_item_del()
+ * @see elm_genlist_clear()
*
- * @ingroup List
+ * @ingroup Genlist
*/
- EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
-
+ EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Get the item after @p it in list.
+ * Remove all items from a given genlist widget.
*
- * @param it The list item.
- * @return The item after @p it, or @c NULL if none or on failure.
+ * @param obj The genlist object
*
- * @note If it is the last item, @c NULL will be returned.
+ * This removes (and deletes) all items in @p obj, leaving it empty.
*
- * @see elm_list_item_append()
- * @see elm_list_items_get()
+ * @see elm_genlist_item_del(), to remove just one item.
*
- * @ingroup List
+ * @ingroup Genlist
*/
- EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Sets the disabled/enabled state of a list item.
+ * Enable or disable multi-selection in the genlist
*
- * @param it The item.
- * @param disabled The disabled state.
+ * @param obj The genlist object
+ * @param multi Multi-select enable/disable. Default is disabled.
*
- * A disabled item cannot be selected or unselected. It will also
- * change its appearance (generally greyed out). This sets the
- * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
- * enabled).
+ * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
+ * the list. This allows more than 1 item to be selected. To retrieve the list
+ * of selected items, use elm_genlist_selected_items_get().
*
- * @ingroup List
+ * @see elm_genlist_selected_items_get()
+ * @see elm_genlist_multi_select_get()
+ *
+ * @ingroup Genlist
*/
- EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
/**
- * Get a value whether list item is disabled or not.
+ * Gets if multi-selection in genlist is enabled or disabled.
*
- * @param it The item.
- * @return The disabled state.
+ * @param obj The genlist object
+ * @return Multi-select enabled/disabled
+ * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
*
- * @see elm_list_item_disabled_set() for more details.
+ * @see elm_genlist_multi_select_set()
*
- * @ingroup List
+ * @ingroup Genlist
*/
- EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the text to be shown in a given list item's tooltips.
+ * This sets the horizontal stretching mode.
*
- * @param item Target item.
- * @param text The text to set in the content.
+ * @param obj The genlist object
+ * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
*
- * Setup the text as tooltip to object. The item can have only one tooltip,
- * so any previous tooltip data - set with this function or
- * elm_list_item_tooltip_content_cb_set() - is removed.
+ * This sets the mode used for sizing items horizontally. Valid modes
+ * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
+ * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
+ * the scroller will scroll horizontally. Otherwise items are expanded
+ * to fill the width of the viewport of the scroller. If it is
+ * ELM_LIST_LIMIT, items will be expanded to the viewport width and
+ * limited to that size.
*
- * @see elm_object_tooltip_text_set() for more details.
+ * @see elm_genlist_horizontal_get()
*
- * @ingroup List
+ * @ingroup Genlist
*/
- EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
-
-
+ EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
/**
- * @brief Disable size restrictions on an object's tooltip
- * @param item The tooltip's anchor object
- * @param disable If EINA_TRUE, size restrictions are disabled
- * @return EINA_FALSE on failure, EINA_TRUE on success
+ * Gets the horizontal stretching mode.
*
- * This function allows a tooltip to expand beyond its parant window's canvas.
- * It will instead be limited only by the size of the display.
- */
- EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
- /**
- * @brief Retrieve size restriction state of an object's tooltip
- * @param obj The tooltip's anchor object
- * @return If EINA_TRUE, size restrictions are disabled
+ * @param obj The genlist object
+ * @return The mode to use
+ * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
*
- * This function returns whether a tooltip is allowed to expand beyond
- * its parant window's canvas.
- * It will instead be limited only by the size of the display.
+ * @see elm_genlist_horizontal_set()
+ *
+ * @ingroup Genlist
*/
- EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
-
+ EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the content to be shown in the tooltip item.
+ * Set the always select mode.
*
- * Setup the tooltip to item. The item can have only one tooltip,
- * so any previous tooltip data is removed. @p func(with @p data) will
- * be called every time that need show the tooltip and it should
- * return a valid Evas_Object. This object is then managed fully by
- * tooltip system and is deleted when the tooltip is gone.
+ * @param obj The genlist object
+ * @param always_select The always select mode (@c EINA_TRUE = on, @c
+ * EINA_FALSE = off). Default is @c EINA_FALSE.
*
- * @param item the list item being attached a tooltip.
- * @param func the function used to create the tooltip contents.
- * @param data what to provide to @a func as callback data/context.
- * @param del_cb called when data is not needed anymore, either when
- * another callback replaces @a func, the tooltip is unset with
- * elm_list_item_tooltip_unset() or the owner @a item
- * dies. This callback receives as the first parameter the
- * given @a data, and @c event_info is the item.
+ * Items will only call their selection func and callback when first
+ * becoming selected. Any further clicks will do nothing, unless you
+ * enable always select with elm_genlist_always_select_mode_set().
+ * This means that, even if selected, every click will make the selected
+ * callbacks be called.
*
- * @see elm_object_tooltip_content_cb_set() for more details.
+ * @see elm_genlist_always_select_mode_get()
*
- * @ingroup List
+ * @ingroup Genlist
*/
- 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);
-
+ EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
/**
- * Unset tooltip from item.
- *
- * @param item list item to remove previously set tooltip.
+ * Get the always select mode.
*
- * Remove tooltip from item. The callback provided as del_cb to
- * elm_list_item_tooltip_content_cb_set() will be called to notify
- * it is not used anymore.
+ * @param obj The genlist object
+ * @return The always select mode
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off)
*
- * @see elm_object_tooltip_unset() for more details.
- * @see elm_list_item_tooltip_content_cb_set()
+ * @see elm_genlist_always_select_mode_set()
*
- * @ingroup List
+ * @ingroup Genlist
*/
- EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Sets a different style for this item tooltip.
+ * Enable/disable the no select mode.
*
- * @note before you set a style you should define a tooltip with
- * elm_list_item_tooltip_content_cb_set() or
- * elm_list_item_tooltip_text_set()
+ * @param obj The genlist object
+ * @param no_select The no select mode
+ * (EINA_TRUE = on, EINA_FALSE = off)
*
- * @param item list item with tooltip already set.
- * @param style the theme style to use (default, transparent, ...)
+ * This will turn off the ability to select items entirely and they
+ * will neither appear selected nor call selected callback functions.
*
- * @see elm_object_tooltip_style_set() for more details.
+ * @see elm_genlist_no_select_mode_get()
*
- * @ingroup List
+ * @ingroup Genlist
*/
- EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
/**
- * Get the style for this item tooltip.
+ * Gets whether the no select mode is enabled.
*
- * @param item list item with tooltip already set.
- * @return style the theme style in use, defaults to "default". If the
- * object does not have a tooltip set, then NULL is returned.
+ * @param obj The genlist object
+ * @return The no select mode
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off)
*
- * @see elm_object_tooltip_style_get() for more details.
- * @see elm_list_item_tooltip_style_set()
+ * @see elm_genlist_no_select_mode_set()
*
- * @ingroup List
+ * @ingroup Genlist
*/
- EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the type of mouse pointer/cursor decoration to be shown,
- * when the mouse pointer is over the given list widget item
- *
- * @param item list item to customize cursor on
- * @param cursor the cursor type's name
- *
- * This function works analogously as elm_object_cursor_set(), but
- * here the cursor's changing area is restricted to the item's
- * area, and not the whole widget's. Note that that item cursors
- * have precedence over widget cursors, so that a mouse over an
- * item with custom cursor set will always show @b that cursor.
- *
- * If this function is called twice for an object, a previously set
- * cursor will be unset on the second call.
- *
- * @see elm_object_cursor_set()
- * @see elm_list_item_cursor_get()
- * @see elm_list_item_cursor_unset()
+ * Enable/disable compress mode.
*
- * @ingroup List
- */
- EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
-
- /*
- * Get the type of mouse pointer/cursor decoration set to be shown,
- * when the mouse pointer is over the given list widget item
+ * @param obj The genlist object
+ * @param compress The compress mode
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
*
- * @param item list item with custom cursor set
- * @return the cursor type's name or @c NULL, if no custom cursors
- * were set to @p item (and on errors)
+ * This will enable the compress mode where items are "compressed"
+ * horizontally to fit the genlist scrollable viewport width. This is
+ * special for genlist. Do not rely on
+ * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
+ * work as genlist needs to handle it specially.
*
- * @see elm_object_cursor_get()
- * @see elm_list_item_cursor_set()
- * @see elm_list_item_cursor_unset()
+ * @see elm_genlist_compress_mode_get()
*
- * @ingroup List
+ * @ingroup Genlist
*/
- EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
/**
- * Unset any custom mouse pointer/cursor decoration set to be
- * shown, when the mouse pointer is over the given list widget
- * item, thus making it show the @b default cursor again.
- *
- * @param item a list item
+ * Get whether the compress mode is enabled.
*
- * Use this call to undo any custom settings on this item's cursor
- * decoration, bringing it back to defaults (no custom style set).
+ * @param obj The genlist object
+ * @return The compress mode
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off)
*
- * @see elm_object_cursor_unset()
- * @see elm_list_item_cursor_set()
+ * @see elm_genlist_compress_mode_set()
*
- * @ingroup List
+ * @ingroup Genlist
*/
- EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set a different @b style for a given custom cursor set for a
- * list item.
+ * Enable/disable height-for-width mode.
*
- * @param item list item with custom cursor set
- * @param style the <b>theme style</b> to use (e.g. @c "default",
- * @c "transparent", etc)
+ * @param obj The genlist object
+ * @param setting The height-for-width mode (@c EINA_TRUE = on,
+ * @c EINA_FALSE = off). Default is @c EINA_FALSE.
*
- * This function only makes sense when one is using custom mouse
- * cursor decorations <b>defined in a theme file</b>, which can have,
- * given a cursor name/type, <b>alternate styles</b> on it. It
- * works analogously as elm_object_cursor_style_set(), but here
- * applyed only to list item objects.
+ * With height-for-width mode the item width will be fixed (restricted
+ * to a minimum of) to the list width when calculating its size in
+ * order to allow the height to be calculated based on it. This allows,
+ * for instance, text block to wrap lines if the Edje part is
+ * configured with "text.min: 0 1".
*
- * @warning Before you set a cursor style you should have definen a
- * custom cursor previously on the item, with
- * elm_list_item_cursor_set()
+ * @note This mode will make list resize slower as it will have to
+ * recalculate every item height again whenever the list width
+ * changes!
*
- * @see elm_list_item_cursor_engine_only_set()
- * @see elm_list_item_cursor_style_get()
+ * @note When height-for-width mode is enabled, it also enables
+ * compress mode (see elm_genlist_compress_mode_set()) and
+ * disables homogeneous (see elm_genlist_homogeneous_set()).
*
- * @ingroup List
+ * @ingroup Genlist
*/
- EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
/**
- * Get the current @b style set for a given list item's custom
- * cursor
- *
- * @param item list item with custom cursor set.
- * @return style the cursor style in use. If the object does not
- * have a cursor set, then @c NULL is returned.
+ * Get whether the height-for-width mode is enabled.
*
- * @see elm_list_item_cursor_style_set() for more details
+ * @param obj The genlist object
+ * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
+ * off)
*
- * @ingroup List
+ * @ingroup Genlist
*/
- EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set if the (custom)cursor for a given list item should be
- * searched in its theme, also, or should only rely on the
- * rendering engine.
+ * Enable/disable horizontal and vertical bouncing effect.
*
- * @param item item with custom (custom) cursor already set on
- * @param engine_only Use @c EINA_TRUE to have cursors looked for
- * only on those provided by the rendering engine, @c EINA_FALSE to
- * have them searched on the widget's theme, as well.
+ * @param obj The genlist object
+ * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
+ * EINA_FALSE = off). Default is @c EINA_FALSE.
+ * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
+ * EINA_FALSE = off). Default is @c EINA_TRUE.
*
- * @note This call is of use only if you've set a custom cursor
- * for list items, with elm_list_item_cursor_set().
+ * This will enable or disable the scroller bouncing effect for the
+ * genlist. See elm_scroller_bounce_set() for details.
*
- * @note By default, cursors will only be looked for between those
- * provided by the rendering engine.
+ * @see elm_scroller_bounce_set()
+ * @see elm_genlist_bounce_get()
*
- * @ingroup List
+ * @ingroup Genlist
*/
- EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
/**
- * Get if the (custom) cursor for a given list item is being
- * searched in its theme, also, or is only relying on the rendering
- * engine.
+ * Get whether the horizontal and vertical bouncing effect is enabled.
*
- * @param item a list item
- * @return @c EINA_TRUE, if cursors are being looked for only on
- * those provided by the rendering engine, @c EINA_FALSE if they
- * are being searched on the widget's theme, as well.
+ * @param obj The genlist object
+ * @param h_bounce Pointer to a bool to receive if the bounce horizontally
+ * option is set.
+ * @param v_bounce Pointer to a bool to receive if the bounce vertically
+ * option is set.
*
- * @see elm_list_item_cursor_engine_only_set(), for more details
+ * @see elm_genlist_bounce_set()
*
- * @ingroup List
- */
- EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
-
- /**
- * @}
+ * @ingroup Genlist
*/
-
+ EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
/**
- * @defgroup Slider Slider
- * @ingroup Elementary
- *
- * @image html img/widget/slider/preview-00.png
- * @image latex img/widget/slider/preview-00.eps width=\textwidth
+ * Enable/disable homogenous mode.
*
- * The slider adds a dragable “slider” widget for selecting the value of
- * something within a range.
+ * @param obj The genlist object
+ * @param homogeneous Assume the items within the genlist are of the
+ * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
+ * EINA_FALSE.
*
- * A slider can be horizontal or vertical. It can contain an Icon and has a
- * primary label as well as a units label (that is formatted with floating
- * point values and thus accepts a printf-style format string, like
- * “%1.2f units”. There is also an indicator string that may be somewhere
- * else (like on the slider itself) that also accepts a format string like
- * units. Label, Icon Unit and Indicator strings/objects are optional.
+ * This will enable the homogeneous mode where items are of the same
+ * height and width so that genlist may do the lazy-loading at its
+ * maximum (which increases the performance for scrolling the list). This
+ * implies 'compressed' mode.
*
- * A slider may be inverted which means values invert, with high vales being
- * on the left or top and low values on the right or bottom (as opposed to
- * normally being low on the left or top and high on the bottom and right).
+ * @see elm_genlist_compress_mode_set()
+ * @see elm_genlist_homogeneous_get()
*
- * The slider should have its minimum and maximum values set by the
- * application with elm_slider_min_max_set() and value should also be set by
- * the application before use with elm_slider_value_set(). The span of the
- * slider is its length (horizontally or vertically). This will be scaled by
- * the object or applications scaling factor. At any point code can query the
- * slider for its value with elm_slider_value_get().
+ * @ingroup Genlist
+ */
+ EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
+ /**
+ * Get whether the homogenous mode is enabled.
*
- * Smart callbacks one can listen to:
- * - "changed" - Whenever the slider value is changed by the user.
- * - "slider,drag,start" - dragging the slider indicator around has started.
- * - "slider,drag,stop" - dragging the slider indicator around has stopped.
- * - "delay,changed" - A short time after the value is changed by the user.
- * This will be called only when the user stops dragging for
- * a very short period or when they release their
- * finger/mouse, so it avoids possibly expensive reactions to
- * the value change.
+ * @param obj The genlist object
+ * @return Assume the items within the genlist are of the same height
+ * and width (EINA_TRUE = on, EINA_FALSE = off)
*
- * Available styles for it:
- * - @c "default"
+ * @see elm_genlist_homogeneous_set()
*
- * Here is an example on its usage:
- * @li @ref slider_example
+ * @ingroup Genlist
*/
-
+ EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @addtogroup Slider
- * @{
+ * Set the maximum number of items within an item block
+ *
+ * @param obj The genlist object
+ * @param n Maximum number of items within an item block. Default is 32.
+ *
+ * This will configure the block count to tune to the target with
+ * particular performance matrix.
+ *
+ * A block of objects will be used to reduce the number of operations due to
+ * many objects in the screen. It can determine the visibility, or if the
+ * object has changed, it theme needs to be updated, etc. doing this kind of
+ * calculation to the entire block, instead of per object.
+ *
+ * The default value for the block count is enough for most lists, so unless
+ * you know you will have a lot of objects visible in the screen at the same
+ * time, don't try to change this.
+ *
+ * @see elm_genlist_block_count_get()
+ * @see @ref Genlist_Implementation
+ *
+ * @ingroup Genlist
*/
-
+ EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
/**
- * Add a new slider widget to the given parent Elementary
- * (container) object.
+ * Get the maximum number of items within an item block
*
- * @param parent The parent object.
- * @return a new slider widget handle or @c NULL, on errors.
+ * @param obj The genlist object
+ * @return Maximum number of items within an item block
*
- * This function inserts a new slider widget on the canvas.
+ * @see elm_genlist_block_count_set()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
-
+ EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the label of a given slider widget
+ * Set the timeout in seconds for the longpress event.
*
- * @param obj The progress bar object
- * @param label The text label string, in UTF-8
+ * @param obj The genlist object
+ * @param timeout timeout in seconds. Default is 1.
*
- * @ingroup Slider
- * @deprecated use elm_object_text_set() instead.
+ * This option will change how long it takes to send an event "longpressed"
+ * after the mouse down signal is sent to the list. If this event occurs, no
+ * "clicked" event will be sent.
+ *
+ * @see elm_genlist_longpress_timeout_set()
+ *
+ * @ingroup Genlist
*/
- EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
/**
- * Get the label of a given slider widget
+ * Get the timeout in seconds for the longpress event.
*
- * @param obj The progressbar object
- * @return The text label string, in UTF-8
+ * @param obj The genlist object
+ * @return timeout in seconds
*
- * @ingroup Slider
- * @deprecated use elm_object_text_get() instead.
+ * @see elm_genlist_longpress_timeout_get()
+ *
+ * @ingroup Genlist
*/
- EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the icon object of the slider object.
- *
- * @param obj The slider object.
- * @param icon The icon object.
+ * Append a new item in a given genlist widget.
*
- * On horizontal mode, icon is placed at left, and on vertical mode,
- * placed at top.
+ * @param obj The genlist object
+ * @param itc The item class for the item
+ * @param data The item data
+ * @param parent The parent item, or NULL if none
+ * @param flags Item flags
+ * @param func Convenience function called when the item is selected
+ * @param func_data Data passed to @p func above.
+ * @return A handle to the item added or @c NULL if not possible
*
- * @note Once the icon object is set, a previously set one will be deleted.
- * If you want to keep that old content object, use the
- * elm_slider_icon_unset() function.
+ * This adds the given item to the end of the list or the end of
+ * the children list if the @p parent is given.
*
- * @warning If the object being set does not have minimum size hints set,
- * it won't get properly displayed.
+ * @see elm_genlist_item_prepend()
+ * @see elm_genlist_item_insert_before()
+ * @see elm_genlist_item_insert_after()
+ * @see elm_genlist_item_del()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
-
+ 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);
/**
- * Unset an icon set on a given slider widget.
- *
- * @param obj The slider object.
- * @return The icon object that was being used, if any was set, or
- * @c NULL, otherwise (and on errors).
+ * Prepend a new item in a given genlist widget.
*
- * On horizontal mode, icon is placed at left, and on vertical mode,
- * placed at top.
+ * @param obj The genlist object
+ * @param itc The item class for the item
+ * @param data The item data
+ * @param parent The parent item, or NULL if none
+ * @param flags Item flags
+ * @param func Convenience function called when the item is selected
+ * @param func_data Data passed to @p func above.
+ * @return A handle to the item added or NULL if not possible
*
- * This call will unparent and return the icon object which was set
- * for this widget, previously, on success.
+ * This adds an item to the beginning of the list or beginning of the
+ * children of the parent if given.
*
- * @see elm_slider_icon_set() for more details
- * @see elm_slider_icon_get()
+ * @see elm_genlist_item_append()
+ * @see elm_genlist_item_insert_before()
+ * @see elm_genlist_item_insert_after()
+ * @see elm_genlist_item_del()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ 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);
/**
- * Retrieve the icon object set for a given slider widget.
+ * Insert an item before another in a genlist widget
*
- * @param obj The slider object.
- * @return The icon object's handle, if @p obj had one set, or @c NULL,
- * otherwise (and on errors).
+ * @param obj The genlist object
+ * @param itc The item class for the item
+ * @param data The item data
+ * @param before The item to place this new one before.
+ * @param flags Item flags
+ * @param func Convenience function called when the item is selected
+ * @param func_data Data passed to @p func above.
+ * @return A handle to the item added or @c NULL if not possible
*
- * On horizontal mode, icon is placed at left, and on vertical mode,
- * placed at top.
+ * This inserts an item before another in the list. It will be in the
+ * same tree level or group as the item it is inserted before.
*
- * @see elm_slider_icon_set() for more details
- * @see elm_slider_icon_unset()
+ * @see elm_genlist_item_append()
+ * @see elm_genlist_item_prepend()
+ * @see elm_genlist_item_insert_after()
+ * @see elm_genlist_item_del()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ 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);
/**
- * Set the end object of the slider object.
+ * Insert an item after another in a genlist widget
*
- * @param obj The slider object.
- * @param end The end object.
+ * @param obj The genlist object
+ * @param itc The item class for the item
+ * @param data The item data
+ * @param after The item to place this new one after.
+ * @param flags Item flags
+ * @param func Convenience function called when the item is selected
+ * @param func_data Data passed to @p func above.
+ * @return A handle to the item added or @c NULL if not possible
*
- * On horizontal mode, end is placed at left, and on vertical mode,
- * placed at bottom.
+ * This inserts an item after another in the list. It will be in the
+ * same tree level or group as the item it is inserted after.
*
- * @note Once the icon object is set, a previously set one will be deleted.
- * If you want to keep that old content object, use the
- * elm_slider_end_unset() function.
+ * @see elm_genlist_item_append()
+ * @see elm_genlist_item_prepend()
+ * @see elm_genlist_item_insert_before()
+ * @see elm_genlist_item_del()
*
- * @warning If the object being set does not have minimum size hints set,
- * it won't get properly displayed.
+ * @ingroup Genlist
+ */
+ 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);
+ /**
+ * Insert a new item into the sorted genlist object
*
- * @ingroup Slider
+ * @param obj The genlist object
+ * @param itc The item class for the item
+ * @param data The item data
+ * @param parent The parent item, or NULL if none
+ * @param flags Item flags
+ * @param comp The function called for the sort
+ * @param func Convenience function called when item selected
+ * @param func_data Data passed to @p func above.
+ * @return A handle to the item added or NULL if not possible
+ *
+ * @ingroup Genlist
*/
- EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
-
+ 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);
+ EAPI Elm_Genlist_Item *elm_genlist_item_direct_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);
+ /* operations to retrieve existing items */
/**
- * Unset an end object set on a given slider widget.
+ * Get the selectd item in the genlist.
*
- * @param obj The slider object.
- * @return The end object that was being used, if any was set, or
- * @c NULL, otherwise (and on errors).
+ * @param obj The genlist object
+ * @return The selected item, or NULL if none is selected.
*
- * On horizontal mode, end is placed at left, and on vertical mode,
- * placed at bottom.
+ * This gets the selected item in the list (if multi-selection is enabled, only
+ * the item that was first selected in the list is returned - which is not very
+ * useful, so see elm_genlist_selected_items_get() for when multi-selection is
+ * used).
*
- * This call will unparent and return the icon object which was set
- * for this widget, previously, on success.
+ * If no item is selected, NULL is returned.
*
- * @see elm_slider_end_set() for more details.
- * @see elm_slider_end_get()
+ * @see elm_genlist_selected_items_get()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Retrieve the end object set for a given slider widget.
+ * Get a list of selected items in the genlist.
*
- * @param obj The slider object.
- * @return The end object's handle, if @p obj had one set, or @c NULL,
- * otherwise (and on errors).
+ * @param obj The genlist object
+ * @return The list of selected items, or NULL if none are selected.
+ *
+ * It returns a list of the selected items. This list pointer is only valid so
+ * long as the selection doesn't change (no items are selected or unselected, or
+ * unselected implicitly by deletion). The list contains Elm_Genlist_Item
+ * pointers. The order of the items in this list is the order which they were
+ * selected, i.e. the first item in this list is the first item that was
+ * selected, and so on.
*
- * On horizontal mode, icon is placed at right, and on vertical mode,
- * placed at bottom.
+ * @note If not in multi-select mode, consider using function
+ * elm_genlist_selected_item_get() instead.
*
- * @see elm_slider_end_set() for more details.
- * @see elm_slider_end_unset()
+ * @see elm_genlist_multi_select_set()
+ * @see elm_genlist_selected_item_get()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the (exact) length of the bar region of a given slider widget.
- *
- * @param obj The slider object.
- * @param size The length of the slider's bar region.
+ * Get a list of realized items in genlist
*
- * This sets the minimum width (when in horizontal mode) or height
- * (when in vertical mode) of the actual bar area of the slider
- * @p obj. This in turn affects the object's minimum size. Use
- * this when you're not setting other size hints expanding on the
- * given direction (like weight and alignment hints) and you would
- * like it to have a specific size.
+ * @param obj The genlist object
+ * @return The list of realized items, nor NULL if none are realized.
*
- * @note Icon, end, label, indicator and unit text around @p obj
- * will require their
- * own space, which will make @p obj to require more the @p size,
- * actually.
+ * This returns a list of the realized items in the genlist. The list
+ * contains Elm_Genlist_Item pointers. The list must be freed by the
+ * caller when done with eina_list_free(). The item pointers in the
+ * list are only valid so long as those items are not deleted or the
+ * genlist is not deleted.
*
- * @see elm_slider_span_size_get()
+ * @see elm_genlist_realized_items_update()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the length set for the bar region of a given slider widget
+ * Get the item that is at the x, y canvas coords.
*
- * @param obj The slider object.
- * @return The length of the slider's bar region.
+ * @param obj The gelinst object.
+ * @param x The input x coordinate
+ * @param y The input y coordinate
+ * @param posret The position relative to the item returned here
+ * @return The item at the coordinates or NULL if none
*
- * If that size was not set previously, with
- * elm_slider_span_size_set(), this call will return @c 0.
+ * This returns the item at the given coordinates (which are canvas
+ * relative, not object-relative). If an item is at that coordinate,
+ * that item handle is returned, and if @p posret is not NULL, the
+ * integer pointed to is set to a value of -1, 0 or 1, depending if
+ * the coordinate is on the upper portion of that item (-1), on the
+ * middle section (0) or on the lower part (1). If NULL is returned as
+ * an item (no item found there), then posret may indicate -1 or 1
+ * based if the coordinate is above or below all items respectively in
+ * the genlist.
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ 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);
/**
- * Set the format string for the unit label.
- *
- * @param obj The slider object.
- * @param format The format string for the unit display.
- *
- * Unit label is displayed all the time, if set, after slider's bar.
- * In horizontal mode, at right and in vertical mode, at bottom.
- *
- * If @c NULL, unit label won't be visible. If not it sets the format
- * string for the label text. To the label text is provided a floating point
- * value, so the label text can display up to 1 floating point value.
- * Note that this is optional.
- *
- * Use a format string such as "%1.2f meters" for example, and it will
- * display values like: "3.14 meters" for a value equal to 3.14159.
+ * Get the first item in the genlist
*
- * Default is unit label disabled.
+ * This returns the first item in the list.
*
- * @see elm_slider_indicator_format_get()
+ * @param obj The genlist object
+ * @return The first item, or NULL if none
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
-
+ EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the unit label format of the slider.
- *
- * @param obj The slider object.
- * @return The unit label format string in UTF-8.
+ * Get the last item in the genlist
*
- * Unit label is displayed all the time, if set, after slider's bar.
- * In horizontal mode, at right and in vertical mode, at bottom.
+ * This returns the last item in the list.
*
- * @see elm_slider_unit_format_set() for more
- * information on how this works.
+ * @return The last item, or NULL if none
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the format string for the indicator label.
+ * Set the scrollbar policy
*
- * @param obj The slider object.
- * @param indicator The format string for the indicator display.
+ * @param obj The genlist object
+ * @param policy_h Horizontal scrollbar policy.
+ * @param policy_v Vertical scrollbar policy.
*
- * The slider may display its value somewhere else then unit label,
- * for example, above the slider knob that is dragged around. This function
- * sets the format string used for this.
+ * This sets the scrollbar visibility policy for the given genlist
+ * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
+ * made visible if it is needed, and otherwise kept hidden.
+ * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
+ * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
+ * respectively for the horizontal and vertical scrollbars. Default is
+ * #ELM_SMART_SCROLLER_POLICY_AUTO
*
- * If @c NULL, indicator label won't be visible. If not it sets the format
- * string for the label text. To the label text is provided a floating point
- * value, so the label text can display up to 1 floating point value.
- * Note that this is optional.
+ * @see elm_genlist_scroller_policy_get()
*
- * Use a format string such as "%1.2f meters" for example, and it will
- * display values like: "3.14 meters" for a value equal to 3.14159.
+ * @ingroup Genlist
+ */
+ EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
+ /**
+ * Get the scrollbar policy
*
- * Default is indicator label disabled.
+ * @param obj The genlist object
+ * @param policy_h Pointer to store the horizontal scrollbar policy.
+ * @param policy_v Pointer to store the vertical scrollbar policy.
*
- * @see elm_slider_indicator_format_get()
+ * @see elm_genlist_scroller_policy_set()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
-
+ 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);
/**
- * Get the indicator label format of the slider.
+ * Get the @b next item in a genlist widget's internal list of items,
+ * given a handle to one of those items.
*
- * @param obj The slider object.
- * @return The indicator label format string in UTF-8.
+ * @param item The genlist item to fetch next from
+ * @return The item after @p item, or @c NULL if there's none (and
+ * on errors)
*
- * The slider may display its value somewhere else then unit label,
- * for example, above the slider knob that is dragged around. This function
- * gets the format string used for this.
+ * This returns the item placed after the @p item, on the container
+ * genlist.
*
- * @see elm_slider_indicator_format_set() for more
- * information on how this works.
+ * @see elm_genlist_item_prev_get()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * Set the format function pointer for the indicator label
+ * Get the @b previous item in a genlist widget's internal list of items,
+ * given a handle to one of those items.
*
- * @param obj The slider object.
- * @param func The indicator format function.
- * @param free_func The freeing function for the format string.
+ * @param item The genlist item to fetch previous from
+ * @return The item before @p item, or @c NULL if there's none (and
+ * on errors)
*
- * Set the callback function to format the indicator string.
+ * This returns the item placed before the @p item, on the container
+ * genlist.
*
- * @see elm_slider_indicator_format_set() for more info on how this works.
+ * @see elm_genlist_item_next_get()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI void elm_slider_indicator_format_function_set(Evas_Object *obj, const char *(*func)(double val), void (*free_func)(const char *str)) EINA_ARG_NONNULL(1);
-
- /**
- * Set the format function pointer for the units label
- *
- * @param obj The slider object.
- * @param func The units format function.
- * @param free_func The freeing function for the format string.
- *
- * Set the callback function to format the indicator string.
- *
- * @see elm_slider_units_format_set() for more info on how this works.
- *
- * @ingroup Slider
- */
- EAPI void elm_slider_units_format_function_set(Evas_Object *obj, const char *(*func)(double val), void (*free_func)(const char *str)) EINA_ARG_NONNULL(1);
-
- /**
- * Set the orientation of a given slider widget.
- *
- * @param obj The slider object.
- * @param horizontal Use @c EINA_TRUE to make @p obj to be
- * @b horizontal, @c EINA_FALSE to make it @b vertical.
- *
- * Use this function to change how your slider is to be
- * disposed: vertically or horizontally.
- *
- * By default it's displayed horizontally.
- *
- * @see elm_slider_horizontal_get()
- *
- * @ingroup Slider
- */
- EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
-
+ EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * Retrieve the orientation of a given slider widget
+ * Get the genlist object's handle which contains a given genlist
+ * item
*
- * @param obj The slider object.
- * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
- * @c EINA_FALSE if it's @b vertical (and on errors).
+ * @param item The item to fetch the container from
+ * @return The genlist (parent) object
*
- * @see elm_slider_horizontal_set() for more details.
+ * This returns the genlist object itself that an item belongs to.
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * Set the minimum and maximum values for the slider.
+ * Get the parent item of the given item
*
- * @param obj The slider object.
- * @param min The minimum value.
- * @param max The maximum value.
+ * @param it The item
+ * @return The parent of the item or @c NULL if it has no parent.
*
- * Define the allowed range of values to be selected by the user.
+ * This returns the item that was specified as parent of the item @p it on
+ * elm_genlist_item_append() and insertion related functions.
*
- * If actual value is less than @p min, it will be updated to @p min. If it
- * is bigger then @p max, will be updated to @p max. Actual value can be
- * get with elm_slider_value_get().
+ * @ingroup Genlist
+ */
+ EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+ /**
+ * Remove all sub-items (children) of the given item
*
- * By default, min is equal to 0.0, and max is equal to 1.0.
+ * @param it The item
*
- * @warning Maximum must be greater than minimum, otherwise behavior
- * is undefined.
+ * This removes all items that are children (and their descendants) of the
+ * given item @p it.
*
- * @see elm_slider_min_max_get()
+ * @see elm_genlist_clear()
+ * @see elm_genlist_item_del()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * Get the minimum and maximum values of the slider.
+ * Set whether a given genlist item is selected or not
*
- * @param obj The slider object.
- * @param min Pointer where to store the minimum value.
- * @param max Pointer where to store the maximum value.
+ * @param it The item
+ * @param selected Use @c EINA_TRUE, to make it selected, @c
+ * EINA_FALSE to make it unselected
*
- * @note If only one value is needed, the other pointer can be passed
- * as @c NULL.
+ * This sets the selected state of an item. If multi selection is
+ * not enabled on the containing genlist and @p selected is @c
+ * EINA_TRUE, any other previously selected items will get
+ * unselected in favor of this new one.
*
- * @see elm_slider_min_max_set() for details.
+ * @see elm_genlist_item_selected_get()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
/**
- * Set the value the slider displays.
- *
- * @param obj The slider object.
- * @param val The value to be displayed.
- *
- * Value will be presented on the unit label following format specified with
- * elm_slider_unit_format_set() and on indicator with
- * elm_slider_indicator_format_set().
+ * Get whether a given genlist item is selected or not
*
- * @warning The value must to be between min and max values. This values
- * are set by elm_slider_min_max_set().
+ * @param it The item
+ * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
*
- * @see elm_slider_value_get()
- * @see elm_slider_unit_format_set()
- * @see elm_slider_indicator_format_set()
- * @see elm_slider_min_max_set()
+ * @see elm_genlist_item_selected_set() for more details
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * Get the value displayed by the spinner.
+ * Sets the expanded state of an item.
*
- * @param obj The spinner object.
- * @return The value displayed.
+ * @param it The item
+ * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
*
- * @see elm_spinner_value_set() for details.
+ * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
+ * expanded or not.
*
- * @ingroup Slider
+ * The theme will respond to this change visually, and a signal "expanded" or
+ * "contracted" will be sent from the genlist with a pointer to the item that
+ * has been expanded/contracted.
+ *
+ * Calling this function won't show or hide any child of this item (if it is
+ * a parent). You must manually delete and create them on the callbacks fo
+ * the "expanded" or "contracted" signals.
+ *
+ * @see elm_genlist_item_expanded_get()
+ *
+ * @ingroup Genlist
*/
- EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
/**
- * Invert a given slider widget's displaying values order
+ * Get the expanded state of an item
*
- * @param obj The slider object.
- * @param inverted Use @c EINA_TRUE to make @p obj inverted,
- * @c EINA_FALSE to bring it back to default, non-inverted values.
+ * @param it The item
+ * @return The expanded state
*
- * A slider may be @b inverted, in which state it gets its
- * values inverted, with high vales being on the left or top and
- * low values on the right or bottom, as opposed to normally have
- * the low values on the former and high values on the latter,
- * respectively, for horizontal and vertical modes.
+ * This gets the expanded state of an item.
*
- * @see elm_slider_inverted_get()
+ * @see elm_genlist_item_expanded_set()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
-
+ EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * Get whether a given slider widget's displaying values are
- * inverted or not.
- *
- * @param obj The slider object.
- * @return @c EINA_TRUE, if @p obj has inverted values,
- * @c EINA_FALSE otherwise (and on errors).
+ * Get the depth of expanded item
*
- * @see elm_slider_inverted_set() for more details.
+ * @param it The genlist item object
+ * @return The depth of expanded item
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
/**
- * Set whether to enlarge slider indicator (augmented knob) or not.
+ * Set whether a given genlist item is disabled or not.
*
- * @param obj The slider object.
- * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
- * let the knob always at default size.
+ * @param it The item
+ * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
+ * to enable it back.
*
- * By default, indicator will be bigger while dragged by the user.
+ * A disabled item cannot be selected or unselected. It will also
+ * change its appearance, to signal the user it's disabled.
*
- * @warning It won't display values set with
- * elm_slider_indicator_format_set() if you disable indicator.
+ * @see elm_genlist_item_disabled_get()
*
- * @ingroup Slider
+ * @ingroup Genlist
*/
- EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
/**
- * Get whether a given slider widget's enlarging indicator or not.
+ * Get whether a given genlist item is disabled or not.
*
- * @param obj The slider object.
- * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
- * @c EINA_FALSE otherwise (and on errors).
+ * @param it The item
+ * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
+ * (and on errors).
*
- * @see elm_slider_indicator_show_set() for details.
+ * @see elm_genlist_item_disabled_set() for more details
*
- * @ingroup Slider
- */
- EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /**
- * @}
+ * @ingroup Genlist
*/
-
+ EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * @addtogroup Actionslider Actionslider
- *
- * @image html img/widget/actionslider/preview-00.png
- * @image latex img/widget/actionslider/preview-00.eps
+ * Sets the display only state of an item.
*
- * A actionslider is a switcher for 2 or 3 labels with customizable magnet
- * properties. The indicator is the element the user drags to choose a label.
- * When the position is set with magnet, when released the indicator will be
- * moved to it if it's nearest the magnetized position.
+ * @param it The item
+ * @param display_only @c EINA_TRUE if the item is display only, @c
+ * EINA_FALSE otherwise.
*
- * @note By default all positions are set as enabled.
+ * A display only item cannot be selected or unselected. It is for
+ * display only and not selecting or otherwise clicking, dragging
+ * etc. by the user, thus finger size rules will not be applied to
+ * this item.
*
- * Signals that you can add callbacks for are:
+ * It's good to set group index items to display only state.
*
- * "selected" - when user selects an enabled position (the label is passed
- * as event info)".
- * @n
- * "pos_changed" - when the indicator reaches any of the positions("left",
- * "right" or "center").
+ * @see elm_genlist_item_display_only_get()
*
- * See an example of actionslider usage @ref actionslider_example_page "here"
- * @{
+ * @ingroup Genlist
*/
- typedef enum _Elm_Actionslider_Pos
- {
- ELM_ACTIONSLIDER_NONE = 0,
- ELM_ACTIONSLIDER_LEFT = 1 << 0,
- ELM_ACTIONSLIDER_CENTER = 1 << 1,
- ELM_ACTIONSLIDER_RIGHT = 1 << 2,
- ELM_ACTIONSLIDER_ALL = (1 << 3) -1
- } Elm_Actionslider_Pos;
-
+ EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
/**
- * Add a new actionslider to the parent.
+ * Get the display only state of an item
*
- * @param parent The parent object
- * @return The new actionslider object or NULL if it cannot be created
- */
- EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
- /**
- * Set actionslider labels.
+ * @param it The item
+ * @return @c EINA_TRUE if the item is display only, @c
+ * EINA_FALSE otherwise.
*
- * @param obj The actionslider object
- * @param left_label The label to be set on the left.
- * @param center_label The label to be set on the center.
- * @param right_label The label to be set on the right.
- * @deprecated use elm_object_text_set() instead.
- */
- EINA_DEPRECATED 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);
- /**
- * Get actionslider labels.
+ * @see elm_genlist_item_display_only_set()
*
- * @param obj The actionslider object
- * @param left_label A char** to place the left_label of @p obj into.
- * @param center_label A char** to place the center_label of @p obj into.
- * @param right_label A char** to place the right_label of @p obj into.
- * @deprecated use elm_object_text_set() instead.
+ * @ingroup Genlist
*/
- EINA_DEPRECATED 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);
+ EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
/**
- * Get actionslider selected label.
+ * Show the portion of a genlist's internal list containing a given
+ * item, immediately.
*
- * @param obj The actionslider object
- * @return The selected label
- */
- EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Set actionslider indicator position.
+ * @param it The item to display
*
- * @param obj The actionslider object.
- * @param pos The position of the indicator.
+ * This causes genlist to jump to the given item @p it and show it (by
+ * immediately scrolling to that position), if it is not fully visible.
+ *
+ * @see elm_genlist_item_bring_in()
+ * @see elm_genlist_item_top_show()
+ * @see elm_genlist_item_middle_show()
+ *
+ * @ingroup Genlist
*/
- EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
+ EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * Get actionslider indicator position.
+ * Animatedly bring in, to the visible are of a genlist, a given
+ * item on it.
+ *
+ * @param it The item to display
+ *
+ * This causes genlist to jump to the given item @p it and show it (by
+ * animatedly scrolling), if it is not fully visible. This may use animation
+ * to do so and take a period of time
+ *
+ * @see elm_genlist_item_show()
+ * @see elm_genlist_item_top_bring_in()
+ * @see elm_genlist_item_middle_bring_in()
*
- * @param obj The actionslider object.
- * @return The position of the indicator.
+ * @ingroup Genlist
*/
- EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * Set actionslider magnet position. To make multiple positions magnets @c or
- * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
+ * Show the portion of a genlist's internal list containing a given
+ * item, immediately.
*
- * @param obj The actionslider object.
- * @param pos Bit mask indicating the magnet positions.
- */
- EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
- /**
- * Get actionslider magnet position.
+ * @param it The item to display
*
- * @param obj The actionslider object.
- * @return The positions with magnet property.
+ * This causes genlist to jump to the given item @p it and show it (by
+ * immediately scrolling to that position), if it is not fully visible.
+ *
+ * The item will be positioned at the top of the genlist viewport.
+ *
+ * @see elm_genlist_item_show()
+ * @see elm_genlist_item_top_bring_in()
+ *
+ * @ingroup Genlist
*/
- EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * Set actionslider enabled position. To set multiple positions as enabled @c or
- * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
+ * Animatedly bring in, to the visible are of a genlist, a given
+ * item on it.
*
- * @note All the positions are enabled by default.
+ * @param it The item
*
- * @param obj The actionslider object.
- * @param pos Bit mask indicating the enabled positions.
+ * This causes genlist to jump to the given item @p it and show it (by
+ * animatedly scrolling), if it is not fully visible. This may use animation
+ * to do so and take a period of time
+ *
+ * The item will be positioned at the top of the genlist viewport.
+ *
+ * @see elm_genlist_item_bring_in()
+ * @see elm_genlist_item_top_show()
+ *
+ * @ingroup Genlist
*/
- EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
+ EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * Get actionslider enabled position.
+ * Show the portion of a genlist's internal list containing a given
+ * item, immediately.
*
- * @param obj The actionslider object.
- * @return The enabled positions.
+ * @param it The item to display
+ *
+ * This causes genlist to jump to the given item @p it and show it (by
+ * immediately scrolling to that position), if it is not fully visible.
+ *
+ * The item will be positioned at the middle of the genlist viewport.
+ *
+ * @see elm_genlist_item_show()
+ * @see elm_genlist_item_middle_bring_in()
+ *
+ * @ingroup Genlist
*/
- EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
/**
- * Set the label used on the indicator.
+ * Animatedly bring in, to the visible are of a genlist, a given
+ * item on it.
*
- * @param obj The actionslider object
- * @param label The label to be set on the indicator.
- * @deprecated use elm_object_text_set() instead.
+ * @param it The item
+ *
+ * This causes genlist to jump to the given item @p it and show it (by
+ * animatedly scrolling), if it is not fully visible. This may use animation
+ * to do so and take a period of time
+ *
+ * The item will be positioned at the middle of the genlist viewport.
+ *
+ * @see elm_genlist_item_bring_in()
+ * @see elm_genlist_item_middle_show()
+ *
+ * @ingroup Genlist
*/
- EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+ EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
/**
- * Get the label used on the indicator object.
+ * Remove a genlist item from the its parent, deleting it.
*
- * @param obj The actionslider object
- * @return The indicator label
- * @deprecated use elm_object_text_get() instead.
+ * @param item The item to be removed.
+ * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
+ *
+ * @see elm_genlist_clear(), to remove all items in a genlist at
+ * once.
+ *
+ * @ingroup Genlist
*/
- EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * @}
+ * Return the data associated to a given genlist item
+ *
+ * @param item The genlist item.
+ * @return the data associated to this item.
+ *
+ * This returns the @c data value passed on the
+ * elm_genlist_item_append() and related item addition calls.
+ *
+ * @see elm_genlist_item_append()
+ * @see elm_genlist_item_data_set()
+ *
+ * @ingroup Genlist
*/
-
+ EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * @defgroup Genlist Genlist
+ * Set the data associated to a given genlist item
*
- * @image html img/widget/genlist/preview-00.png
- * @image latex img/widget/genlist/preview-00.eps
- * @image html img/genlist.png
- * @image latex img/genlist.eps
+ * @param item The genlist item
+ * @param data The new data pointer to set on it
*
- * This widget aims to have more expansive list than the simple list in
- * Elementary that could have more flexible items and allow many more entries
- * while still being fast and low on memory usage. At the same time it was
- * also made to be able to do tree structures. But the price to pay is more
- * complexity when it comes to usage. If all you want is a simple list with
- * icons and a single label, use the normal @ref List object.
+ * This @b overrides the @c data value passed on the
+ * elm_genlist_item_append() and related item addition calls. This
+ * function @b won't call elm_genlist_item_update() automatically,
+ * so you'd issue it afterwards if you want to hove the item
+ * updated to reflect the that new data.
*
- * Genlist has a fairly large API, mostly because it's relatively complex,
- * trying to be both expansive, powerful and efficient. First we will begin
- * an overview on the theory behind genlist.
+ * @see elm_genlist_item_data_get()
*
- * @section Genlist_Item_Class Genlist item classes - creating items
+ * @ingroup Genlist
+ */
+ EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
+ /**
+ * Tells genlist to "orphan" icons fetchs by the item class
*
- * In order to have the ability to add and delete items on the fly, genlist
- * implements a class (callback) system where the application provides a
- * structure with information about that type of item (genlist may contain
- * multiple different items with different classes, states and styles).
- * Genlist will call the functions in this struct (methods) when an item is
- * "realized" (i.e., created dynamically, while the user is scrolling the
- * grid). All objects will simply be deleted when no longer needed with
- * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
- * following members:
- * - @c item_style - This is a constant string and simply defines the name
- * of the item style. It @b must be specified and the default should be @c
- * "default".
+ * @param it The item
*
- * - @c func - A struct with pointers to functions that will be called when
- * an item is going to be actually created. All of them receive a @c data
- * parameter that will point to the same data passed to
- * elm_genlist_item_append() and related item creation functions, and a @c
- * obj parameter that points to the genlist object itself.
+ * This instructs genlist to release references to icons in the item,
+ * meaning that they will no longer be managed by genlist and are
+ * floating "orphans" that can be re-used elsewhere if the user wants
+ * to.
*
- * The function pointers inside @c func are @c label_get, @c icon_get, @c
- * state_get and @c del. The 3 first functions also receive a @c part
- * parameter described below. A brief description of these functions follows:
+ * @ingroup Genlist
+ */
+ EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+ /**
+ * Get the real Evas object created to implement the view of a
+ * given genlist item
*
- * - @c label_get - The @c part parameter is the name string of one of the
- * existing text parts in the Edje group implementing the item's theme.
- * This function @b must return a strdup'()ed string, as the caller will
- * free() it when done. See #GenlistItemLabelGetFunc.
- * - @c icon_get - The @c part parameter is the name string of one of the
- * existing (icon) swallow parts in the Edje group implementing the item's
- * theme. It must return @c NULL, when no icon is desired, or a valid
- * object handle, otherwise. The object will be deleted by the genlist on
- * its deletion or when the item is "unrealized". See
- * #GenlistItemIconGetFunc.
- * - @c func.state_get - The @c part parameter is the name string of one of
- * the state parts in the Edje group implementing the item's theme. Return
- * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
- * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
- * and @c "elm" as "emission" and "source" arguments, respectively, when
- * the state is true (the default is false), where @c XXX is the name of
- * the (state) part. See #GenlistItemStateGetFunc.
- * - @c func.del - This is intended for use when genlist items are deleted,
- * so any data attached to the item (e.g. its data parameter on creation)
- * can be deleted. See #GenlistItemDelFunc.
+ * @param item The genlist item.
+ * @return the Evas object implementing this item's view.
*
- * available item styles:
- * - default
- * - default_style - The text part is a textblock
+ * This returns the actual Evas object used to implement the
+ * specified genlist item's view. This may be @c NULL, as it may
+ * not have been created or may have been deleted, at any time, by
+ * the genlist. <b>Do not modify this object</b> (move, resize,
+ * show, hide, etc.), as the genlist is controlling it. This
+ * function is for querying, emitting custom signals or hooking
+ * lower level callbacks for events on that object. Do not delete
+ * this object under any circumstances.
*
- * @image html img/widget/genlist/preview-04.png
- * @image latex img/widget/genlist/preview-04.eps
+ * @see elm_genlist_item_data_get()
*
- * - double_label
+ * @ingroup Genlist
+ */
+ EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+ /**
+ * Update the contents of an item
*
- * @image html img/widget/genlist/preview-01.png
- * @image latex img/widget/genlist/preview-01.eps
+ * @param it The item
*
- * - icon_top_text_bottom
+ * This updates an item by calling all the item class functions again
+ * to get the icons, labels and states. Use this when the original
+ * item data has changed and the changes are desired to be reflected.
*
- * @image html img/widget/genlist/preview-02.png
- * @image latex img/widget/genlist/preview-02.eps
+ * Use elm_genlist_realized_items_update() to update all already realized
+ * items.
*
- * - group_index
+ * @see elm_genlist_realized_items_update()
*
- * @image html img/widget/genlist/preview-03.png
- * @image latex img/widget/genlist/preview-03.eps
+ * @ingroup Genlist
+ */
+ EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ /**
+ * Update the item class of an item
*
- * @section Genlist_Items Structure of items
+ * @param it The item
+ * @param itc The item class for the item
*
- * An item in a genlist can have 0 or more text labels (they can be regular
- * text or textblock Evas objects - that's up to the style to determine), 0
- * or more icons (which are simply objects swallowed into the genlist item's
- * theming Edje object) and 0 or more <b>boolean states</b>, which have the
- * behavior left to the user to define. The Edje part names for each of
- * these properties will be looked up, in the theme file for the genlist,
- * under the Edje (string) data items named @c "labels", @c "icons" and @c
- * "states", respectively. For each of those properties, if more than one
- * part is provided, they must have names listed separated by spaces in the
- * data fields. For the default genlist item theme, we have @b one label
- * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
- * "elm.swallow.end") and @b no state parts.
+ * This sets another class fo the item, changing the way that it is
+ * displayed. After changing the item class, elm_genlist_item_update() is
+ * called on the item @p it.
*
- * A genlist item may be at one of several styles. Elementary provides one
- * by default - "default", but this can be extended by system or application
- * custom themes/overlays/extensions (see @ref Theme "themes" for more
- * details).
+ * @ingroup Genlist
+ */
+ EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
+ EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+ /**
+ * Set the text to be shown in a given genlist item's tooltips.
*
- * @section Genlist_Manipulation Editing and Navigating
+ * @param item The genlist item
+ * @param text The text to set in the content
*
- * Items can be added by several calls. All of them return a @ref
- * Elm_Genlist_Item handle that is an internal member inside the genlist.
- * They all take a data parameter that is meant to be used for a handle to
- * the applications internal data (eg the struct with the original item
- * data). The parent parameter is the parent genlist item this belongs to if
- * it is a tree or an indexed group, and NULL if there is no parent. The
- * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
- * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
- * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
- * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
- * is set then this item is group index item that is displayed at the top
- * until the next group comes. The func parameter is a convenience callback
- * that is called when the item is selected and the data parameter will be
- * the func_data parameter, obj be the genlist object and event_info will be
- * the genlist item.
+ * This call will setup the text to be used as tooltip to that item
+ * (analogous to elm_object_tooltip_text_set(), but being item
+ * tooltips with higher precedence than object tooltips). It can
+ * have only one tooltip at a time, so any previous tooltip data
+ * will get removed.
*
- * elm_genlist_item_append() adds an item to the end of the list, or if
- * there is a parent, to the end of all the child items of the parent.
- * elm_genlist_item_prepend() is the same but adds to the beginning of
- * the list or children list. elm_genlist_item_insert_before() inserts at
- * item before another item and elm_genlist_item_insert_after() inserts after
- * the indicated item.
+ * In order to set an icon or something else as a tooltip, look at
+ * elm_genlist_item_tooltip_content_cb_set().
*
- * The application can clear the list with elm_genlist_clear() which deletes
- * all the items in the list and elm_genlist_item_del() will delete a specific
- * item. elm_genlist_item_subitems_clear() will clear all items that are
- * children of the indicated parent item.
+ * @ingroup Genlist
+ */
+ EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
+ /**
+ * Set the content to be shown in a given genlist item's tooltips
*
- * To help inspect list items you can jump to the item at the top of the list
- * with elm_genlist_first_item_get() which will return the item pointer, and
- * similarly elm_genlist_last_item_get() gets the item at the end of the list.
- * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
- * and previous items respectively relative to the indicated item. Using
- * these calls you can walk the entire item list/tree. Note that as a tree
- * the items are flattened in the list, so elm_genlist_item_parent_get() will
- * let you know which item is the parent (and thus know how to skip them if
- * wanted).
+ * @param item The genlist item.
+ * @param func The function returning the tooltip contents.
+ * @param data What to provide to @a func as callback data/context.
+ * @param del_cb Called when data is not needed anymore, either when
+ * another callback replaces @p func, the tooltip is unset with
+ * elm_genlist_item_tooltip_unset() or the owner @p item
+ * dies. This callback receives as its first parameter the
+ * given @p data, being @c event_info the item handle.
*
- * @section Genlist_Muti_Selection Multi-selection
+ * This call will setup the tooltip's contents to @p item
+ * (analogous to elm_object_tooltip_content_cb_set(), but being
+ * item tooltips with higher precedence than object tooltips). It
+ * can have only one tooltip at a time, so any previous tooltip
+ * content will get removed. @p func (with @p data) will be called
+ * every time Elementary needs to show the tooltip and it should
+ * return a valid Evas object, which will be fully managed by the
+ * tooltip system, getting deleted when the tooltip is gone.
*
- * If the application wants multiple items to be able to be selected,
- * elm_genlist_multi_select_set() can enable this. If the list is
- * single-selection only (the default), then elm_genlist_selected_item_get()
- * will return the selected item, if any, or NULL I none is selected. If the
- * list is multi-select then elm_genlist_selected_items_get() will return a
- * list (that is only valid as long as no items are modified (added, deleted,
- * selected or unselected)).
+ * In order to set just a text as a tooltip, look at
+ * elm_genlist_item_tooltip_text_set().
*
- * @section Genlist_Usage_Hints Usage hints
+ * @ingroup Genlist
+ */
+ 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);
+ /**
+ * Unset a tooltip from a given genlist item
*
- * There are also convenience functions. elm_genlist_item_genlist_get() will
- * return the genlist object the item belongs to. elm_genlist_item_show()
- * will make the scroller scroll to show that specific item so its visible.
- * elm_genlist_item_data_get() returns the data pointer set by the item
- * creation functions.
+ * @param item genlist item to remove a previously set tooltip from.
*
- * If an item changes (state of boolean changes, label or icons change),
- * then use elm_genlist_item_update() to have genlist update the item with
- * the new state. Genlist will re-realize the item thus call the functions
- * in the _Elm_Genlist_Item_Class for that item.
+ * This call removes any tooltip set on @p item. The callback
+ * provided as @c del_cb to
+ * elm_genlist_item_tooltip_content_cb_set() will be called to
+ * notify it is not used anymore (and have resources cleaned, if
+ * need be).
*
- * To programmatically (un)select an item use elm_genlist_item_selected_set().
- * To get its selected state use elm_genlist_item_selected_get(). Similarly
- * to expand/contract an item and get its expanded state, use
- * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
- * again to make an item disabled (unable to be selected and appear
- * differently) use elm_genlist_item_disabled_set() to set this and
- * elm_genlist_item_disabled_get() to get the disabled state.
+ * @see elm_genlist_item_tooltip_content_cb_set()
*
- * In general to indicate how the genlist should expand items horizontally to
- * fill the list area, use elm_genlist_horizontal_mode_set(). Valid modes are
- * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
- * mode means that if items are too wide to fit, the scroller will scroll
- * horizontally. Otherwise items are expanded to fill the width of the
- * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
- * to the viewport width and limited to that size. This can be combined with
- * a different style that uses edjes' ellipsis feature (cutting text off like
- * this: "tex...").
+ * @ingroup Genlist
+ */
+ EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ /**
+ * Set a different @b style for a given genlist item's tooltip.
*
- * Items will only call their selection func and callback when first becoming
- * selected. Any further clicks will do nothing, unless you enable always
- * select with elm_genlist_always_select_mode_set(). This means even if
- * selected, every click will make the selected callbacks be called.
- * elm_genlist_no_select_mode_set() will turn off the ability to select
- * items entirely and they will neither appear selected nor call selected
- * callback functions.
+ * @param item genlist item with tooltip set
+ * @param style the <b>theme style</b> to use on tooltips (e.g. @c
+ * "default", @c "transparent", etc)
*
- * Remember that you can create new styles and add your own theme augmentation
- * per application with elm_theme_extension_add(). If you absolutely must
- * have a specific style that overrides any theme the user or system sets up
- * you can use elm_theme_overlay_add() to add such a file.
+ * Tooltips can have <b>alternate styles</b> to be displayed on,
+ * which are defined by the theme set on Elementary. This function
+ * works analogously as elm_object_tooltip_style_set(), but here
+ * applied only to genlist item objects. The default style for
+ * tooltips is @c "default".
*
- * @section Genlist_Implementation Implementation
+ * @note before you set a style you should define a tooltip with
+ * elm_genlist_item_tooltip_content_cb_set() or
+ * elm_genlist_item_tooltip_text_set()
*
- * Evas tracks every object you create. Every time it processes an event
- * (mouse move, down, up etc.) it needs to walk through objects and find out
- * what event that affects. Even worse every time it renders display updates,
- * in order to just calculate what to re-draw, it needs to walk through many
- * many many objects. Thus, the more objects you keep active, the more
- * overhead Evas has in just doing its work. It is advisable to keep your
- * active objects to the minimum working set you need. Also remember that
- * object creation and deletion carries an overhead, so there is a
- * middle-ground, which is not easily determined. But don't keep massive lists
- * of objects you can't see or use. Genlist does this with list objects. It
- * creates and destroys them dynamically as you scroll around. It groups them
- * into blocks so it can determine the visibility etc. of a whole block at
- * once as opposed to having to walk the whole list. This 2-level list allows
- * for very large numbers of items to be in the list (tests have used up to
- * 2,000,000 items). Also genlist employs a queue for adding items. As items
- * may be different sizes, every item added needs to be calculated as to its
- * size and thus this presents a lot of overhead on populating the list, this
- * genlist employs a queue. Any item added is queued and spooled off over
- * time, actually appearing some time later, so if your list has many members
- * you may find it takes a while for them to all appear, with your process
- * consuming a lot of CPU while it is busy spooling.
+ * @see elm_genlist_item_tooltip_style_get()
*
- * Genlist also implements a tree structure, but it does so with callbacks to
- * the application, with the application filling in tree structures when
- * requested (allowing for efficient building of a very deep tree that could
- * even be used for file-management). See the above smart signal callbacks for
- * details.
+ * @ingroup Genlist
+ */
+ EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
+ /**
+ * Get the style set a given genlist item's tooltip.
*
- * @section Genlist_Smart_Events Genlist smart events
+ * @param item genlist item with tooltip already set on.
+ * @return style the theme style in use, which defaults to
+ * "default". If the object does not have a tooltip set,
+ * then @c NULL is returned.
*
- * Signals that you can add callbacks for are:
- * - @c "activated" - The user has double-clicked or pressed
- * (enter|return|spacebar) on an item. The @c event_info parameter is the
- * item that was activated.
- * - @c "clicked,double" - The user has double-clicked an item. The @c
- * event_info parameter is the item that was double-clicked.
- * - @c "selected" - This is called when a user has made an item selected.
- * The event_info parameter is the genlist item that was selected.
- * - @c "unselected" - This is called when a user has made an item
- * unselected. The event_info parameter is the genlist item that was
- * unselected.
- * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
- * called and the item is now meant to be expanded. The event_info
- * parameter is the genlist item that was indicated to expand. It is the
- * job of this callback to then fill in the child items.
- * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
- * called and the item is now meant to be contracted. The event_info
- * parameter is the genlist item that was indicated to contract. It is the
- * job of this callback to then delete the child items.
- * - @c "expand,request" - This is called when a user has indicated they want
- * to expand a tree branch item. The callback should decide if the item can
- * expand (has any children) and then call elm_genlist_item_expanded_set()
- * appropriately to set the state. The event_info parameter is the genlist
- * item that was indicated to expand.
- * - @c "contract,request" - This is called when a user has indicated they
- * want to contract a tree branch item. The callback should decide if the
- * item can contract (has any children) and then call
- * elm_genlist_item_expanded_set() appropriately to set the state. The
- * event_info parameter is the genlist item that was indicated to contract.
- * - @c "realized" - This is called when the item in the list is created as a
- * real evas object. event_info parameter is the genlist item that was
- * created. The object may be deleted at any time, so it is up to the
- * caller to not use the object pointer from elm_genlist_item_object_get()
- * in a way where it may point to freed objects.
- * - @c "unrealized" - This is called just before an item is unrealized.
- * After this call icon objects provided will be deleted and the item
- * object itself delete or be put into a floating cache.
- * - @c "drag,start,up" - This is called when the item in the list has been
- * dragged (not scrolled) up.
- * - @c "drag,start,down" - This is called when the item in the list has been
- * dragged (not scrolled) down.
- * - @c "drag,start,left" - This is called when the item in the list has been
- * dragged (not scrolled) left.
- * - @c "drag,start,right" - This is called when the item in the list has
- * been dragged (not scrolled) right.
- * - @c "drag,stop" - This is called when the item in the list has stopped
- * being dragged.
- * - @c "drag" - This is called when the item in the list is being dragged.
- * - @c "longpressed" - This is called when the item is pressed for a certain
- * amount of time. By default it's 1 second.
- * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
- * the top edge.
- * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
- * until the bottom edge.
- * - @c "scroll,edge,left" - This is called when the genlist is scrolled
- * until the left edge.
- * - @c "scroll,edge,right" - This is called when the genlist is scrolled
- * until the right edge.
- * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
- * swiped left.
- * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
- * swiped right.
- * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
- * swiped up.
- * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
- * swiped down.
- * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
- * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
- * multi-touch pinched in.
- * - @c "swipe" - This is called when the genlist is swiped.
+ * @see elm_genlist_item_tooltip_style_set() for more details
*
- * @section Genlist_Examples Examples
+ * @ingroup Genlist
+ */
+ EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Disable size restrictions on an object's tooltip
+ * @param item The tooltip's anchor object
+ * @param disable If EINA_TRUE, size restrictions are disabled
+ * @return EINA_FALSE on failure, EINA_TRUE on success
*
- * Here is a list of examples that use the genlist, trying to show some of
- * its capabilities:
- * - @ref genlist_example_01
- * - @ref genlist_example_02
- * - @ref genlist_example_03
- * - @ref genlist_example_04
- * - @ref genlist_example_05
+ * This function allows a tooltip to expand beyond its parant window's canvas.
+ * It will instead be limited only by the size of the display.
*/
-
+ EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
/**
- * @addtogroup Genlist
- * @{
+ * @brief Retrieve size restriction state of an object's tooltip
+ * @param item The tooltip's anchor object
+ * @return If EINA_TRUE, size restrictions are disabled
+ *
+ * This function returns whether a tooltip is allowed to expand beyond
+ * its parant window's canvas.
+ * It will instead be limited only by the size of the display.
*/
-
+ EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
/**
- * @enum _Elm_Genlist_Item_Flags
- * @typedef Elm_Genlist_Item_Flags
+ * Set the type of mouse pointer/cursor decoration to be shown,
+ * when the mouse pointer is over the given genlist widget item
*
- * Defines if the item is of any special type (has subitems or it's the
- * index of a group), or is just a simple item.
+ * @param item genlist item to customize cursor on
+ * @param cursor the cursor type's name
+ *
+ * This function works analogously as elm_object_cursor_set(), but
+ * here the cursor's changing area is restricted to the item's
+ * area, and not the whole widget's. Note that that item cursors
+ * have precedence over widget cursors, so that a mouse over @p
+ * item will always show cursor @p type.
+ *
+ * If this function is called twice for an object, a previously set
+ * cursor will be unset on the second call.
+ *
+ * @see elm_object_cursor_set()
+ * @see elm_genlist_item_cursor_get()
+ * @see elm_genlist_item_cursor_unset()
*
* @ingroup Genlist
*/
- typedef enum _Elm_Genlist_Item_Flags
- {
- ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
- ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
- ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
- } Elm_Genlist_Item_Flags;
- typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
- typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
- typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
- typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
- typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
- typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
- typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
- typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
-
+ EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
/**
- * @struct _Elm_Genlist_Item_Class
+ * Get the type of mouse pointer/cursor decoration set to be shown,
+ * when the mouse pointer is over the given genlist widget item
*
- * Genlist item class definition structs.
+ * @param item genlist item with custom cursor set
+ * @return the cursor type's name or @c NULL, if no custom cursors
+ * were set to @p item (and on errors)
*
- * This struct contains the style and fetching functions that will define the
- * contents of each item.
+ * @see elm_object_cursor_get()
+ * @see elm_genlist_item_cursor_set() for more details
+ * @see elm_genlist_item_cursor_unset()
*
- * @see @ref Genlist_Item_Class
+ * @ingroup Genlist
*/
- struct _Elm_Genlist_Item_Class
- {
- const char *item_style; /**< style of this class. */
- struct
- {
- GenlistItemLabelGetFunc label_get; /**< Label fetching class function for genlist item classes.*/
- GenlistItemIconGetFunc icon_get; /**< Icon fetching class function for genlist item classes. */
- GenlistItemStateGetFunc state_get; /**< State fetching class function for genlist item classes. */
- GenlistItemDelFunc del; /**< Deletion class function for genlist item classes. */
- GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
- } func;
- const char *mode_item_style;
- };
-
+ EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * Add a new genlist widget to the given parent Elementary
- * (container) object
+ * Unset any custom mouse pointer/cursor decoration set to be
+ * shown, when the mouse pointer is over the given genlist widget
+ * item, thus making it show the @b default cursor again.
*
- * @param parent The parent object
- * @return a new genlist widget handle or @c NULL, on errors
+ * @param item a genlist item
*
- * This function inserts a new genlist widget on the canvas.
+ * Use this call to undo any custom settings on this item's cursor
+ * decoration, bringing it back to defaults (no custom style set).
*
- * @see elm_genlist_item_append()
- * @see elm_genlist_item_del()
- * @see elm_genlist_clear()
+ * @see elm_object_cursor_unset()
+ * @see elm_genlist_item_cursor_set() for more details
*
* @ingroup Genlist
*/
- EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * Remove all items from a given genlist widget.
+ * Set a different @b style for a given custom cursor set for a
+ * genlist item.
*
- * @param obj The genlist object
+ * @param item genlist item with custom cursor set
+ * @param style the <b>theme style</b> to use (e.g. @c "default",
+ * @c "transparent", etc)
*
- * This removes (and deletes) all items in @p obj, leaving it empty.
+ * This function only makes sense when one is using custom mouse
+ * cursor decorations <b>defined in a theme file</b> , which can
+ * have, given a cursor name/type, <b>alternate styles</b> on
+ * it. It works analogously as elm_object_cursor_style_set(), but
+ * here applied only to genlist item objects.
*
- * @see elm_genlist_item_del(), to remove just one item.
+ * @warning Before you set a cursor style you should have defined a
+ * custom cursor previously on the item, with
+ * elm_genlist_item_cursor_set()
+ *
+ * @see elm_genlist_item_cursor_engine_only_set()
+ * @see elm_genlist_item_cursor_style_get()
*
* @ingroup Genlist
*/
- EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
/**
- * Enable or disable multi-selection in the genlist
+ * Get the current @b style set for a given genlist item's custom
+ * cursor
*
- * @param obj The genlist object
- * @param multi Multi-select enable/disable. Default is disabled.
+ * @param item genlist item with custom cursor set.
+ * @return style the cursor style in use. If the object does not
+ * have a cursor set, then @c NULL is returned.
*
- * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
- * the list. This allows more than 1 item to be selected. To retrieve the list
- * of selected items, use elm_genlist_selected_items_get().
+ * @see elm_genlist_item_cursor_style_set() for more details
*
- * @see elm_genlist_selected_items_get()
- * @see elm_genlist_multi_select_get()
+ * @ingroup Genlist
+ */
+ EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ /**
+ * Set if the (custom) cursor for a given genlist item should be
+ * searched in its theme, also, or should only rely on the
+ * rendering engine.
+ *
+ * @param item item with custom (custom) cursor already set on
+ * @param engine_only Use @c EINA_TRUE to have cursors looked for
+ * only on those provided by the rendering engine, @c EINA_FALSE to
+ * have them searched on the widget's theme, as well.
+ *
+ * @note This call is of use only if you've set a custom cursor
+ * for genlist items, with elm_genlist_item_cursor_set().
+ *
+ * @note By default, cursors will only be looked for between those
+ * provided by the rendering engine.
*
* @ingroup Genlist
*/
- EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
+ EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
/**
- * Gets if multi-selection in genlist is enabled or disabled.
+ * Get if the (custom) cursor for a given genlist item is being
+ * searched in its theme, also, or is only relying on the rendering
+ * engine.
*
- * @param obj The genlist object
- * @return Multi-select enabled/disabled
- * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
+ * @param item a genlist item
+ * @return @c EINA_TRUE, if cursors are being looked for only on
+ * those provided by the rendering engine, @c EINA_FALSE if they
+ * are being searched on the widget's theme, as well.
*
- * @see elm_genlist_multi_select_set()
+ * @see elm_genlist_item_cursor_engine_only_set(), for more details
*
* @ingroup Genlist
*/
- EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
/**
- * This sets the horizontal stretching mode.
+ * Update the contents of all realized items.
+ *
+ * @param obj The genlist object.
+ *
+ * This updates all realized items by calling all the item class functions again
+ * to get the icons, labels and states. Use this when the original
+ * item data has changed and the changes are desired to be reflected.
+ *
+ * To update just one item, use elm_genlist_item_update().
+ *
+ * @see elm_genlist_realized_items_get()
+ * @see elm_genlist_item_update()
+ *
+ * @ingroup Genlist
+ */
+ EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Activate a genlist mode on an item
+ *
+ * @param item The genlist item
+ * @param mode Mode name
+ * @param mode_set Boolean to define set or unset mode.
+ *
+ * A genlist mode is a different way of selecting an item. Once a mode is
+ * activated on an item, any other selected item is immediately unselected.
+ * This feature provides an easy way of implementing a new kind of animation
+ * for selecting an item, without having to entirely rewrite the item style
+ * theme. However, the elm_genlist_selected_* API can't be used to get what
+ * item is activate for a mode.
+ *
+ * The current item style will still be used, but applying a genlist mode to
+ * an item will select it using a different kind of animation.
+ *
+ * The current active item for a mode can be found by
+ * elm_genlist_mode_item_get().
+ *
+ * The characteristics of genlist mode are:
+ * - Only one mode can be active at any time, and for only one item.
+ * - Genlist handles deactivating other items when one item is activated.
+ * - A mode is defined in the genlist theme (edc), and more modes can easily
+ * be added.
+ * - A mode style and the genlist item style are different things. They
+ * can be combined to provide a default style to the item, with some kind
+ * of animation for that item when the mode is activated.
+ *
+ * When a mode is activated on an item, a new view for that item is created.
+ * The theme of this mode defines the animation that will be used to transit
+ * the item from the old view to the new view. This second (new) view will be
+ * active for that item while the mode is active on the item, and will be
+ * destroyed after the mode is totally deactivated from that item.
+ *
+ * @see elm_genlist_mode_get()
+ * @see elm_genlist_mode_item_get()
+ *
+ * @ingroup Genlist
+ */
+ EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
+ /**
+ * Get the last (or current) genlist mode used.
*
* @param obj The genlist object
- * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
*
- * This sets the mode used for sizing items horizontally. Valid modes
- * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
- * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
- * the scroller will scroll horizontally. Otherwise items are expanded
- * to fill the width of the viewport of the scroller. If it is
- * ELM_LIST_LIMIT, items will be expanded to the viewport width and
- * limited to that size.
+ * This function just returns the name of the last used genlist mode. It will
+ * be the current mode if it's still active.
*
- * @see elm_genlist_horizontal_mode_get()
+ * @see elm_genlist_item_mode_set()
+ * @see elm_genlist_mode_item_get()
*
* @ingroup Genlist
*/
- EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Gets the horizontal stretching mode.
+ * Get active genlist mode item
*
* @param obj The genlist object
- * @return The mode to use
- * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
+ * @return The active item for that current mode. Or @c NULL if no item is
+ * activated with any mode.
*
- * @see elm_genlist_horizontal_mode_set()
+ * This function returns the item that was activated with a mode, by the
+ * function elm_genlist_item_mode_set().
+ *
+ * @see elm_genlist_item_mode_set()
+ * @see elm_genlist_mode_get()
*
* @ingroup Genlist
*/
- EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set the always select mode.
+ * Set reorder mode
*
* @param obj The genlist object
- * @param always_select The always select mode (@c EINA_TRUE = on, @c
- * EINA_FALSE = off). Default is @c EINA_FALSE.
+ * @param reorder_mode The reorder mode
+ * (EINA_TRUE = on, EINA_FALSE = off)
*
- * Items will only call their selection func and callback when first
- * becoming selected. Any further clicks will do nothing, unless you
- * enable always select with elm_genlist_always_select_mode_set().
- * This means that, even if selected, every click will make the selected
- * callbacks be called.
+ * @ingroup Genlist
+ */
+ EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the reorder mode
*
- * @see elm_genlist_always_select_mode_get()
+ * @param obj The genlist object
+ * @return The reorder mode
+ * (EINA_TRUE = on, EINA_FALSE = off)
*
* @ingroup Genlist
*/
- EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * @}
+ */
+
+ /**
+ * @defgroup Check Check
+ *
+ * @image html img/widget/check/preview-00.png
+ * @image latex img/widget/check/preview-00.eps
+ * @image html img/widget/check/preview-01.png
+ * @image latex img/widget/check/preview-01.eps
+ * @image html img/widget/check/preview-02.png
+ * @image latex img/widget/check/preview-02.eps
+ *
+ * @brief The check widget allows for toggling a value between true and
+ * false.
+ *
+ * Check objects are a lot like radio objects in layout and functionality
+ * except they do not work as a group, but independently and only toggle the
+ * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
+ * the boolean state (1 for true, 0 for false), and elm_check_state_get()
+ * returns the current state. For convenience, like the radio objects, you
+ * can set a pointer to a boolean directly with elm_check_state_pointer_set()
+ * for it to modify.
+ *
+ * Signals that you can add callbacks for are:
+ * "changed" - This is called whenever the user changes the state of one of
+ * the check object(event_info is NULL).
+ *
+ * @ref tutorial_check should give you a firm grasp of how to use this widget.
+ * @{
+ */
/**
- * Get the always select mode.
- *
- * @param obj The genlist object
- * @return The always select mode
- * (@c EINA_TRUE = on, @c EINA_FALSE = off)
- *
- * @see elm_genlist_always_select_mode_set()
+ * @brief Add a new Check object
*
- * @ingroup Genlist
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
*/
- EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Enable/disable the no select mode.
+ * @brief Set the text label of the check object
*
- * @param obj The genlist object
- * @param no_select The no select mode
- * (EINA_TRUE = on, EINA_FALSE = off)
+ * @param obj The check object
+ * @param label The text label string in UTF-8
*
- * This will turn off the ability to select items entirely and they
- * will neither appear selected nor call selected callback functions.
+ * @deprecated use elm_object_text_set() instead.
+ */
+ EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the text label of the check object
*
- * @see elm_genlist_no_select_mode_get()
+ * @param obj The check object
+ * @return The text label string in UTF-8
*
- * @ingroup Genlist
+ * @deprecated use elm_object_text_get() instead.
*/
- EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Gets whether the no select mode is enabled.
+ * @brief Set the icon object of the check object
*
- * @param obj The genlist object
- * @return The no select mode
- * (@c EINA_TRUE = on, @c EINA_FALSE = off)
+ * @param obj The check object
+ * @param icon The icon object
*
- * @see elm_genlist_no_select_mode_set()
+ * Once the icon object is set, a previously set one will be deleted.
+ * If you want to keep that old content object, use the
+ * elm_check_icon_unset() function.
+ */
+ EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the icon object of the check object
*
- * @ingroup Genlist
+ * @param obj The check object
+ * @return The icon object
*/
- EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Enable/disable compress mode.
+ * @brief Unset the icon used for the check object
*
- * @param obj The genlist object
- * @param compress The compress mode
- * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
+ * @param obj The check object
+ * @return The icon object that was being used
*
- * This will enable the compress mode where items are "compressed"
- * horizontally to fit the genlist scrollable viewport width. This is
- * special for genlist. Do not rely on
- * elm_genlist_horizontal_mode_set() being set to @c ELM_LIST_COMPRESS to
- * work as genlist needs to handle it specially.
+ * Unparent and return the icon object which was set for this widget.
+ */
+ EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the on/off state of the check object
*
- * @see elm_genlist_compress_mode_get()
+ * @param obj The check object
+ * @param state The state to use (1 == on, 0 == off)
*
- * @ingroup Genlist
+ * This sets the state of the check. If set
+ * with elm_check_state_pointer_set() the state of that variable is also
+ * changed. Calling this @b doesn't cause the "changed" signal to be emited.
*/
- EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
+ EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
/**
- * Get whether the compress mode is enabled.
+ * @brief Get the state of the check object
*
- * @param obj The genlist object
- * @return The compress mode
- * (@c EINA_TRUE = on, @c EINA_FALSE = off)
+ * @param obj The check object
+ * @return The boolean state
+ */
+ EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set a convenience pointer to a boolean to change
*
- * @see elm_genlist_compress_mode_set()
+ * @param obj The check object
+ * @param statep Pointer to the boolean to modify
*
- * @ingroup Genlist
+ * This sets a pointer to a boolean, that, in addition to the check objects
+ * state will also be modified directly. To stop setting the object pointed
+ * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
+ * then when this is called, the check objects state will also be modified to
+ * reflect the value of the boolean @p statep points to, just like calling
+ * elm_check_state_set().
*/
- EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
/**
- * Enable/disable height-for-width mode.
+ * @}
+ */
+
+ /**
+ * @defgroup Radio Radio
*
- * @param obj The genlist object
- * @param setting The height-for-width mode (@c EINA_TRUE = on,
- * @c EINA_FALSE = off). Default is @c EINA_FALSE.
+ * @image html img/widget/radio/preview-00.png
+ * @image latex img/widget/radio/preview-00.eps
*
- * With height-for-width mode the item width will be fixed (restricted
- * to a minimum of) to the list width when calculating its size in
- * order to allow the height to be calculated based on it. This allows,
- * for instance, text block to wrap lines if the Edje part is
- * configured with "text.min: 0 1".
+ * @brief Radio is a widget that allows for 1 or more options to be displayed
+ * and have the user choose only 1 of them.
*
- * @note This mode will make list resize slower as it will have to
- * recalculate every item height again whenever the list width
- * changes!
+ * A radio object contains an indicator, an optional Label and an optional
+ * icon object. While it's possible to have a group of only one radio they,
+ * are normally used in groups of 2 or more. To add a radio to a group use
+ * elm_radio_group_add(). The radio object(s) will select from one of a set
+ * of integer values, so any value they are configuring needs to be mapped to
+ * a set of integers. To configure what value that radio object represents,
+ * use elm_radio_state_value_set() to set the integer it represents. To set
+ * the value the whole group(which one is currently selected) is to indicate
+ * use elm_radio_value_set() on any group member, and to get the groups value
+ * use elm_radio_value_get(). For convenience the radio objects are also able
+ * to directly set an integer(int) to the value that is selected. To specify
+ * the pointer to this integer to modify, use elm_radio_value_pointer_set().
+ * The radio objects will modify this directly. That implies the pointer must
+ * point to valid memory for as long as the radio objects exist.
*
- * @note When height-for-width mode is enabled, it also enables
- * compress mode (see elm_genlist_compress_mode_set()) and
- * disables homogeneous (see elm_genlist_homogeneous_set()).
+ * Signals that you can add callbacks for are:
+ * @li changed - This is called whenever the user changes the state of one of
+ * the radio objects within the group of radio objects that work together.
*
- * @ingroup Genlist
+ * @ref tutorial_radio show most of this API in action.
+ * @{
*/
- EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
/**
- * Get whether the height-for-width mode is enabled.
- *
- * @param obj The genlist object
- * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
- * off)
+ * @brief Add a new radio to the parent
*
- * @ingroup Genlist
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
*/
- EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Enable/disable horizontal and vertical bouncing effect.
- *
- * @param obj The genlist object
- * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
- * EINA_FALSE = off). Default is @c EINA_FALSE.
- * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
- * EINA_FALSE = off). Default is @c EINA_TRUE.
- *
- * This will enable or disable the scroller bouncing effect for the
- * genlist. See elm_scroller_bounce_set() for details.
+ * @brief Set the text label of the radio object
*
- * @see elm_scroller_bounce_set()
- * @see elm_genlist_bounce_get()
+ * @param obj The radio object
+ * @param label The text label string in UTF-8
*
- * @ingroup Genlist
+ * @deprecated use elm_object_text_set() instead.
*/
- EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
/**
- * Get whether the horizontal and vertical bouncing effect is enabled.
- *
- * @param obj The genlist object
- * @param h_bounce Pointer to a bool to receive if the bounce horizontally
- * option is set.
- * @param v_bounce Pointer to a bool to receive if the bounce vertically
- * option is set.
+ * @brief Get the text label of the radio object
*
- * @see elm_genlist_bounce_set()
+ * @param obj The radio object
+ * @return The text label string in UTF-8
*
- * @ingroup Genlist
+ * @deprecated use elm_object_text_set() instead.
*/
- EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Enable/disable homogenous mode.
+ * @brief Set the icon object of the radio object
*
- * @param obj The genlist object
- * @param homogeneous Assume the items within the genlist are of the
- * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
- * EINA_FALSE.
+ * @param obj The radio object
+ * @param icon The icon object
*
- * This will enable the homogeneous mode where items are of the same
- * height and width so that genlist may do the lazy-loading at its
- * maximum (which increases the performance for scrolling the list). This
- * implies 'compressed' mode.
+ * Once the icon object is set, a previously set one will be deleted. If you
+ * want to keep that old content object, use the elm_radio_icon_unset()
+ * function.
+ */
+ EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the icon object of the radio object
*
- * @see elm_genlist_compress_mode_set()
- * @see elm_genlist_homogeneous_get()
+ * @param obj The radio object
+ * @return The icon object
*
- * @ingroup Genlist
+ * @see elm_radio_icon_set()
*/
- EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get whether the homogenous mode is enabled.
+ * @brief Unset the icon used for the radio object
*
- * @param obj The genlist object
- * @return Assume the items within the genlist are of the same height
- * and width (EINA_TRUE = on, EINA_FALSE = off)
+ * @param obj The radio object
+ * @return The icon object that was being used
*
- * @see elm_genlist_homogeneous_set()
+ * Unparent and return the icon object which was set for this widget.
*
- * @ingroup Genlist
+ * @see elm_radio_icon_set()
*/
- EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the maximum number of items within an item block
- *
- * @param obj The genlist object
- * @param n Maximum number of items within an item block. Default is 32.
- *
- * This will configure the block count to tune to the target with
- * particular performance matrix.
+ * @brief Add this radio to a group of other radio objects
*
- * A block of objects will be used to reduce the number of operations due to
- * many objects in the screen. It can determine the visibility, or if the
- * object has changed, it theme needs to be updated, etc. doing this kind of
- * calculation to the entire block, instead of per object.
+ * @param obj The radio object
+ * @param group Any object whose group the @p obj is to join.
*
- * The default value for the block count is enough for most lists, so unless
- * you know you will have a lot of objects visible in the screen at the same
- * time, don't try to change this.
+ * Radio objects work in groups. Each member should have a different integer
+ * value assigned. In order to have them work as a group, they need to know
+ * about each other. This adds the given radio object to the group of which
+ * the group object indicated is a member.
+ */
+ EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the integer value that this radio object represents
*
- * @see elm_genlist_block_count_get()
- * @see @ref Genlist_Implementation
+ * @param obj The radio object
+ * @param value The value to use if this radio object is selected
*
- * @ingroup Genlist
+ * This sets the value of the radio.
*/
- EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
+ EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
/**
- * Get the maximum number of items within an item block
+ * @brief Get the integer value that this radio object represents
*
- * @param obj The genlist object
- * @return Maximum number of items within an item block
+ * @param obj The radio object
+ * @return The value used if this radio object is selected
*
- * @see elm_genlist_block_count_set()
+ * This gets the value of the radio.
*
- * @ingroup Genlist
+ * @see elm_radio_value_set()
*/
- EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the timeout in seconds for the longpress event.
- *
- * @param obj The genlist object
- * @param timeout timeout in seconds. Default is 1.
- *
- * This option will change how long it takes to send an event "longpressed"
- * after the mouse down signal is sent to the list. If this event occurs, no
- * "clicked" event will be sent.
+ * @brief Set the value of the radio.
*
- * @see elm_genlist_longpress_timeout_set()
+ * @param obj The radio object
+ * @param value The value to use for the group
*
- * @ingroup Genlist
+ * This sets the value of the radio group and will also set the value if
+ * pointed to, to the value supplied, but will not call any callbacks.
*/
- EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
+ EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
/**
- * Get the timeout in seconds for the longpress event.
+ * @brief Get the state of the radio object
*
- * @param obj The genlist object
- * @return timeout in seconds
+ * @param obj The radio object
+ * @return The integer state
+ */
+ EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set a convenience pointer to a integer to change
*
- * @see elm_genlist_longpress_timeout_get()
+ * @param obj The radio object
+ * @param valuep Pointer to the integer to modify
*
- * @ingroup Genlist
+ * This sets a pointer to a integer, that, in addition to the radio objects
+ * state will also be modified directly. To stop setting the object pointed
+ * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
+ * when this is called, the radio objects state will also be modified to
+ * reflect the value of the integer valuep points to, just like calling
+ * elm_radio_value_set().
*/
- EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
/**
- * Append a new item in a given genlist widget.
- *
- * @param obj The genlist object
- * @param itc The item class for the item
- * @param data The item data
- * @param parent The parent item, or NULL if none
- * @param flags Item flags
- * @param func Convenience function called when the item is selected
- * @param func_data Data passed to @p func above.
- * @return A handle to the item added or @c NULL if not possible
+ * @}
+ */
+
+ /**
+ * @defgroup Pager Pager
*
- * This adds the given item to the end of the list or the end of
- * the children list if the @p parent is given.
+ * @image html img/widget/pager/preview-00.png
+ * @image latex img/widget/pager/preview-00.eps
*
- * @see elm_genlist_item_prepend()
- * @see elm_genlist_item_insert_before()
- * @see elm_genlist_item_insert_after()
- * @see elm_genlist_item_del()
+ * @brief Widget that allows flipping between 1 or more “pages” of objects.
*
- * @ingroup Genlist
- */
- 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);
- /**
- * Prepend a new item in a given genlist widget.
+ * The flipping between “pages” of objects is animated. All content in pager
+ * is kept in a stack, the last content to be added will be on the top of the
+ * stack(be visible).
*
- * @param obj The genlist object
- * @param itc The item class for the item
- * @param data The item data
- * @param parent The parent item, or NULL if none
- * @param flags Item flags
- * @param func Convenience function called when the item is selected
- * @param func_data Data passed to @p func above.
- * @return A handle to the item added or NULL if not possible
+ * Objects can be pushed or popped from the stack or deleted as normal.
+ * Pushes and pops will animate (and a pop will delete the object once the
+ * animation is finished). Any object already in the pager can be promoted to
+ * the top(from its current stacking position) through the use of
+ * elm_pager_content_promote(). Objects are pushed to the top with
+ * elm_pager_content_push() and when the top item is no longer wanted, simply
+ * pop it with elm_pager_content_pop() and it will also be deleted. If an
+ * object is no longer needed and is not the top item, just delete it as
+ * normal. You can query which objects are the top and bottom with
+ * elm_pager_content_bottom_get() and elm_pager_content_top_get().
*
- * This adds an item to the beginning of the list or beginning of the
- * children of the parent if given.
+ * Signals that you can add callbacks for are:
+ * "hide,finished" - when the previous page is hided
*
- * @see elm_genlist_item_append()
- * @see elm_genlist_item_insert_before()
- * @see elm_genlist_item_insert_after()
- * @see elm_genlist_item_del()
+ * This widget has the following styles available:
+ * @li default
+ * @li fade
+ * @li fade_translucide
+ * @li fade_invisible
+ * @note This styles affect only the flipping animations, the appearance when
+ * not animating is unaffected by styles.
*
- * @ingroup Genlist
+ * @ref tutorial_pager gives a good overview of the usage of the API.
+ * @{
*/
- 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);
/**
- * Insert an item before another in a genlist widget
- *
- * @param obj The genlist object
- * @param itc The item class for the item
- * @param data The item data
- * @param before The item to place this new one before.
- * @param flags Item flags
- * @param func Convenience function called when the item is selected
- * @param func_data Data passed to @p func above.
- * @return A handle to the item added or @c NULL if not possible
- *
- * This inserts an item before another in the list. It will be in the
- * same tree level or group as the item it is inserted before.
+ * Add a new pager to the parent
*
- * @see elm_genlist_item_append()
- * @see elm_genlist_item_prepend()
- * @see elm_genlist_item_insert_after()
- * @see elm_genlist_item_del()
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
*
- * @ingroup Genlist
+ * @ingroup Pager
*/
- 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);
+ EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Insert an item after another in a genlist widget
- *
- * @param obj The genlist object
- * @param itc The item class for the item
- * @param data The item data
- * @param after The item to place this new one after.
- * @param flags Item flags
- * @param func Convenience function called when the item is selected
- * @param func_data Data passed to @p func above.
- * @return A handle to the item added or @c NULL if not possible
+ * @brief Push an object to the top of the pager stack (and show it).
*
- * This inserts an item after another in the list. It will be in the
- * same tree level or group as the item it is inserted after.
+ * @param obj The pager object
+ * @param content The object to push
*
- * @see elm_genlist_item_append()
- * @see elm_genlist_item_prepend()
- * @see elm_genlist_item_insert_before()
- * @see elm_genlist_item_del()
+ * The object pushed becomes a child of the pager, it will be controlled and
+ * deleted when the pager is deleted.
*
- * @ingroup Genlist
+ * @note If the content is already in the stack use
+ * elm_pager_content_promote().
+ * @warning Using this function on @p content already in the stack results in
+ * undefined behavior.
*/
- 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);
+ EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
/**
- * Insert a new item into the sorted genlist object
+ * @brief Pop the object that is on top of the stack
*
- * @param obj The genlist object
- * @param itc The item class for the item
- * @param data The item data
- * @param parent The parent item, or NULL if none
- * @param flags Item flags
- * @param comp The function called for the sort
- * @param func Convenience function called when item selected
- * @param func_data Data passed to @p func above.
- * @return A handle to the item added or NULL if not possible
+ * @param obj The pager object
*
- * @ingroup Genlist
+ * This pops the object that is on the top(visible) of the pager, makes it
+ * disappear, then deletes the object. The object that was underneath it on
+ * the stack will become visible.
*/
- 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);
- EAPI Elm_Genlist_Item *elm_genlist_item_direct_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);
- /* operations to retrieve existing items */
+ EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the selectd item in the genlist.
+ * @brief Moves an object already in the pager stack to the top of the stack.
*
- * @param obj The genlist object
- * @return The selected item, or NULL if none is selected.
+ * @param obj The pager object
+ * @param content The object to promote
*
- * This gets the selected item in the list (if multi-selection is enabled, only
- * the item that was first selected in the list is returned - which is not very
- * useful, so see elm_genlist_selected_items_get() for when multi-selection is
- * used).
+ * This will take the @p content and move it to the top of the stack as
+ * if it had been pushed there.
*
- * If no item is selected, NULL is returned.
+ * @note If the content isn't already in the stack use
+ * elm_pager_content_push().
+ * @warning Using this function on @p content not already in the stack
+ * results in undefined behavior.
+ */
+ EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Return the object at the bottom of the pager stack
*
- * @see elm_genlist_selected_items_get()
+ * @param obj The pager object
+ * @return The bottom object or NULL if none
+ */
+ EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Return the object at the top of the pager stack
*
- * @ingroup Genlist
+ * @param obj The pager object
+ * @return The top object or NULL if none
*/
- EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get a list of selected items in the genlist.
+ * @}
+ */
+
+ /**
+ * @defgroup Slideshow Slideshow
+ *
+ * @image html img/widget/slideshow/preview-00.png
+ * @image latex img/widget/slideshow/preview-00.eps
+ *
+ * This widget, as the name indicates, is a pre-made image
+ * slideshow panel, with API functions acting on (child) image
+ * items presentation. Between those actions, are:
+ * - advance to next/previous image
+ * - select the style of image transition animation
+ * - set the exhibition time for each image
+ * - start/stop the slideshow
+ *
+ * The transition animations are defined in the widget's theme,
+ * consequently new animations can be added without having to
+ * update the widget's code.
*
- * @param obj The genlist object
- * @return The list of selected items, or NULL if none are selected.
+ * @section Slideshow_Items Slideshow items
*
- * It returns a list of the selected items. This list pointer is only valid so
- * long as the selection doesn't change (no items are selected or unselected, or
- * unselected implicitly by deletion). The list contains Elm_Genlist_Item
- * pointers. The order of the items in this list is the order which they were
- * selected, i.e. the first item in this list is the first item that was
- * selected, and so on.
+ * For slideshow items, just like for @ref Genlist "genlist" ones,
+ * the user defines a @b classes, specifying functions that will be
+ * called on the item's creation and deletion times.
*
- * @note If not in multi-select mode, consider using function
- * elm_genlist_selected_item_get() instead.
+ * The #Elm_Slideshow_Item_Class structure contains the following
+ * members:
*
- * @see elm_genlist_multi_select_set()
- * @see elm_genlist_selected_item_get()
+ * - @c func.get - When an item is displayed, this function is
+ * called, and it's where one should create the item object, de
+ * facto. For example, the object can be a pure Evas image object
+ * or an Elementary @ref Photocam "photocam" widget. See
+ * #SlideshowItemGetFunc.
+ * - @c func.del - When an item is no more displayed, this function
+ * is called, where the user must delete any data associated to
+ * the item. See #SlideshowItemDelFunc.
*
- * @ingroup Genlist
- */
- EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Get a list of realized items in genlist
+ * @section Slideshow_Caching Slideshow caching
*
- * @param obj The genlist object
- * @return The list of realized items, nor NULL if none are realized.
+ * The slideshow provides facilities to have items adjacent to the
+ * one being displayed <b>already "realized"</b> (i.e. loaded) for
+ * you, so that the system does not have to decode image data
+ * anymore at the time it has to actually switch images on its
+ * viewport. The user is able to set the numbers of items to be
+ * cached @b before and @b after the current item, in the widget's
+ * item list.
*
- * This returns a list of the realized items in the genlist. The list
- * contains Elm_Genlist_Item pointers. The list must be freed by the
- * caller when done with eina_list_free(). The item pointers in the
- * list are only valid so long as those items are not deleted or the
- * genlist is not deleted.
+ * Smart events one can add callbacks for are:
*
- * @see elm_genlist_realized_items_update()
+ * - @c "changed" - when the slideshow switches its view to a new
+ * item
*
- * @ingroup Genlist
+ * List of examples for the slideshow widget:
+ * @li @ref slideshow_example
*/
- EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the item that is at the x, y canvas coords.
- *
- * @param obj The gelinst object.
- * @param x The input x coordinate
- * @param y The input y coordinate
- * @param posret The position relative to the item returned here
- * @return The item at the coordinates or NULL if none
- *
- * This returns the item at the given coordinates (which are canvas
- * relative, not object-relative). If an item is at that coordinate,
- * that item handle is returned, and if @p posret is not NULL, the
- * integer pointed to is set to a value of -1, 0 or 1, depending if
- * the coordinate is on the upper portion of that item (-1), on the
- * middle section (0) or on the lower part (1). If NULL is returned as
- * an item (no item found there), then posret may indicate -1 or 1
- * based if the coordinate is above or below all items respectively in
- * the genlist.
+ * @addtogroup Slideshow
+ * @{
+ */
+
+ typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
+ typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
+ typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
+ typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
+ typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
+
+ /**
+ * @struct _Elm_Slideshow_Item_Class
*
- * @ingroup Genlist
+ * Slideshow item class definition. See @ref Slideshow_Items for
+ * field details.
*/
- 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);
+ struct _Elm_Slideshow_Item_Class
+ {
+ struct _Elm_Slideshow_Item_Class_Func
+ {
+ SlideshowItemGetFunc get;
+ SlideshowItemDelFunc del;
+ } func;
+ }; /**< #Elm_Slideshow_Item_Class member definitions */
+
/**
- * Get the first item in the genlist
+ * Add a new slideshow widget to the given parent Elementary
+ * (container) object
*
- * This returns the first item in the list.
+ * @param parent The parent object
+ * @return A new slideshow widget handle or @c NULL, on errors
*
- * @param obj The genlist object
- * @return The first item, or NULL if none
+ * This function inserts a new slideshow widget on the canvas.
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
- * Get the last item in the genlist
+ * Add (append) a new item in a given slideshow widget.
*
- * This returns the last item in the list.
+ * @param obj The slideshow object
+ * @param itc The item class for the item
+ * @param data The item's data
+ * @return A handle to the item added or @c NULL, on errors
*
- * @return The last item, or NULL if none
+ * Add a new item to @p obj's internal list of items, appending it.
+ * The item's class must contain the function really fetching the
+ * image object to show for this item, which could be an Evas image
+ * object or an Elementary photo, for example. The @p data
+ * parameter is going to be passed to both class functions of the
+ * item.
*
- * @ingroup Genlist
+ * @see #Elm_Slideshow_Item_Class
+ * @see elm_slideshow_item_sorted_insert()
+ *
+ * @ingroup Slideshow
*/
- EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
+
/**
- * Set the scrollbar policy
+ * Insert a new item into the given slideshow widget, using the @p func
+ * function to sort items (by item handles).
*
- * @param obj The genlist object
- * @param policy_h Horizontal scrollbar policy.
- * @param policy_v Vertical scrollbar policy.
+ * @param obj The slideshow object
+ * @param itc The item class for the item
+ * @param data The item's data
+ * @param func The comparing function to be used to sort slideshow
+ * items <b>by #Elm_Slideshow_Item item handles</b>
+ * @return Returns The slideshow item handle, on success, or
+ * @c NULL, on errors
*
- * This sets the scrollbar visibility policy for the given genlist
- * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
- * made visible if it is needed, and otherwise kept hidden.
- * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
- * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
- * respectively for the horizontal and vertical scrollbars. Default is
- * #ELM_SMART_SCROLLER_POLICY_AUTO
+ * Add a new item to @p obj's internal list of items, in a position
+ * determined by the @p func comparing function. The item's class
+ * must contain the function really fetching the image object to
+ * show for this item, which could be an Evas image object or an
+ * Elementary photo, for example. The @p data parameter is going to
+ * be passed to both class functions of the item.
*
- * @see elm_genlist_scroller_policy_get()
+ * @see #Elm_Slideshow_Item_Class
+ * @see elm_slideshow_item_add()
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
+ 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);
+
/**
- * Get the scrollbar policy
+ * Display a given slideshow widget's item, programmatically.
*
- * @param obj The genlist object
- * @param policy_h Pointer to store the horizontal scrollbar policy.
- * @param policy_v Pointer to store the vertical scrollbar policy.
+ * @param obj The slideshow object
+ * @param item The item to display on @p obj's viewport
*
- * @see elm_genlist_scroller_policy_set()
+ * The change between the current item and @p item will use the
+ * transition @p obj is set to use (@see
+ * elm_slideshow_transition_set()).
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- 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);
+ EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * Get the @b next item in a genlist widget's internal list of items,
- * given a handle to one of those items.
+ * Slide to the @b next item, in a given slideshow widget
*
- * @param item The genlist item to fetch next from
- * @return The item after @p item, or @c NULL if there's none (and
- * on errors)
+ * @param obj The slideshow object
*
- * This returns the item placed after the @p item, on the container
- * genlist.
+ * The sliding animation @p obj is set to use will be the
+ * transition effect used, after this call is issued.
*
- * @see elm_genlist_item_prev_get()
+ * @note If the end of the slideshow's internal list of items is
+ * reached, it'll wrap around to the list's beginning, again.
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the @b previous item in a genlist widget's internal list of items,
- * given a handle to one of those items.
+ * Slide to the @b previous item, in a given slideshow widget
*
- * @param item The genlist item to fetch previous from
- * @return The item before @p item, or @c NULL if there's none (and
- * on errors)
+ * @param obj The slideshow object
*
- * This returns the item placed before the @p item, on the container
- * genlist.
+ * The sliding animation @p obj is set to use will be the
+ * transition effect used, after this call is issued.
*
- * @see elm_genlist_item_next_get()
+ * @note If the beginning of the slideshow's internal list of items
+ * is reached, it'll wrap around to the list's end, again.
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the genlist object's handle which contains a given genlist
- * item
+ * Returns the list of sliding transition/effect names available, for a
+ * given slideshow widget.
*
- * @param item The item to fetch the container from
- * @return The genlist (parent) object
+ * @param obj The slideshow object
+ * @return The list of transitions (list of @b stringshared strings
+ * as data)
+ *
+ * The transitions, which come from @p obj's theme, must be an EDC
+ * data item named @c "transitions" on the theme file, with (prefix)
+ * names of EDC programs actually implementing them.
+ *
+ * The available transitions for slideshows on the default theme are:
+ * - @c "fade" - the current item fades out, while the new one
+ * fades in to the slideshow's viewport.
+ * - @c "black_fade" - the current item fades to black, and just
+ * then, the new item will fade in.
+ * - @c "horizontal" - the current item slides horizontally, until
+ * it gets out of the slideshow's viewport, while the new item
+ * comes from the left to take its place.
+ * - @c "vertical" - the current item slides vertically, until it
+ * gets out of the slideshow's viewport, while the new item comes
+ * from the bottom to take its place.
+ * - @c "square" - the new item starts to appear from the middle of
+ * the current one, but with a tiny size, growing until its
+ * target (full) size and covering the old one.
+ *
+ * @warning The stringshared strings get no new references
+ * exclusive to the user grabbing the list, here, so if you'd like
+ * to use them out of this call's context, you'd better @c
+ * eina_stringshare_ref() them.
*
- * This returns the genlist object itself that an item belongs to.
+ * @see elm_slideshow_transition_set()
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the parent item of the given item
+ * Set the current slide transition/effect in use for a given
+ * slideshow widget
*
- * @param it The item
- * @return The parent of the item or @c NULL if it has no parent.
+ * @param obj The slideshow object
+ * @param transition The new transition's name string
*
- * This returns the item that was specified as parent of the item @p it on
- * elm_genlist_item_append() and insertion related functions.
+ * If @p transition is implemented in @p obj's theme (i.e., is
+ * contained in the list returned by
+ * elm_slideshow_transitions_get()), this new sliding effect will
+ * be used on the widget.
*
- * @ingroup Genlist
+ * @see elm_slideshow_transitions_get() for more details
+ *
+ * @ingroup Slideshow
*/
- EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+ EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
+
/**
- * Remove all sub-items (children) of the given item
- *
- * @param it The item
+ * Get the current slide transition/effect in use for a given
+ * slideshow widget
*
- * This removes all items that are children (and their descendants) of the
- * given item @p it.
+ * @param obj The slideshow object
+ * @return The current transition's name
*
- * @see elm_genlist_clear()
- * @see elm_genlist_item_del()
+ * @see elm_slideshow_transition_set() for more details
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set whether a given genlist item is selected or not
+ * Set the interval between each image transition on a given
+ * slideshow widget, <b>and start the slideshow, itself</b>
*
- * @param it The item
- * @param selected Use @c EINA_TRUE, to make it selected, @c
- * EINA_FALSE to make it unselected
+ * @param obj The slideshow object
+ * @param timeout The new displaying timeout for images
*
- * This sets the selected state of an item. If multi selection is
- * not enabled on the containing genlist and @p selected is @c
- * EINA_TRUE, any other previously selected items will get
- * unselected in favor of this new one.
+ * After this call, the slideshow widget will start cycling its
+ * view, sequentially and automatically, with the images of the
+ * items it has. The time between each new image displayed is going
+ * to be @p timeout, in @b seconds. If a different timeout was set
+ * previously and an slideshow was in progress, it will continue
+ * with the new time between transitions, after this call.
*
- * @see elm_genlist_item_selected_get()
+ * @note A value less than or equal to 0 on @p timeout will disable
+ * the widget's internal timer, thus halting any slideshow which
+ * could be happening on @p obj.
*
- * @ingroup Genlist
+ * @see elm_slideshow_timeout_get()
+ *
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
+ EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
+
/**
- * Get whether a given genlist item is selected or not
+ * Get the interval set for image transitions on a given slideshow
+ * widget.
*
- * @param it The item
- * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
+ * @param obj The slideshow object
+ * @return Returns the timeout set on it
*
- * @see elm_genlist_item_selected_set() for more details
+ * @see elm_slideshow_timeout_set() for more details
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Sets the expanded state of an item.
- *
- * @param it The item
- * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
- *
- * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
- * expanded or not.
+ * Set if, after a slideshow is started, for a given slideshow
+ * widget, its items should be displayed cyclically or not.
*
- * The theme will respond to this change visually, and a signal "expanded" or
- * "contracted" will be sent from the genlist with a pointer to the item that
- * has been expanded/contracted.
+ * @param obj The slideshow object
+ * @param loop Use @c EINA_TRUE to make it cycle through items or
+ * @c EINA_FALSE for it to stop at the end of @p obj's internal
+ * list of items
*
- * Calling this function won't show or hide any child of this item (if it is
- * a parent). You must manually delete and create them on the callbacks fo
- * the "expanded" or "contracted" signals.
+ * @note elm_slideshow_next() and elm_slideshow_previous() will @b
+ * ignore what is set by this functions, i.e., they'll @b always
+ * cycle through items. This affects only the "automatic"
+ * slideshow, as set by elm_slideshow_timeout_set().
*
- * @see elm_genlist_item_expanded_get()
+ * @see elm_slideshow_loop_get()
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
+ EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
+
/**
- * Get the expanded state of an item
- *
- * @param it The item
- * @return The expanded state
+ * Get if, after a slideshow is started, for a given slideshow
+ * widget, its items are to be displayed cyclically or not.
*
- * This gets the expanded state of an item.
+ * @param obj The slideshow object
+ * @return @c EINA_TRUE, if the items in @p obj will be cycled
+ * through or @c EINA_FALSE, otherwise
*
- * @see elm_genlist_item_expanded_set()
+ * @see elm_slideshow_loop_set() for more details
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the depth of expanded item
+ * Remove all items from a given slideshow widget
*
- * @param it The genlist item object
- * @return The depth of expanded item
+ * @param obj The slideshow object
*
- * @ingroup Genlist
+ * This removes (and deletes) all items in @p obj, leaving it
+ * empty.
+ *
+ * @see elm_slideshow_item_del(), to remove just one item.
+ *
+ * @ingroup Slideshow
*/
- EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+ EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set whether a given genlist item is disabled or not.
+ * Get the internal list of items in a given slideshow widget.
*
- * @param it The item
- * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
- * to enable it back.
+ * @param obj The slideshow object
+ * @return The list of items (#Elm_Slideshow_Item as data) or
+ * @c NULL on errors.
*
- * A disabled item cannot be selected or unselected. It will also
- * change its appearance, to signal the user it's disabled.
+ * This list is @b not to be modified in any way and must not be
+ * freed. Use the list members with functions like
+ * elm_slideshow_item_del(), elm_slideshow_item_data_get().
*
- * @see elm_genlist_item_disabled_get()
+ * @warning This list is only valid until @p obj object's internal
+ * items list is changed. It should be fetched again with another
+ * call to this function when changes happen.
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+ EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get whether a given genlist item is disabled or not.
- *
- * @param it The item
- * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
- * (and on errors).
+ * Delete a given item from a slideshow widget.
*
- * @see elm_genlist_item_disabled_set() for more details
+ * @param item The slideshow item
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * Sets the display only state of an item.
- *
- * @param it The item
- * @param display_only @c EINA_TRUE if the item is display only, @c
- * EINA_FALSE otherwise.
- *
- * A display only item cannot be selected or unselected. It is for
- * display only and not selecting or otherwise clicking, dragging
- * etc. by the user, thus finger size rules will not be applied to
- * this item.
- *
- * It's good to set group index items to display only state.
+ * Return the data associated with a given slideshow item
*
- * @see elm_genlist_item_display_only_get()
+ * @param item The slideshow item
+ * @return Returns the data associated to this item
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
+ EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
+
/**
- * Get the display only state of an item
- *
- * @param it The item
- * @return @c EINA_TRUE if the item is display only, @c
- * EINA_FALSE otherwise.
+ * Returns the currently displayed item, in a given slideshow widget
*
- * @see elm_genlist_item_display_only_set()
+ * @param obj The slideshow object
+ * @return A handle to the item being displayed in @p obj or
+ * @c NULL, if none is (and on errors)
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+ EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Show the portion of a genlist's internal list containing a given
- * item, immediately.
+ * Get the real Evas object created to implement the view of a
+ * given slideshow item
*
- * @param it The item to display
+ * @param item The slideshow item.
+ * @return the Evas object implementing this item's view.
*
- * This causes genlist to jump to the given item @p it and show it (by
- * immediately scrolling to that position), if it is not fully visible.
+ * This returns the actual Evas object used to implement the
+ * specified slideshow item's view. This may be @c NULL, as it may
+ * not have been created or may have been deleted, at any time, by
+ * the slideshow. <b>Do not modify this object</b> (move, resize,
+ * show, hide, etc.), as the slideshow is controlling it. This
+ * function is for querying, emitting custom signals or hooking
+ * lower level callbacks for events on that object. Do not delete
+ * this object under any circumstances.
*
- * @see elm_genlist_item_bring_in()
- * @see elm_genlist_item_top_show()
- * @see elm_genlist_item_middle_show()
+ * @see elm_slideshow_item_data_get()
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
+
/**
- * Animatedly bring in, to the visible are of a genlist, a given
- * item on it.
- *
- * @param it The item to display
- *
- * This causes genlist to jump to the given item @p it and show it (by
- * animatedly scrolling), if it is not fully visible. This may use animation
- * to do so and take a period of time
+ * Get the the item, in a given slideshow widget, placed at
+ * position @p nth, in its internal items list
*
- * @see elm_genlist_item_show()
- * @see elm_genlist_item_top_bring_in()
- * @see elm_genlist_item_middle_bring_in()
+ * @param obj The slideshow object
+ * @param nth The number of the item to grab a handle to (0 being
+ * the first)
+ * @return The item stored in @p obj at position @p nth or @c NULL,
+ * if there's no item with that index (and on errors)
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
+
/**
- * Show the portion of a genlist's internal list containing a given
- * item, immediately.
- *
- * @param it The item to display
+ * Set the current slide layout in use for a given slideshow widget
*
- * This causes genlist to jump to the given item @p it and show it (by
- * immediately scrolling to that position), if it is not fully visible.
+ * @param obj The slideshow object
+ * @param layout The new layout's name string
*
- * The item will be positioned at the top of the genlist viewport.
+ * If @p layout is implemented in @p obj's theme (i.e., is contained
+ * in the list returned by elm_slideshow_layouts_get()), this new
+ * images layout will be used on the widget.
*
- * @see elm_genlist_item_show()
- * @see elm_genlist_item_top_bring_in()
+ * @see elm_slideshow_layouts_get() for more details
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
+
/**
- * Animatedly bring in, to the visible are of a genlist, a given
- * item on it.
- *
- * @param it The item
- *
- * This causes genlist to jump to the given item @p it and show it (by
- * animatedly scrolling), if it is not fully visible. This may use animation
- * to do so and take a period of time
+ * Get the current slide layout in use for a given slideshow widget
*
- * The item will be positioned at the top of the genlist viewport.
+ * @param obj The slideshow object
+ * @return The current layout's name
*
- * @see elm_genlist_item_bring_in()
- * @see elm_genlist_item_top_show()
+ * @see elm_slideshow_layout_set() for more details
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Show the portion of a genlist's internal list containing a given
- * item, immediately.
+ * Returns the list of @b layout names available, for a given
+ * slideshow widget.
*
- * @param it The item to display
+ * @param obj The slideshow object
+ * @return The list of layouts (list of @b stringshared strings
+ * as data)
*
- * This causes genlist to jump to the given item @p it and show it (by
- * immediately scrolling to that position), if it is not fully visible.
+ * Slideshow layouts will change how the widget is to dispose each
+ * image item in its viewport, with regard to cropping, scaling,
+ * etc.
*
- * The item will be positioned at the middle of the genlist viewport.
+ * The layouts, which come from @p obj's theme, must be an EDC
+ * data item name @c "layouts" on the theme file, with (prefix)
+ * names of EDC programs actually implementing them.
*
- * @see elm_genlist_item_show()
- * @see elm_genlist_item_middle_bring_in()
+ * The available layouts for slideshows on the default theme are:
+ * - @c "fullscreen" - item images with original aspect, scaled to
+ * touch top and down slideshow borders or, if the image's heigh
+ * is not enough, left and right slideshow borders.
+ * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
+ * one, but always leaving 10% of the slideshow's dimensions of
+ * distance between the item image's borders and the slideshow
+ * borders, for each axis.
*
- * @ingroup Genlist
+ * @warning The stringshared strings get no new references
+ * exclusive to the user grabbing the list, here, so if you'd like
+ * to use them out of this call's context, you'd better @c
+ * eina_stringshare_ref() them.
+ *
+ * @see elm_slideshow_layout_set()
+ *
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+ EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Animatedly bring in, to the visible are of a genlist, a given
- * item on it.
- *
- * @param it The item
+ * Set the number of items to cache, on a given slideshow widget,
+ * <b>before the current item</b>
*
- * This causes genlist to jump to the given item @p it and show it (by
- * animatedly scrolling), if it is not fully visible. This may use animation
- * to do so and take a period of time
+ * @param obj The slideshow object
+ * @param count Number of items to cache before the current one
*
- * The item will be positioned at the middle of the genlist viewport.
+ * The default value for this property is @c 2. See
+ * @ref Slideshow_Caching "slideshow caching" for more details.
*
- * @see elm_genlist_item_bring_in()
- * @see elm_genlist_item_middle_show()
+ * @see elm_slideshow_cache_before_get()
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+ EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
+
/**
- * Remove a genlist item from the its parent, deleting it.
+ * Retrieve the number of items to cache, on a given slideshow widget,
+ * <b>before the current item</b>
*
- * @param item The item to be removed.
- * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
+ * @param obj The slideshow object
+ * @return The number of items set to be cached before the current one
*
- * @see elm_genlist_clear(), to remove all items in a genlist at
- * once.
+ * @see elm_slideshow_cache_before_set() for more details
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Return the data associated to a given genlist item
+ * Set the number of items to cache, on a given slideshow widget,
+ * <b>after the current item</b>
*
- * @param item The genlist item.
- * @return the data associated to this item.
+ * @param obj The slideshow object
+ * @param count Number of items to cache after the current one
*
- * This returns the @c data value passed on the
- * elm_genlist_item_append() and related item addition calls.
+ * The default value for this property is @c 2. See
+ * @ref Slideshow_Caching "slideshow caching" for more details.
*
- * @see elm_genlist_item_append()
- * @see elm_genlist_item_data_set()
+ * @see elm_slideshow_cache_after_get()
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
+
/**
- * Set the data associated to a given genlist item
- *
- * @param item The genlist item
- * @param data The new data pointer to set on it
+ * Retrieve the number of items to cache, on a given slideshow widget,
+ * <b>after the current item</b>
*
- * This @b overrides the @c data value passed on the
- * elm_genlist_item_append() and related item addition calls. This
- * function @b won't call elm_genlist_item_update() automatically,
- * so you'd issue it afterwards if you want to hove the item
- * updated to reflect the that new data.
+ * @param obj The slideshow object
+ * @return The number of items set to be cached after the current one
*
- * @see elm_genlist_item_data_get()
+ * @see elm_slideshow_cache_after_set() for more details
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
+ EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Tells genlist to "orphan" icons fetchs by the item class
- *
- * @param it The item
+ * Get the number of items stored in a given slideshow widget
*
- * This instructs genlist to release references to icons in the item,
- * meaning that they will no longer be managed by genlist and are
- * floating "orphans" that can be re-used elsewhere if the user wants
- * to.
+ * @param obj The slideshow object
+ * @return The number of items on @p obj, at the moment of this call
*
- * @ingroup Genlist
+ * @ingroup Slideshow
*/
- EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+ EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the real Evas object created to implement the view of a
- * given genlist item
+ * @}
+ */
+
+ /**
+ * @defgroup Fileselector File Selector
*
- * @param item The genlist item.
- * @return the Evas object implementing this item's view.
+ * @image html img/widget/fileselector/preview-00.png
+ * @image latex img/widget/fileselector/preview-00.eps
*
- * This returns the actual Evas object used to implement the
- * specified genlist item's view. This may be @c NULL, as it may
- * not have been created or may have been deleted, at any time, by
- * the genlist. <b>Do not modify this object</b> (move, resize,
- * show, hide, etc.), as the genlist is controlling it. This
- * function is for querying, emitting custom signals or hooking
- * lower level callbacks for events on that object. Do not delete
- * this object under any circumstances.
+ * A file selector is a widget that allows a user to navigate
+ * through a file system, reporting file selections back via its
+ * API.
*
- * @see elm_genlist_item_data_get()
+ * It contains shortcut buttons for home directory (@c ~) and to
+ * jump one directory upwards (..), as well as cancel/ok buttons to
+ * confirm/cancel a given selection. After either one of those two
+ * former actions, the file selector will issue its @c "done" smart
+ * callback.
*
- * @ingroup Genlist
- */
- EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
- /**
- * Update the contents of an item
+ * There's a text entry on it, too, showing the name of the current
+ * selection. There's the possibility of making it editable, so it
+ * is useful on file saving dialogs on applications, where one
+ * gives a file name to save contents to, in a given directory in
+ * the system. This custom file name will be reported on the @c
+ * "done" smart callback (explained in sequence).
*
- * @param it The item
+ * Finally, it has a view to display file system items into in two
+ * possible forms:
+ * - list
+ * - grid
*
- * This updates an item by calling all the item class functions again
- * to get the icons, labels and states. Use this when the original
- * item data has changed and the changes are desired to be reflected.
+ * If Elementary is built with support of the Ethumb thumbnailing
+ * library, the second form of view will display preview thumbnails
+ * of files which it supports.
*
- * Use elm_genlist_realized_items_update() to update all already realized
- * items.
+ * Smart callbacks one can register to:
*
- * @see elm_genlist_realized_items_update()
+ * - @c "selected" - the user has clicked on a file (when not in
+ * folders-only mode) or directory (when in folders-only mode)
+ * - @c "directory,open" - the list has been populated with new
+ * content (@c event_info is a pointer to the directory's
+ * path, a @b stringshared string)
+ * - @c "done" - the user has clicked on the "ok" or "cancel"
+ * buttons (@c event_info is a pointer to the selection's
+ * path, a @b stringshared string)
*
- * @ingroup Genlist
+ * Here is an example on its usage:
+ * @li @ref fileselector_example
+ */
+
+ /**
+ * @addtogroup Fileselector
+ * @{
+ */
+
+ /**
+ * Defines how a file selector widget is to layout its contents
+ * (file system entries).
*/
- EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Fileselector_Mode
+ {
+ ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
+ ELM_FILESELECTOR_GRID, /**< layout as a grid */
+ ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
+ } Elm_Fileselector_Mode;
+
/**
- * Update the item class of an item
+ * Add a new file selector widget to the given parent Elementary
+ * (container) object
*
- * @param it The item
- * @parem itc The item class for the item
+ * @param parent The parent object
+ * @return a new file selector widget handle or @c NULL, on errors
*
- * This sets another class fo the item, changing the way that it is
- * displayed. After changing the item class, elm_genlist_item_update() is
- * called on the item @p it.
+ * This function inserts a new file selector widget on the canvas.
*
- * @ingroup Genlist
+ * @ingroup Fileselector
*/
- EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
- EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
- * Set the text to be shown in a given genlist item's tooltips.
+ * Enable/disable the file name entry box where the user can type
+ * in a name for a file, in a given file selector widget
*
- * @param item The genlist item
- * @param text The text to set in the content
+ * @param obj The file selector object
+ * @param is_save @c EINA_TRUE to make the file selector a "saving
+ * dialog", @c EINA_FALSE otherwise
*
- * This call will setup the text to be used as tooltip to that item
- * (analogous to elm_object_tooltip_text_set(), but being item
- * tooltips with higher precedence than object tooltips). It can
- * have only one tooltip at a time, so any previous tooltip data
- * will get removed.
+ * Having the entry editable is useful on file saving dialogs on
+ * applications, where one gives a file name to save contents to,
+ * in a given directory in the system. This custom file name will
+ * be reported on the @c "done" smart callback.
*
- * In order to set an icon or something else as a tooltip, look at
- * elm_genlist_item_tooltip_content_cb_set().
+ * @see elm_fileselector_is_save_get()
*
- * @ingroup Genlist
+ * @ingroup Fileselector
*/
- EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
+
/**
- * Set the content to be shown in a given genlist item's tooltips
- *
- * @param item The genlist item.
- * @param func The function returning the tooltip contents.
- * @param data What to provide to @a func as callback data/context.
- * @param del_cb Called when data is not needed anymore, either when
- * another callback replaces @func, the tooltip is unset with
- * elm_genlist_item_tooltip_unset() or the owner @p item
- * dies. This callback receives as its first parameter the
- * given @p data, being @c event_info the item handle.
+ * Get whether the given file selector is in "saving dialog" mode
*
- * This call will setup the tooltip's contents to @p item
- * (analogous to elm_object_tooltip_content_cb_set(), but being
- * item tooltips with higher precedence than object tooltips). It
- * can have only one tooltip at a time, so any previous tooltip
- * content will get removed. @p func (with @p data) will be called
- * every time Elementary needs to show the tooltip and it should
- * return a valid Evas object, which will be fully managed by the
- * tooltip system, getting deleted when the tooltip is gone.
+ * @param obj The file selector object
+ * @return @c EINA_TRUE, if the file selector is in "saving dialog"
+ * mode, @c EINA_FALSE otherwise (and on errors)
*
- * In order to set just a text as a tooltip, look at
- * elm_genlist_item_tooltip_text_set().
+ * @see elm_fileselector_is_save_set() for more details
*
- * @ingroup Genlist
+ * @ingroup Fileselector
*/
- 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);
+ EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Unset a tooltip from a given genlist item
+ * Enable/disable folder-only view for a given file selector widget
*
- * @param item genlist item to remove a previously set tooltip from.
+ * @param obj The file selector object
+ * @param only @c EINA_TRUE to make @p obj only display
+ * directories, @c EINA_FALSE to make files to be displayed in it
+ * too
*
- * This call removes any tooltip set on @p item. The callback
- * provided as @c del_cb to
- * elm_genlist_item_tooltip_content_cb_set() will be called to
- * notify it is not used anymore (and have resources cleaned, if
- * need be).
+ * If enabled, the widget's view will only display folder items,
+ * naturally.
*
- * @see elm_genlist_item_tooltip_content_cb_set()
+ * @see elm_fileselector_folder_only_get()
*
- * @ingroup Genlist
+ * @ingroup Fileselector
*/
- EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
+
/**
- * Set a different @b style for a given genlist item's tooltip.
- *
- * @param item genlist item with tooltip set
- * @param style the <b>theme style</b> to use on tooltips (e.g. @c
- * "default", @c "transparent", etc)
- *
- * Tooltips can have <b>alternate styles</b> to be displayed on,
- * which are defined by the theme set on Elementary. This function
- * works analogously as elm_object_tooltip_style_set(), but here
- * applied only to genlist item objects. The default style for
- * tooltips is @c "default".
+ * Get whether folder-only view is set for a given file selector
+ * widget
*
- * @note before you set a style you should define a tooltip with
- * elm_genlist_item_tooltip_content_cb_set() or
- * elm_genlist_item_tooltip_text_set()
+ * @param obj The file selector object
+ * @return only @c EINA_TRUE if @p obj is only displaying
+ * directories, @c EINA_FALSE if files are being displayed in it
+ * too (and on errors)
*
- * @see elm_genlist_item_tooltip_style_get()
+ * @see elm_fileselector_folder_only_get()
*
- * @ingroup Genlist
+ * @ingroup Fileselector
*/
- EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the style set a given genlist item's tooltip.
+ * Enable/disable the "ok" and "cancel" buttons on a given file
+ * selector widget
*
- * @param item genlist item with tooltip already set on.
- * @return style the theme style in use, which defaults to
- * "default". If the object does not have a tooltip set,
- * then @c NULL is returned.
+ * @param obj The file selector object
+ * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
*
- * @see elm_genlist_item_tooltip_style_set() for more details
+ * @note A file selector without those buttons will never emit the
+ * @c "done" smart event, and is only usable if one is just hooking
+ * to the other two events.
*
- * @ingroup Genlist
- */
- EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
- /**
- * @brief Disable size restrictions on an object's tooltip
- * @param item The tooltip's anchor object
- * @param disable If EINA_TRUE, size restrictions are disabled
- * @return EINA_FALSE on failure, EINA_TRUE on success
+ * @see elm_fileselector_buttons_ok_cancel_get()
*
- * This function allows a tooltip to expand beyond its parant window's canvas.
- * It will instead be limited only by the size of the display.
+ * @ingroup Fileselector
*/
- EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
+ EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
+
/**
- * @brief Retrieve size restriction state of an object's tooltip
- * @param item The tooltip's anchor object
- * @return If EINA_TRUE, size restrictions are disabled
+ * Get whether the "ok" and "cancel" buttons on a given file
+ * selector widget are being shown.
*
- * This function returns whether a tooltip is allowed to expand beyond
- * its parant window's canvas.
- * It will instead be limited only by the size of the display.
+ * @param obj The file selector object
+ * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
+ * otherwise (and on errors)
+ *
+ * @see elm_fileselector_buttons_ok_cancel_set() for more details
+ *
+ * @ingroup Fileselector
*/
- EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
+ EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Set the type of mouse pointer/cursor decoration to be shown,
- * when the mouse pointer is over the given genlist widget item
+ * Enable/disable a tree view in the given file selector widget,
+ * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
*
- * @param item genlist item to customize cursor on
- * @param cursor the cursor type's name
+ * @param obj The file selector object
+ * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
+ * disable
*
- * This function works analogously as elm_object_cursor_set(), but
- * here the cursor's changing area is restricted to the item's
- * area, and not the whole widget's. Note that that item cursors
- * have precedence over widget cursors, so that a mouse over @p
- * item will always show cursor @p type.
+ * In a tree view, arrows are created on the sides of directories,
+ * allowing them to expand in place.
*
- * If this function is called twice for an object, a previously set
- * cursor will be unset on the second call.
+ * @note If it's in other mode, the changes made by this function
+ * will only be visible when one switches back to "list" mode.
*
- * @see elm_object_cursor_set()
- * @see elm_genlist_item_cursor_get()
- * @see elm_genlist_item_cursor_unset()
+ * @see elm_fileselector_expandable_get()
*
- * @ingroup Genlist
+ * @ingroup Fileselector
*/
- EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
+ EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
+
/**
- * Get the type of mouse pointer/cursor decoration set to be shown,
- * when the mouse pointer is over the given genlist widget item
+ * Get whether tree view is enabled for the given file selector
+ * widget
*
- * @param item genlist item with custom cursor set
- * @return the cursor type's name or @c NULL, if no custom cursors
- * were set to @p item (and on errors)
+ * @param obj The file selector object
+ * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
+ * otherwise (and or errors)
*
- * @see elm_object_cursor_get()
- * @see elm_genlist_item_cursor_set() for more details
- * @see elm_genlist_item_cursor_unset()
+ * @see elm_fileselector_expandable_set() for more details
*
- * @ingroup Genlist
+ * @ingroup Fileselector
*/
- EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Unset any custom mouse pointer/cursor decoration set to be
- * shown, when the mouse pointer is over the given genlist widget
- * item, thus making it show the @b default cursor again.
+ * Set, programmatically, the @b directory that a given file
+ * selector widget will display contents from
*
- * @param item a genlist item
+ * @param obj The file selector object
+ * @param path The path to display in @p obj
*
- * Use this call to undo any custom settings on this item's cursor
- * decoration, bringing it back to defaults (no custom style set).
+ * This will change the @b directory that @p obj is displaying. It
+ * will also clear the text entry area on the @p obj object, which
+ * displays select files' names.
*
- * @see elm_object_cursor_unset()
- * @see elm_genlist_item_cursor_set() for more details
+ * @see elm_fileselector_path_get()
*
- * @ingroup Genlist
+ * @ingroup Fileselector
*/
- EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
- /**
- * Set a different @b style for a given custom cursor set for a
- * genlist item.
- *
- * @param item genlist item with custom cursor set
- * @param style the <b>theme style</b> to use (e.g. @c "default",
- * @c "transparent", etc)
- *
- * This function only makes sense when one is using custom mouse
- * cursor decorations <b>defined in a theme file</b> , which can
- * have, given a cursor name/type, <b>alternate styles</b> on
- * it. It works analogously as elm_object_cursor_style_set(), but
- * here applied only to genlist item objects.
+ EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the parent directory's path that a given file selector
+ * widget is displaying
*
- * @warning Before you set a cursor style you should have defined a
- * custom cursor previously on the item, with
- * elm_genlist_item_cursor_set()
+ * @param obj The file selector object
+ * @return The (full) path of the directory the file selector is
+ * displaying, a @b stringshared string
*
- * @see elm_genlist_item_cursor_engine_only_set()
- * @see elm_genlist_item_cursor_style_get()
+ * @see elm_fileselector_path_set()
*
- * @ingroup Genlist
+ * @ingroup Fileselector
*/
- EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get the current @b style set for a given genlist item's custom
- * cursor
+ * Set, programmatically, the currently selected file/directory in
+ * the given file selector widget
*
- * @param item genlist item with custom cursor set.
- * @return style the cursor style in use. If the object does not
- * have a cursor set, then @c NULL is returned.
+ * @param obj The file selector object
+ * @param path The (full) path to a file or directory
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
+ * latter case occurs if the directory or file pointed to do not
+ * exist.
*
- * @see elm_genlist_item_cursor_style_set() for more details
+ * @see elm_fileselector_selected_get()
*
- * @ingroup Genlist
+ * @ingroup Fileselector
*/
- EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
+
/**
- * Set if the (custom) cursor for a given genlist item should be
- * searched in its theme, also, or should only rely on the
- * rendering engine.
+ * Get the currently selected item's (full) path, in the given file
+ * selector widget
*
- * @param item item with custom (custom) cursor already set on
- * @param engine_only Use @c EINA_TRUE to have cursors looked for
- * only on those provided by the rendering engine, @c EINA_FALSE to
- * have them searched on the widget's theme, as well.
+ * @param obj The file selector object
+ * @return The absolute path of the selected item, a @b
+ * stringshared string
*
- * @note This call is of use only if you've set a custom cursor
- * for genlist items, with elm_genlist_item_cursor_set().
+ * @note Custom editions on @p obj object's text entry, if made,
+ * will appear on the return string of this function, naturally.
*
- * @note By default, cursors will only be looked for between those
- * provided by the rendering engine.
+ * @see elm_fileselector_selected_set() for more details
*
- * @ingroup Genlist
+ * @ingroup Fileselector
*/
- EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * Get if the (custom) cursor for a given genlist item is being
- * searched in its theme, also, or is only relying on the rendering
- * engine.
+ * Set the mode in which a given file selector widget will display
+ * (layout) file system entries in its view
*
- * @param item a genlist item
- * @return @c EINA_TRUE, if cursors are being looked for only on
- * those provided by the rendering engine, @c EINA_FALSE if they
- * are being searched on the widget's theme, as well.
+ * @param obj The file selector object
+ * @param mode The mode of the fileselector, being it one of
+ * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
+ * first one, naturally, will display the files in a list. The
+ * latter will make the widget to display its entries in a grid
+ * form.
*
- * @see elm_genlist_item_cursor_engine_only_set(), for more details
+ * @note By using elm_fileselector_expandable_set(), the user may
+ * trigger a tree view for that list.
*
- * @ingroup Genlist
- */
- EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
- /**
- * Update the contents of all realized items.
+ * @note If Elementary is built with support of the Ethumb
+ * thumbnailing library, the second form of view will display
+ * preview thumbnails of files which it supports. You must have
+ * elm_need_ethumb() called in your Elementary for thumbnailing to
+ * work, though.
*
- * @param obj The genlist object.
+ * @see elm_fileselector_expandable_set().
+ * @see elm_fileselector_mode_get().
*
- * This updates all realized items by calling all the item class functions again
- * to get the icons, labels and states. Use this when the original
- * item data has changed and the changes are desired to be reflected.
+ * @ingroup Fileselector
+ */
+ EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the mode in which a given file selector widget is displaying
+ * (layouting) file system entries in its view
*
- * To update just one item, use elm_genlist_item_update().
+ * @param obj The fileselector object
+ * @return The mode in which the fileselector is at
*
- * @see elm_genlist_realized_items_get()
- * @see elm_genlist_item_update()
+ * @see elm_fileselector_mode_set() for more details
*
- * @ingroup Genlist
+ * @ingroup Fileselector
*/
- EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
- EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
* @}
*/
/**
- * @defgroup Check Check
+ * @defgroup Progressbar Progress bar
*
- * @image html img/widget/button/preview-00.png
- * @image html img/widget/button/preview-01.png
- * @image html img/widget/button/preview-02.png
+ * The progress bar is a widget for visually representing the
+ * progress status of a given job/task.
*
- * @brief The check widget allows for toggling a value between true and
- * false.
+ * A progress bar may be horizontal or vertical. It may display an
+ * icon besides it, as well as primary and @b units labels. The
+ * former is meant to label the widget as a whole, while the
+ * latter, which is formatted with floating point values (and thus
+ * accepts a <c>printf</c>-style format string, like <c>"%1.2f
+ * units"</c>), is meant to label the widget's <b>progress
+ * value</b>. Label, icon and unit strings/objects are @b optional
+ * for progress bars.
*
- * Check objects are a lot like radio objects in layout and functionality
- * except they do not work as a group, but independently and only toggle the
- * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
- * the boolean state (1 for true, 0 for false), and elm_check_state_get()
- * returns the current state. For convenience, like the radio objects, you
- * can set a pointer to a boolean directly with elm_check_state_pointer_set()
- * for it to modify.
+ * A progress bar may be @b inverted, in which state it gets its
+ * values inverted, with high values being on the left or top and
+ * low values on the right or bottom, as opposed to normally have
+ * the low values on the former and high values on the latter,
+ * respectively, for horizontal and vertical modes.
*
- * Signals that you can add callbacks for are:
- * "changed" - This is called whenever the user changes the state of one of
- * the check object(event_info is NULL).
+ * The @b span of the progress, as set by
+ * elm_progressbar_span_size_set(), is its length (horizontally or
+ * vertically), unless one puts size hints on the widget to expand
+ * on desired directions, by any container. That length will be
+ * scaled by the object or applications scaling factor. At any
+ * point code can query the progress bar for its value with
+ * elm_progressbar_value_get().
*
- * @ref tutorial_check should give you a firm grasp of how to use this widget.
- * @{
+ * Available widget styles for progress bars:
+ * - @c "default"
+ * - @c "wheel" (simple style, no text, no progression, only
+ * "pulse" effect is available)
+ *
+ * Here is an example on its usage:
+ * @li @ref progressbar_example
*/
+
/**
- * @brief Add a new Check object
+ * Add a new progress bar widget to the given parent Elementary
+ * (container) object
*
* @param parent The parent object
- * @return The new object or NULL if it cannot be created
- */
- EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the text label of the check object
+ * @return a new progress bar widget handle or @c NULL, on errors
*
- * @param obj The check object
- * @param label The text label string in UTF-8
+ * This function inserts a new progress bar widget on the canvas.
*
- * @deprecated use elm_object_text_set() instead.
+ * @ingroup Progressbar
*/
- EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the text label of the check object
- *
- * @param obj The check object
- * @return The text label string in UTF-8
+ * Set whether a given progress bar widget is at "pulsing mode" or
+ * not.
*
- * @deprecated use elm_object_text_get() instead.
- */
- EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the icon object of the check object
+ * @param obj The progress bar object
+ * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
+ * @c EINA_FALSE to put it back to its default one
*
- * @param obj The check object
- * @param icon The icon object
+ * By default, progress bars will display values from the low to
+ * high value boundaries. There are, though, contexts in which the
+ * state of progression of a given task is @b unknown. For those,
+ * one can set a progress bar widget to a "pulsing state", to give
+ * the user an idea that some computation is being held, but
+ * without exact progress values. In the default theme it will
+ * animate its bar with the contents filling in constantly and back
+ * to non-filled, in a loop. To start and stop this pulsing
+ * animation, one has to explicitly call elm_progressbar_pulse().
*
- * Once the icon object is set, a previously set one will be deleted.
- * If you want to keep that old content object, use the
- * elm_check_icon_unset() function.
- */
- EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
- /**
- * @brief Get the icon object of the check object
+ * @see elm_progressbar_pulse_get()
+ * @see elm_progressbar_pulse()
*
- * @param obj The check object
- * @return The icon object
+ * @ingroup Progressbar
*/
- EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
+
/**
- * @brief Unset the icon used for the check object
+ * Get whether a given progress bar widget is at "pulsing mode" or
+ * not.
*
- * @param obj The check object
- * @return The icon object that was being used
+ * @param obj The progress bar object
+ * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
+ * if it's in the default one (and on errors)
*
- * Unparent and return the icon object which was set for this widget.
+ * @ingroup Progressbar
*/
- EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the on/off state of the check object
- *
- * @param obj The check object
- * @param state The state to use (1 == on, 0 == off)
+ * Start/stop a given progress bar "pulsing" animation, if its
+ * under that mode
*
- * This sets the state of the check. If set
- * with elm_check_state_pointer_set() the state of that variable is also
- * changed. Calling this @b doesn't cause the "changed" signal to be emited.
- */
- EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
- /**
- * @brief Get the state of the check object
+ * @param obj The progress bar object
+ * @param state @c EINA_TRUE, to @b start the pulsing animation,
+ * @c EINA_FALSE to @b stop it
*
- * @param obj The check object
- * @return The boolean state
- */
- EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Set a convenience pointer to a boolean to change
+ * @note This call won't do anything if @p obj is not under "pulsing mode".
*
- * @param obj The check object
- * @param statep Pointer to the boolean to modify
+ * @see elm_progressbar_pulse_set() for more details.
*
- * This sets a pointer to a boolean, that, in addition to the check objects
- * state will also be modified directly. To stop setting the object pointed
- * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
- * then when this is called, the check objects state will also be modified to
- * reflect the value of the boolean @p statep points to, just like calling
- * elm_check_state_set().
- */
- EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
- /**
- * @}
+ * @ingroup Progressbar
*/
+ EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
/**
- * @defgroup Radio Radio
- *
- * @image html img/widget/radio/preview-00.png
- * @image latex img/widget/radio/preview-00.eps
+ * Set the progress value (in percentage) on a given progress bar
+ * widget
*
- * @brief Radio is a widget that allows for 1 or more options to be displayed
- * and have the user choose only 1 of them.
+ * @param obj The progress bar object
+ * @param val The progress value (@b must be between @c 0.0 and @c
+ * 1.0)
*
- * A radio object contains an indicator, an optional Label and an optional
- * icon object. While it's possible to have a group of only one radio they,
- * are normally used in groups of 2 or more. To add a radio to a group use
- * elm_radio_group_add(). The radio object(s) will select from one of a set
- * of integer values, so any value they are configuring needs to be mapped to
- * a set of integers. To configure what value that radio object represents,
- * use elm_radio_state_value_set() to set the integer it represents. To set
- * the value the whole group(which one is currently selected) is to indicate
- * use elm_radio_value_set() on any group member, and to get the groups value
- * use elm_radio_value_get(). For convenience the radio objects are also able
- * to directly set an integer(int) to the value that is selected. To specify
- * the pointer to this integer to modify, use elm_radio_value_pointer_set().
- * The radio objects will modify this directly. That implies the pointer must
- * point to valid memory for as long as the radio objects exist.
+ * Use this call to set progress bar levels.
*
- * Signals that you can add callbacks for are:
- * @li changed - This is called whenever the user changes the state of one of
- * the radio objects within the group of radio objects that work together.
+ * @note If you passes a value out of the specified range for @p
+ * val, it will be interpreted as the @b closest of the @b boundary
+ * values in the range.
*
- * @ref tutorial_radio show most of this API in action.
- * @{
+ * @ingroup Progressbar
*/
+ EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
+
/**
- * @brief Add a new radio to the parent
+ * Get the progress value (in percentage) on a given progress bar
+ * widget
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @param obj The progress bar object
+ * @return The value of the progressbar
+ *
+ * @see elm_progressbar_value_set() for more details
+ *
+ * @ingroup Progressbar
*/
- EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the text label of the radio object
+ * Set the label of a given progress bar widget
*
- * @param obj The radio object
- * @param label The text label string in UTF-8
+ * @param obj The progress bar object
+ * @param label The text label string, in UTF-8
*
+ * @ingroup Progressbar
* @deprecated use elm_object_text_set() instead.
*/
- EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the text label of the radio object
+ * Get the label of a given progress bar widget
*
- * @param obj The radio object
- * @return The text label string in UTF-8
+ * @param obj The progressbar object
+ * @return The text label string, in UTF-8
*
+ * @ingroup Progressbar
* @deprecated use elm_object_text_set() instead.
*/
- EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the icon object of the radio object
+ * Set the icon object of a given progress bar widget
*
- * @param obj The radio object
+ * @param obj The progress bar object
* @param icon The icon object
*
- * Once the icon object is set, a previously set one will be deleted. If you
- * want to keep that old content object, use the elm_radio_icon_unset()
- * function.
- */
- EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
- /**
- * @brief Get the icon object of the radio object
+ * Use this call to decorate @p obj with an icon next to it.
*
- * @param obj The radio object
- * @return The icon object
+ * @note Once the icon object is set, a previously set one will be
+ * deleted. If you want to keep that old content object, use the
+ * elm_progressbar_icon_unset() function.
*
- * @see elm_radio_icon_set()
+ * @see elm_progressbar_icon_get()
+ *
+ * @ingroup Progressbar
*/
- EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+
/**
- * @brief Unset the icon used for the radio object
+ * Retrieve the icon object set for a given progress bar widget
*
- * @param obj The radio object
- * @return The icon object that was being used
+ * @param obj The progress bar object
+ * @return The icon object's handle, if @p obj had one set, or @c NULL,
+ * otherwise (and on errors)
*
- * Unparent and return the icon object which was set for this widget.
+ * @see elm_progressbar_icon_set() for more details
*
- * @see elm_radio_icon_set()
+ * @ingroup Progressbar
*/
- EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * @brief Add this radio to a group of other radio objects
+ * Unset an icon set on a given progress bar widget
*
- * @param obj The radio object
- * @param group Any object whose group the @p obj is to join.
+ * @param obj The progress bar object
+ * @return The icon object that was being used, if any was set, or
+ * @c NULL, otherwise (and on errors)
*
- * Radio objects work in groups. Each member should have a different integer
- * value assigned. In order to have them work as a group, they need to know
- * about each other. This adds the given radio object to the group of which
- * the group object indicated is a member.
- */
- EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the integer value that this radio object represents
+ * This call will unparent and return the icon object which was set
+ * for this widget, previously, on success.
*
- * @param obj The radio object
- * @param value The value to use if this radio object is selected
+ * @see elm_progressbar_icon_set() for more details
*
- * This sets the value of the radio.
+ * @ingroup Progressbar
*/
- EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the integer value that this radio object represents
+ * Set the (exact) length of the bar region of a given progress bar
+ * widget
*
- * @param obj The radio object
- * @return The value used if this radio object is selected
+ * @param obj The progress bar object
+ * @param size The length of the progress bar's bar region
*
- * This gets the value of the radio.
+ * This sets the minimum width (when in horizontal mode) or height
+ * (when in vertical mode) of the actual bar area of the progress
+ * bar @p obj. This in turn affects the object's minimum size. Use
+ * this when you're not setting other size hints expanding on the
+ * given direction (like weight and alignment hints) and you would
+ * like it to have a specific size.
*
- * @see elm_radio_value_set()
- */
- EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the value of the radio.
+ * @note Icon, label and unit text around @p obj will require their
+ * own space, which will make @p obj to require more the @p size,
+ * actually.
*
- * @param obj The radio object
- * @param value The value to use for the group
+ * @see elm_progressbar_span_size_get()
*
- * This sets the value of the radio group and will also set the value if
- * pointed to, to the value supplied, but will not call any callbacks.
+ * @ingroup Progressbar
*/
- EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
+ EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the state of the radio object
+ * Get the length set for the bar region of a given progress bar
+ * widget
*
- * @param obj The radio object
- * @return The integer state
- */
- EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Set a convenience pointer to a integer to change
+ * @param obj The progress bar object
+ * @return The length of the progress bar's bar region
*
- * @param obj The radio object
- * @param valuep Pointer to the integer to modify
+ * If that size was not set previously, with
+ * elm_progressbar_span_size_set(), this call will return @c 0.
*
- * This sets a pointer to a integer, that, in addition to the radio objects
- * state will also be modified directly. To stop setting the object pointed
- * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
- * when this is called, the radio objects state will also be modified to
- * reflect the value of the integer valuep points to, just like calling
- * elm_radio_value_set().
+ * @ingroup Progressbar
*/
- EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
+ EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * @}
+ * Set the format string for a given progress bar widget's units
+ * label
+ *
+ * @param obj The progress bar object
+ * @param format The format string for @p obj's units label
+ *
+ * If @c NULL is passed on @p format, it will make @p obj's units
+ * area to be hidden completely. If not, it'll set the <b>format
+ * string</b> for the units label's @b text. The units label is
+ * provided a floating point value, so the units text is up display
+ * at most one floating point falue. Note that the units label is
+ * optional. Use a format string such as "%1.2f meters" for
+ * example.
+ *
+ * @note The default format string for a progress bar is an integer
+ * percentage, as in @c "%.0f %%".
+ *
+ * @see elm_progressbar_unit_format_get()
+ *
+ * @ingroup Progressbar
*/
+ EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
/**
- * @defgroup Pager Pager
- *
- * @image html img/widget/pager/preview-00.png
- * @image latex img/widget/pager/preview-00.eps
+ * Retrieve the format string set for a given progress bar widget's
+ * units label
*
- * @brief Widget that allows flipping between 1 or more “pages” of objects.
+ * @param obj The progress bar object
+ * @return The format set string for @p obj's units label or
+ * @c NULL, if none was set (and on errors)
*
- * The flipping between “pages” of objects is animated. All content in pager
- * is kept in a stack, the last content to be added will be on the top of the
- * stack(be visible).
+ * @see elm_progressbar_unit_format_set() for more details
*
- * Objects can be pushed or popped from the stack or deleted as normal.
- * Pushes and pops will animate (and a pop will delete the object once the
- * animation is finished). Any object already in the pager can be promoted to
- * the top(from its current stacking position) through the use of
- * elm_pager_content_promote(). Objects are pushed to the top with
- * elm_pager_content_push() and when the top item is no longer wanted, simply
- * pop it with elm_pager_content_pop() and it will also be deleted. If an
- * object is no longer needed and is not the top item, just delete it as
- * normal. You can query which objects are the top and bottom with
- * elm_pager_content_bottom_get() and elm_pager_content_top_get().
+ * @ingroup Progressbar
+ */
+ EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the orientation of a given progress bar widget
*
- * Signals that you can add callbacks for are:
- * "hide,finished" - when the previous page is hided
+ * @param obj The progress bar object
+ * @param horizontal Use @c EINA_TRUE to make @p obj to be
+ * @b horizontal, @c EINA_FALSE to make it @b vertical
*
- * This widget has the following styles available:
- * @li default
- * @li fade
- * @li fade_translucide
- * @li fade_invisible
- * @note This styles affect only the flipping animations, the appearance when
- * not animating is unaffected by styles.
+ * Use this function to change how your progress bar is to be
+ * disposed: vertically or horizontally.
*
- * @ref tutorial_pager gives a good overview of the usage of the API.
- * @{
+ * @see elm_progressbar_horizontal_get()
+ *
+ * @ingroup Progressbar
*/
+ EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
+
/**
- * Add a new pager to the parent
+ * Retrieve the orientation of a given progress bar widget
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @param obj The progress bar object
+ * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
+ * @c EINA_FALSE if it's @b vertical (and on errors)
*
- * @ingroup Pager
+ * @see elm_progressbar_horizontal_set() for more details
+ *
+ * @ingroup Progressbar
*/
- EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * @brief Push an object to the top of the pager stack (and show it).
+ * Invert a given progress bar widget's displaying values order
*
- * @param obj The pager object
- * @param content The object to push
+ * @param obj The progress bar object
+ * @param inverted Use @c EINA_TRUE to make @p obj inverted,
+ * @c EINA_FALSE to bring it back to default, non-inverted values.
*
- * The object pushed becomes a child of the pager, it will be controlled and
- * deleted when the pager is deleted.
+ * A progress bar may be @b inverted, in which state it gets its
+ * values inverted, with high values being on the left or top and
+ * low values on the right or bottom, as opposed to normally have
+ * the low values on the former and high values on the latter,
+ * respectively, for horizontal and vertical modes.
*
- * @note If the content is already in the stack use
- * elm_pager_content_promote().
- * @warning Using this function on @p content already in the stack results in
- * undefined behavior.
+ * @see elm_progressbar_inverted_get()
+ *
+ * @ingroup Progressbar
*/
- EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+ EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
+
/**
- * @brief Pop the object that is on top of the stack
+ * Get whether a given progress bar widget's displaying values are
+ * inverted or not
*
- * @param obj The pager object
+ * @param obj The progress bar object
+ * @return @c EINA_TRUE, if @p obj has inverted values,
+ * @c EINA_FALSE otherwise (and on errors)
*
- * This pops the object that is on the top(visible) of the pager, makes it
- * disappear, then deletes the object. The object that was underneath it on
- * the stack will become visible.
+ * @see elm_progressbar_inverted_set() for more details
+ *
+ * @ingroup Progressbar
*/
- EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * @brief Moves an object already in the pager stack to the top of the stack.
+ * @defgroup Separator Separator
*
- * @param obj The pager object
- * @param content The object to promote
+ * @brief Separator is a very thin object used to separate other objects.
*
- * This will take the @p content and move it to the top of the stack as
- * if it had been pushed there.
+ * A separator can be vertical or horizontal.
*
- * @note If the content isn't already in the stack use
- * elm_pager_content_push().
- * @warning Using this function on @p content not already in the stack
- * results in undefined behavior.
+ * @ref tutorial_separator is a good example of how to use a separator.
+ * @{
*/
- EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
/**
- * @brief Return the object at the bottom of the pager stack
+ * @brief Add a separator object to @p parent
*
- * @param obj The pager object
- * @return The bottom object or NULL if none
+ * @param parent The parent object
+ *
+ * @return The separator object, or NULL upon failure
*/
- EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * @brief Return the object at the top of the pager stack
+ * @brief Set the horizontal mode of a separator object
*
- * @param obj The pager object
- * @return The top object or NULL if none
+ * @param obj The separator object
+ * @param horizontal If true, the separator is horizontal
*/
- EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the horizontal mode of a separator object
+ *
+ * @param obj The separator object
+ * @return If true, the separator is horizontal
+ *
+ * @see elm_separator_horizontal_set()
+ */
+ EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
* @}
*/
/**
- * @defgroup Slideshow Slideshow
+ * @defgroup Spinner Spinner
+ * @ingroup Elementary
*
- * @image html img/widget/slideshow/preview-00.png
- * @image latex img/widget/slideshow/preview-00.eps
+ * @image html img/widget/spinner/preview-00.png
+ * @image latex img/widget/spinner/preview-00.eps
*
- * This widget, as the name indicates, is a pre-made image
- * slideshow panel, with API functions acting on (child) image
- * items presentation. Between those actions, are:
- * - advance to next/previous image
- * - select the style of image transition animation
- * - set the exhibition time for each image
- * - start/stop the slideshow
+ * A spinner is a widget which allows the user to increase or decrease
+ * numeric values using arrow buttons, or edit values directly, clicking
+ * over it and typing the new value.
*
- * The transition animations are defined in the widget's theme,
- * consequently new animations can be added without having to
- * update the widget's code.
+ * By default the spinner will not wrap and has a label
+ * of "%.0f" (just showing the integer value of the double).
*
- * @section Slideshow_Items Slideshow items
+ * A spinner has a label that is formatted with floating
+ * point values and thus accepts a printf-style format string, like
+ * “%1.2f units”.
*
- * For slideshow items, just like for @ref Genlist "genlist" ones,
- * the user defines a @b classes, specifying functions that will be
- * called on the item's creation and deletion times.
+ * It also allows specific values to be replaced by pre-defined labels.
*
- * The #Elm_Slideshow_Item_Class structure contains the following
- * members:
+ * Smart callbacks one can register to:
*
- * - @c func.get - When an item is displayed, this function is
- * called, and it's where one should create the item object, de
- * facto. For example, the object can be a pure Evas image object
- * or an Elementary @ref Photocam "photocam" widget. See
- * #SlideshowItemGetFunc.
- * - @c func.del - When an item is no more displayed, this function
- * is called, where the user must delete any data associated to
- * the item. See #SlideshowItemDelFunc.
+ * - "changed" - Whenever the spinner value is changed.
+ * - "delay,changed" - A short time after the value is changed by the user.
+ * This will be called only when the user stops dragging for a very short
+ * period or when they release their finger/mouse, so it avoids possibly
+ * expensive reactions to the value change.
*
- * @section Slideshow_Caching Slideshow caching
+ * Available styles for it:
+ * - @c "default";
+ * - @c "vertical": up/down buttons at the right side and text left aligned.
*
- * The slideshow provides facilities to have items adjacent to the
- * one being displayed <b>already "realized"</b> (i.e. loaded) for
- * you, so that the system does not have to decode image data
- * anymore at the time it has to actually switch images on its
- * viewport. The user is able to set the numbers of items to be
- * cached @b before and @b after the current item, in the widget's
- * item list.
+ * Here is an example on its usage:
+ * @ref spinner_example
+ */
+
+ /**
+ * @addtogroup Spinner
+ * @{
+ */
+
+ /**
+ * Add a new spinner widget to the given parent Elementary
+ * (container) object.
*
- * Smart events one can add callbacks for are:
+ * @param parent The parent object.
+ * @return a new spinner widget handle or @c NULL, on errors.
*
- * - @c "changed" - when the slideshow switches its view to a new
- * item
+ * This function inserts a new spinner widget on the canvas.
+ *
+ * @ingroup Spinner
*
- * List of examples for the slideshow widget:
- * @li @ref slideshow_example
*/
+ EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * @addtogroup Slideshow
- * @{
+ * Set the format string of the displayed label.
+ *
+ * @param obj The spinner object.
+ * @param fmt The format string for the label display.
+ *
+ * If @c NULL, this sets the format to "%.0f". If not it sets the format
+ * string for the label text. The label text is provided a floating point
+ * value, so the label text can display up to 1 floating point value.
+ * Note that this is optional.
+ *
+ * Use a format string such as "%1.2f meters" for example, and it will
+ * display values like: "3.14 meters" for a value equal to 3.14159.
+ *
+ * Default is "%0.f".
+ *
+ * @see elm_spinner_label_format_get()
+ *
+ * @ingroup Spinner
*/
-
- typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
- typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
- typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
- typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
- typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
+ EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
/**
- * @struct _Elm_Slideshow_Item_Class
+ * Get the label format of the spinner.
*
- * Slideshow item class definition. See @ref Slideshow_Items for
- * field details.
+ * @param obj The spinner object.
+ * @return The text label format string in UTF-8.
+ *
+ * @see elm_spinner_label_format_set() for details.
+ *
+ * @ingroup Spinner
*/
- struct _Elm_Slideshow_Item_Class
- {
- struct _Elm_Slideshow_Item_Class_Func
- {
- SlideshowItemGetFunc get;
- SlideshowItemDelFunc del;
- } func;
- }; /**< #Elm_Slideshow_Item_Class member definitions */
+ EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Add a new slideshow widget to the given parent Elementary
- * (container) object
+ * Set the minimum and maximum values for the spinner.
+ *
+ * @param obj The spinner object.
+ * @param min The minimum value.
+ * @param max The maximum value.
+ *
+ * Define the allowed range of values to be selected by the user.
+ *
+ * If actual value is less than @p min, it will be updated to @p min. If it
+ * is bigger then @p max, will be updated to @p max. Actual value can be
+ * get with elm_spinner_value_get().
*
- * @param parent The parent object
- * @return A new slideshow widget handle or @c NULL, on errors
+ * By default, min is equal to 0, and max is equal to 100.
*
- * This function inserts a new slideshow widget on the canvas.
+ * @warning Maximum must be greater than minimum.
*
- * @ingroup Slideshow
+ * @see elm_spinner_min_max_get()
+ *
+ * @ingroup Spinner
*/
- EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
/**
- * Add (append) a new item in a given slideshow widget.
+ * Get the minimum and maximum values of the spinner.
*
- * @param obj The slideshow object
- * @aram itc The item class for the item
- * @param data The item's data
- * @return A handle to the item added or @c NULL, on errors
+ * @param obj The spinner object.
+ * @param min Pointer where to store the minimum value.
+ * @param max Pointer where to store the maximum value.
*
- * Add a new item to @p obj's internal list of items, appending it.
- * The item's class must contain the function really fetching the
- * image object to show for this item, which could be an Evas image
- * object or an Elementary photo, for example. The @p data
- * parameter is going to be passed to both class functions of the
- * item.
+ * @note If only one value is needed, the other pointer can be passed
+ * as @c NULL.
*
- * @see #Elm_Slideshow_Item_Class
- * @see elm_slideshow_item_sorted_insert()
+ * @see elm_spinner_min_max_set() for details.
*
- * @ingroup Slideshow
+ * @ingroup Spinner
*/
- EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
+ EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
/**
- * Insert a new item into the given slideshow widget, using the @p func
- * function to sort items (by item handles).
+ * Set the step used to increment or decrement the spinner value.
*
- * @param obj The slideshow object
- * @aram itc The item class for the item
- * @param data The item's data
- * @param func The comparing function to be used to sort slideshow
- * items <b>by #Elm_Slideshow_Item item handles</b>
- * @return Returns The slideshow item handle, on success, or
- * @c NULL, on errors
+ * @param obj The spinner object.
+ * @param step The step value.
*
- * Add a new item to @p obj's internal list of items, in a position
- * determined by the @p func comparing function. The item's class
- * must contain the function really fetching the image object to
- * show for this item, which could be an Evas image object or an
- * Elementary photo, for example. The @p data parameter is going to
- * be passed to both class functions of the item.
+ * This value will be incremented or decremented to the displayed value.
+ * It will be incremented while the user keep right or top arrow pressed,
+ * and will be decremented while the user keep left or bottom arrow pressed.
*
- * @see #Elm_Slideshow_Item_Class
- * @see elm_slideshow_item_add()
+ * The interval to increment / decrement can be set with
+ * elm_spinner_interval_set().
*
- * @ingroup Slideshow
+ * By default step value is equal to 1.
+ *
+ * @see elm_spinner_step_get()
+ *
+ * @ingroup Spinner
*/
- 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);
+ EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
/**
- * Display a given slideshow widget's item, programmatically.
+ * Get the step used to increment or decrement the spinner value.
*
- * @param obj The slideshow object
- * @param item The item to display on @p obj's viewport
+ * @param obj The spinner object.
+ * @return The step value.
*
- * The change between the current item and @p item will use the
- * transition @p obj is set to use (@see
- * elm_slideshow_transition_set()).
+ * @see elm_spinner_step_get() for more details.
*
- * @ingroup Slideshow
+ * @ingroup Spinner
*/
- EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
+ EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Slide to the @b next item, in a given slideshow widget
+ * Set the value the spinner displays.
*
- * @param obj The slideshow object
+ * @param obj The spinner object.
+ * @param val The value to be displayed.
*
- * The sliding animation @p obj is set to use will be the
- * transition effect used, after this call is issued.
+ * Value will be presented on the label following format specified with
+ * elm_spinner_format_set().
*
- * @note If the end of the slideshow's internal list of items is
- * reached, it'll wrap around to the list's beginning, again.
+ * @warning The value must to be between min and max values. This values
+ * are set by elm_spinner_min_max_set().
*
- * @ingroup Slideshow
+ * @see elm_spinner_value_get().
+ * @see elm_spinner_format_set().
+ * @see elm_spinner_min_max_set().
+ *
+ * @ingroup Spinner
*/
- EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
/**
- * Slide to the @b previous item, in a given slideshow widget
- *
- * @param obj The slideshow object
+ * Get the value displayed by the spinner.
*
- * The sliding animation @p obj is set to use will be the
- * transition effect used, after this call is issued.
+ * @param obj The spinner object.
+ * @return The value displayed.
*
- * @note If the beginning of the slideshow's internal list of items
- * is reached, it'll wrap around to the list's end, again.
+ * @see elm_spinner_value_set() for details.
*
- * @ingroup Slideshow
+ * @ingroup Spinner
*/
- EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Returns the list of sliding transition/effect names available, for a
- * given slideshow widget.
+ * Set whether the spinner should wrap when it reaches its
+ * minimum or maximum value.
*
- * @param obj The slideshow object
- * @return The list of transitions (list of @b stringshared strings
- * as data)
+ * @param obj The spinner object.
+ * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
+ * disable it.
*
- * The transitions, which come from @p obj's theme, must be an EDC
- * data item named @c "transitions" on the theme file, with (prefix)
- * names of EDC programs actually implementing them.
+ * Disabled by default. If disabled, when the user tries to increment the
+ * value,
+ * but displayed value plus step value is bigger than maximum value,
+ * the spinner
+ * won't allow it. The same happens when the user tries to decrement it,
+ * but the value less step is less than minimum value.
*
- * The available transitions for slideshows on the default theme are:
- * - @c "fade" - the current item fades out, while the new one
- * fades in to the slideshow's viewport.
- * - @c "black_fade" - the current item fades to black, and just
- * then, the new item will fade in.
- * - @c "horizontal" - the current item slides horizontally, until
- * it gets out of the slideshow's viewport, while the new item
- * comes from the left to take its place.
- * - @c "vertical" - the current item slides vertically, until it
- * gets out of the slideshow's viewport, while the new item comes
- * from the bottom to take its place.
- * - @c "square" - the new item starts to appear from the middle of
- * the current one, but with a tiny size, growing until its
- * target (full) size and covering the old one.
+ * When wrap is enabled, in such situations it will allow these changes,
+ * but will get the value that would be less than minimum and subtracts
+ * from maximum. Or add the value that would be more than maximum to
+ * the minimum.
*
- * @warning The stringshared strings get no new references
- * exclusive to the user grabbing the list, here, so if you'd like
- * to use them out of this call's context, you'd better @c
- * eina_stringshare_ref() them.
+ * E.g.:
+ * @li min value = 10
+ * @li max value = 50
+ * @li step value = 20
+ * @li displayed value = 20
*
- * @see elm_slideshow_transition_set()
+ * When the user decrement value (using left or bottom arrow), it will
+ * displays @c 40, because max - (min - (displayed - step)) is
+ * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
*
- * @ingroup Slideshow
+ * @see elm_spinner_wrap_get().
+ *
+ * @ingroup Spinner
*/
- EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
/**
- * Set the current slide transition/effect in use for a given
- * slideshow widget
- *
- * @param obj The slideshow object
- * @param transition The new transition's name string
+ * Get whether the spinner should wrap when it reaches its
+ * minimum or maximum value.
*
- * If @p transition is implemented in @p obj's theme (i.e., is
- * contained in the list returned by
- * elm_slideshow_transitions_get()), this new sliding effect will
- * be used on the widget.
+ * @param obj The spinner object
+ * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
+ * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
*
- * @see elm_slideshow_transitions_get() for more details
+ * @see elm_spinner_wrap_set() for details.
*
- * @ingroup Slideshow
+ * @ingroup Spinner
*/
- EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the current slide transition/effect in use for a given
- * slideshow widget
+ * Set whether the spinner can be directly edited by the user or not.
*
- * @param obj The slideshow object
- * @return The current transition's name
+ * @param obj The spinner object.
+ * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
+ * don't allow users to edit it directly.
*
- * @see elm_slideshow_transition_set() for more details
+ * Spinner objects can have edition @b disabled, in which state they will
+ * be changed only by arrows.
+ * Useful for contexts
+ * where you don't want your users to interact with it writting the value.
+ * Specially
+ * when using special values, the user can see real value instead
+ * of special label on edition.
*
- * @ingroup Slideshow
+ * It's enabled by default.
+ *
+ * @see elm_spinner_editable_get()
+ *
+ * @ingroup Spinner
*/
- EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
/**
- * Set the interval between each image transition on a given
- * slideshow widget, <b>and start the slideshow, itself</b>
+ * Get whether the spinner can be directly edited by the user or not.
*
- * @param obj The slideshow object
- * @param timeout The new displaying timeout for images
+ * @param obj The spinner object.
+ * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
+ * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
*
- * After this call, the slideshow widget will start cycling its
- * view, sequentially and automatically, with the images of the
- * items it has. The time between each new image displayed is going
- * to be @p timeout, in @b seconds. If a different timeout was set
- * previously and an slideshow was in progress, it will continue
- * with the new time between transitions, after this call.
+ * @see elm_spinner_editable_set() for details.
*
- * @note A value less than or equal to 0 on @p timeout will disable
- * the widget's internal timer, thus halting any slideshow which
- * could be happening on @p obj.
+ * @ingroup Spinner
+ */
+ EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set a special string to display in the place of the numerical value.
*
- * @see elm_slideshow_timeout_get()
+ * @param obj The spinner object.
+ * @param value The value to be replaced.
+ * @param label The label to be used.
+ *
+ * It's useful for cases when a user should select an item that is
+ * better indicated by a label than a value. For example, weekdays or months.
+ *
+ * E.g.:
+ * @code
+ * sp = elm_spinner_add(win);
+ * elm_spinner_min_max_set(sp, 1, 3);
+ * elm_spinner_special_value_add(sp, 1, "January");
+ * elm_spinner_special_value_add(sp, 2, "February");
+ * elm_spinner_special_value_add(sp, 3, "March");
+ * evas_object_show(sp);
+ * @endcode
*
- * @ingroup Slideshow
+ * @ingroup Spinner
*/
- EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
+ EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
/**
- * Get the interval set for image transitions on a given slideshow
- * widget.
+ * Set the interval on time updates for an user mouse button hold
+ * on spinner widgets' arrows.
*
- * @param obj The slideshow object
- * @return Returns the timeout set on it
+ * @param obj The spinner object.
+ * @param interval The (first) interval value in seconds.
*
- * @see elm_slideshow_timeout_set() for more details
+ * This interval value is @b decreased while the user holds the
+ * mouse pointer either incrementing or decrementing spinner's value.
*
- * @ingroup Slideshow
- */
- EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /**
- * Set if, after a slideshow is started, for a given slideshow
- * widget, its items should be displayed cyclically or not.
+ * This helps the user to get to a given value distant from the
+ * current one easier/faster, as it will start to change quicker and
+ * quicker on mouse button holds.
*
- * @param obj The slideshow object
- * @param loop Use @c EINA_TRUE to make it cycle through items or
- * @c EINA_FALSE for it to stop at the end of @p obj's internal
- * list of items
+ * The calculation for the next change interval value, starting from
+ * the one set with this call, is the previous interval divided by
+ * @c 1.05, so it decreases a little bit.
*
- * @note elm_slideshow_next() and elm_slideshow_previous() will @b
- * ignore what is set by this functions, i.e., they'll @b always
- * cycle through items. This affects only the "automatic"
- * slideshow, as set by elm_slideshow_timeout_set().
+ * The default starting interval value for automatic changes is
+ * @c 0.85 seconds.
*
- * @see elm_slideshow_loop_get()
+ * @see elm_spinner_interval_get()
*
- * @ingroup Slideshow
+ * @ingroup Spinner
*/
- EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
+ EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
/**
- * Get if, after a slideshow is started, for a given slideshow
- * widget, its items are to be displayed cyclically or not.
+ * Get the interval on time updates for an user mouse button hold
+ * on spinner widgets' arrows.
*
- * @param obj The slideshow object
- * @return @c EINA_TRUE, if the items in @p obj will be cycled
- * through or @c EINA_FALSE, otherwise
+ * @param obj The spinner object.
+ * @return The (first) interval value, in seconds, set on it.
*
- * @see elm_slideshow_loop_set() for more details
+ * @see elm_spinner_interval_set() for more details.
*
- * @ingroup Slideshow
+ * @ingroup Spinner
*/
- EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Remove all items from a given slideshow widget
- *
- * @param obj The slideshow object
- *
- * This removes (and deletes) all items in @p obj, leaving it
- * empty.
- *
- * @see elm_slideshow_item_del(), to remove just one item.
- *
- * @ingroup Slideshow
+ * @}
*/
- EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the internal list of items in a given slideshow widget.
+ * @defgroup Index Index
*
- * @param obj The slideshow object
- * @return The list of items (#Elm_Slideshow_Item as data) or
- * @c NULL on errors.
+ * @image html img/widget/index/preview-00.png
+ * @image latex img/widget/index/preview-00.eps
*
- * This list is @b not to be modified in any way and must not be
- * freed. Use the list members with functions like
- * elm_slideshow_item_del(), elm_slideshow_item_data_get().
+ * An index widget gives you an index for fast access to whichever
+ * group of other UI items one might have. It's a list of text
+ * items (usually letters, for alphabetically ordered access).
*
- * @warning This list is only valid until @p obj object's internal
- * items list is changed. It should be fetched again with another
- * call to this function when changes happen.
+ * Index widgets are by default hidden and just appear when the
+ * user clicks over it's reserved area in the canvas. In its
+ * default theme, it's an area one @ref Fingers "finger" wide on
+ * the right side of the index widget's container.
*
- * @ingroup Slideshow
- */
- EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /**
- * Delete a given item from a slideshow widget.
+ * When items on the index are selected, smart callbacks get
+ * called, so that its user can make other container objects to
+ * show a given area or child object depending on the index item
+ * selected. You'd probably be using an index together with @ref
+ * List "lists", @ref Genlist "generic lists" or @ref Gengrid
+ * "general grids".
*
- * @param item The slideshow item
+ * Smart events one can add callbacks for are:
+ * - @c "changed" - When the selected index item changes. @c
+ * event_info is the selected item's data pointer.
+ * - @c "delay,changed" - When the selected index item changes, but
+ * after a small idling period. @c event_info is the selected
+ * item's data pointer.
+ * - @c "selected" - When the user releases a mouse button and
+ * selects an item. @c event_info is the selected item's data
+ * pointer.
+ * - @c "level,up" - when the user moves a finger from the first
+ * level to the second level
+ * - @c "level,down" - when the user moves a finger from the second
+ * level to the first level
*
- * @ingroup Slideshow
+ * The @c "delay,changed" event is so that it'll wait a small time
+ * before actually reporting those events and, moreover, just the
+ * last event happening on those time frames will actually be
+ * reported.
+ *
+ * Here are some examples on its usage:
+ * @li @ref index_example_01
+ * @li @ref index_example_02
*/
- EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
/**
- * Return the data associated with a given slideshow item
- *
- * @param item The slideshow item
- * @return Returns the data associated to this item
- *
- * @ingroup Slideshow
+ * @addtogroup Index
+ * @{
*/
- EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
+
+ typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
/**
- * Returns the currently displayed item, in a given slideshow widget
+ * Add a new index widget to the given parent Elementary
+ * (container) object
*
- * @param obj The slideshow object
- * @return A handle to the item being displayed in @p obj or
- * @c NULL, if none is (and on errors)
+ * @param parent The parent object
+ * @return a new index widget handle or @c NULL, on errors
*
- * @ingroup Slideshow
+ * This function inserts a new index widget on the canvas.
+ *
+ * @ingroup Index
*/
- EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Get the real Evas object created to implement the view of a
- * given slideshow item
+ * Set whether a given index widget is or not visible,
+ * programatically.
*
- * @param item The slideshow item.
- * @return the Evas object implementing this item's view.
+ * @param obj The index object
+ * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
*
- * This returns the actual Evas object used to implement the
- * specified slideshow item's view. This may be @c NULL, as it may
- * not have been created or may have been deleted, at any time, by
- * the slideshow. <b>Do not modify this object</b> (move, resize,
- * show, hide, etc.), as the slideshow is controlling it. This
- * function is for querying, emitting custom signals or hooking
- * lower level callbacks for events on that object. Do not delete
- * this object under any circumstances.
+ * Not to be confused with visible as in @c evas_object_show() --
+ * visible with regard to the widget's auto hiding feature.
*
- * @see elm_slideshow_item_data_get()
+ * @see elm_index_active_get()
*
- * @ingroup Slideshow
+ * @ingroup Index
*/
- EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
+ EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
/**
- * Get the the item, in a given slideshow widget, placed at
- * position @p nth, in its internal items list
+ * Get whether a given index widget is currently visible or not.
*
- * @param obj The slideshow object
- * @param nth The number of the item to grab a handle to (0 being
- * the first)
- * @return The item stored in @p obj at position @p nth or @c NULL,
- * if there's no item with that index (and on errors)
+ * @param obj The index object
+ * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
*
- * @ingroup Slideshow
+ * @see elm_index_active_set() for more details
+ *
+ * @ingroup Index
*/
- EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the current slide layout in use for a given slideshow widget
- *
- * @param obj The slideshow object
- * @param layout The new layout's name string
+ * Set the items level for a given index widget.
*
- * If @p layout is implemented in @p obj's theme (i.e., is contained
- * in the list returned by elm_slideshow_layouts_get()), this new
- * images layout will be used on the widget.
+ * @param obj The index object.
+ * @param level @c 0 or @c 1, the currently implemented levels.
*
- * @see elm_slideshow_layouts_get() for more details
+ * @see elm_index_item_level_get()
*
- * @ingroup Slideshow
+ * @ingroup Index
*/
- EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
+ EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
/**
- * Get the current slide layout in use for a given slideshow widget
+ * Get the items level set for a given index widget.
*
- * @param obj The slideshow object
- * @return The current layout's name
+ * @param obj The index object.
+ * @return @c 0 or @c 1, which are the levels @p obj might be at.
*
- * @see elm_slideshow_layout_set() for more details
+ * @see elm_index_item_level_set() for more information
*
- * @ingroup Slideshow
+ * @ingroup Index
*/
- EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Returns the list of @b layout names available, for a given
- * slideshow widget.
- *
- * @param obj The slideshow object
- * @return The list of layouts (list of @b stringshared strings
- * as data)
- *
- * Slideshow layouts will change how the widget is to dispose each
- * image item in its viewport, with regard to cropping, scaling,
- * etc.
- *
- * The layouts, which come from @p obj's theme, must be an EDC
- * data item name @c "layouts" on the theme file, with (prefix)
- * names of EDC programs actually implementing them.
- *
- * The available layouts for slideshows on the default theme are:
- * - @c "fullscreen" - item images with original aspect, scaled to
- * touch top and down slideshow borders or, if the image's heigh
- * is not enough, left and right slideshow borders.
- * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
- * one, but always leaving 10% of the slideshow's dimensions of
- * distance between the item image's borders and the slideshow
- * borders, for each axis.
+ * Returns the last selected item's data, for a given index widget.
*
- * @warning The stringshared strings get no new references
- * exclusive to the user grabbing the list, here, so if you'd like
- * to use them out of this call's context, you'd better @c
- * eina_stringshare_ref() them.
+ * @param obj The index object.
+ * @return The item @b data associated to the last selected item on
+ * @p obj (or @c NULL, on errors).
*
- * @see elm_slideshow_layout_set()
+ * @warning The returned value is @b not an #Elm_Index_Item item
+ * handle, but the data associated to it (see the @c item parameter
+ * in elm_index_item_append(), as an example).
*
- * @ingroup Slideshow
+ * @ingroup Index
*/
- EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
/**
- * Set the number of items to cache, on a given slideshow widget,
- * <b>before the current item</b>
+ * Append a new item on a given index widget.
*
- * @param obj The slideshow object
- * @param count Number of items to cache before the current one
+ * @param obj The index object.
+ * @param letter Letter under which the item should be indexed
+ * @param item The item data to set for the index's item
*
- * The default value for this property is @c 2. See
- * @ref Slideshow_Caching "slideshow caching" for more details.
+ * Despite the most common usage of the @p letter argument is for
+ * single char strings, one could use arbitrary strings as index
+ * entries.
*
- * @see elm_slideshow_cache_before_get()
+ * @c item will be the pointer returned back on @c "changed", @c
+ * "delay,changed" and @c "selected" smart events.
*
- * @ingroup Slideshow
+ * @ingroup Index
*/
- EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
+ EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
/**
- * Retrieve the number of items to cache, on a given slideshow widget,
- * <b>before the current item</b>
+ * Prepend a new item on a given index widget.
*
- * @param obj The slideshow object
- * @return The number of items set to be cached before the current one
+ * @param obj The index object.
+ * @param letter Letter under which the item should be indexed
+ * @param item The item data to set for the index's item
*
- * @see elm_slideshow_cache_before_set() for more details
+ * Despite the most common usage of the @p letter argument is for
+ * single char strings, one could use arbitrary strings as index
+ * entries.
*
- * @ingroup Slideshow
+ * @c item will be the pointer returned back on @c "changed", @c
+ * "delay,changed" and @c "selected" smart events.
+ *
+ * @ingroup Index
*/
- EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
/**
- * Set the number of items to cache, on a given slideshow widget,
- * <b>after the current item</b>
+ * Append a new item, on a given index widget, <b>after the item
+ * having @p relative as data</b>.
*
- * @param obj The slideshow object
- * @param count Number of items to cache after the current one
+ * @param obj The index object.
+ * @param letter Letter under which the item should be indexed
+ * @param item The item data to set for the index's item
+ * @param relative The item data of the index item to be the
+ * predecessor of this new one
*
- * The default value for this property is @c 2. See
- * @ref Slideshow_Caching "slideshow caching" for more details.
+ * Despite the most common usage of the @p letter argument is for
+ * single char strings, one could use arbitrary strings as index
+ * entries.
*
- * @see elm_slideshow_cache_after_get()
+ * @c item will be the pointer returned back on @c "changed", @c
+ * "delay,changed" and @c "selected" smart events.
*
- * @ingroup Slideshow
+ * @note If @p relative is @c NULL or if it's not found to be data
+ * set on any previous item on @p obj, this function will behave as
+ * elm_index_item_append().
+ *
+ * @ingroup Index
*/
- EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
+ EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
/**
- * Retrieve the number of items to cache, on a given slideshow widget,
- * <b>after the current item</b>
+ * Prepend a new item, on a given index widget, <b>after the item
+ * having @p relative as data</b>.
*
- * @param obj The slideshow object
- * @return The number of items set to be cached after the current one
+ * @param obj The index object.
+ * @param letter Letter under which the item should be indexed
+ * @param item The item data to set for the index's item
+ * @param relative The item data of the index item to be the
+ * successor of this new one
*
- * @see elm_slideshow_cache_after_set() for more details
+ * Despite the most common usage of the @p letter argument is for
+ * single char strings, one could use arbitrary strings as index
+ * entries.
*
- * @ingroup Slideshow
- */
- EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /**
- * Get the number of items stored in a given slideshow widget
+ * @c item will be the pointer returned back on @c "changed", @c
+ * "delay,changed" and @c "selected" smart events.
*
- * @param obj The slideshow object
- * @return The number of items on @p obj, at the moment of this call
+ * @note If @p relative is @c NULL or if it's not found to be data
+ * set on any previous item on @p obj, this function will behave as
+ * elm_index_item_prepend().
*
- * @ingroup Slideshow
+ * @ingroup Index
*/
- EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
/**
- * @}
+ * Insert a new item into the given index widget, using @p cmp_func
+ * function to sort items (by item handles).
+ *
+ * @param obj The index object.
+ * @param letter Letter under which the item should be indexed
+ * @param item The item data to set for the index's item
+ * @param cmp_func The comparing function to be used to sort index
+ * items <b>by #Elm_Index_Item item handles</b>
+ * @param cmp_data_func A @b fallback function to be called for the
+ * sorting of index items <b>by item data</b>). It will be used
+ * when @p cmp_func returns @c 0 (equality), which means an index
+ * item with provided item data already exists. To decide which
+ * data item should be pointed to by the index item in question, @p
+ * cmp_data_func will be used. If @p cmp_data_func returns a
+ * non-negative value, the previous index item data will be
+ * replaced by the given @p item pointer. If the previous data need
+ * to be freed, it should be done by the @p cmp_data_func function,
+ * because all references to it will be lost. If this function is
+ * not provided (@c NULL is given), index items will be @b
+ * duplicated, if @p cmp_func returns @c 0.
+ *
+ * Despite the most common usage of the @p letter argument is for
+ * single char strings, one could use arbitrary strings as index
+ * entries.
+ *
+ * @c item will be the pointer returned back on @c "changed", @c
+ * "delay,changed" and @c "selected" smart events.
+ *
+ * @ingroup Index
*/
+ 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);
/**
- * @defgroup Fileselector File Selector
+ * Remove an item from a given index widget, <b>to be referenced by
+ * it's data value</b>.
*
- * @image html img/widget/fileselector/preview-00.png
- * @image latex img/widget/fileselector/preview-00.eps
+ * @param obj The index object
+ * @param item The item's data pointer for the item to be removed
+ * from @p obj
*
- * A file selector is a widget that allows a user to navigate
- * through a file system, reporting file selections back via its
- * API.
+ * If a deletion callback is set, via elm_index_item_del_cb_set(),
+ * that callback function will be called by this one.
*
- * It contains shortcut buttons for home directory (@c ~) and to
- * jump one directory upwards (..), as well as cancel/ok buttons to
- * confirm/cancel a given selection. After either one of those two
- * former actions, the file selector will issue its @c "done" smart
- * callback.
+ * @warning The item to be removed from @p obj will be found via
+ * its item data pointer, and not by an #Elm_Index_Item handle.
*
- * There's a text entry on it, too, showing the name of the current
- * selection. There's the possibility of making it editable, so it
- * is useful on file saving dialogs on applications, where one
- * gives a file name to save contents to, in a given directory in
- * the system. This custom file name will be reported on the @c
- * "done" smart callback (explained in sequence).
+ * @ingroup Index
+ */
+ EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Find a given index widget's item, <b>using item data</b>.
*
- * Finally, it has a view to display file system items into in two
- * possible forms:
- * - list
- * - grid
+ * @param obj The index object
+ * @param item The item data pointed to by the desired index item
+ * @return The index item handle, if found, or @c NULL otherwise
*
- * If Elementary is built with support of the Ethumb thumbnailing
- * library, the second form of view will display preview thumbnails
- * of files which it supports.
+ * @ingroup Index
+ */
+ EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
+
+ /**
+ * Removes @b all items from a given index widget.
*
- * Smart callbacks one can register to:
+ * @param obj The index object.
*
- * - @c "selected" - the user has clicked on a file (when not in
- * folders-only mode) or directory (when in folders-only mode)
- * - @c "directory,open" - the list has been populated with new
- * content (@c event_info is a pointer to the directory's
- * path, a @b stringshared string)
- * - @c "done" - the user has clicked on the "ok" or "cancel"
- * buttons (@c event_info is a pointer to the selection's
- * path, a @b stringshared string)
+ * If deletion callbacks are set, via elm_index_item_del_cb_set(),
+ * that callback function will be called for each item in @p obj.
*
- * Here is an example on its usage:
- * @li @ref fileselector_example
+ * @ingroup Index
*/
+ EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @addtogroup Fileselector
- * @{
+ * Go to a given items level on a index widget
+ *
+ * @param obj The index object
+ * @param level The index level (one of @c 0 or @c 1)
+ *
+ * @ingroup Index
*/
+ EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
/**
- * Defines how a file selector widget is to layout its contents
- * (file system entries).
+ * Return the data associated with a given index widget item
+ *
+ * @param it The index widget item handle
+ * @return The data associated with @p it
+ *
+ * @see elm_index_item_data_set()
+ *
+ * @ingroup Index
*/
- typedef enum _Elm_Fileselector_Mode
- {
- ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
- ELM_FILESELECTOR_GRID, /**< layout as a grid */
- ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
- } Elm_Fileselector_Mode;
+ EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
/**
- * Add a new file selector widget to the given parent Elementary
- * (container) object
+ * Set the data associated with a given index widget item
*
- * @param parent The parent object
- * @return a new file selector widget handle or @c NULL, on errors
+ * @param it The index widget item handle
+ * @param data The new data pointer to set to @p it
*
- * This function inserts a new file selector widget on the canvas.
+ * This sets new item data on @p it.
*
- * @ingroup Fileselector
+ * @warning The old data pointer won't be touched by this function, so
+ * the user had better to free that old data himself/herself.
+ *
+ * @ingroup Index
*/
- EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
/**
- * Enable/disable the file name entry box where the user can type
- * in a name for a file, in a given file selector widget
- *
- * @param obj The file selector object
- * @param is_save @c EINA_TRUE to make the file selector a "saving
- * dialog", @c EINA_FALSE otherwise
+ * Set the function to be called when a given index widget item is freed.
*
- * Having the entry editable is useful on file saving dialogs on
- * applications, where one gives a file name to save contents to,
- * in a given directory in the system. This custom file name will
- * be reported on the @c "done" smart callback.
+ * @param it The item to set the callback on
+ * @param func The function to call on the item's deletion
*
- * @see elm_fileselector_is_save_get()
+ * When called, @p func will have both @c data and @c event_info
+ * arguments with the @p it item's data value and, naturally, the
+ * @c obj argument with a handle to the parent index widget.
*
- * @ingroup Fileselector
+ * @ingroup Index
*/
- EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
+ EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
/**
- * Get whether the given file selector is in "saving dialog" mode
- *
- * @param obj The file selector object
- * @return @c EINA_TRUE, if the file selector is in "saving dialog"
- * mode, @c EINA_FALSE otherwise (and on errors)
+ * Get the letter (string) set on a given index widget item.
*
- * @see elm_fileselector_is_save_set() for more details
+ * @param it The index item handle
+ * @return The letter string set on @p it
*
- * @ingroup Fileselector
+ * @ingroup Index
*/
- EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
/**
- * Enable/disable folder-only view for a given file selector widget
+ * @}
+ */
+
+ /**
+ * @defgroup Photocam Photocam
*
- * @param obj The file selector object
- * @param only @c EINA_TRUE to make @p obj only display
- * directories, @c EINA_FALSE to make files to be displayed in it
- * too
+ * @image html img/widget/photocam/preview-00.png
+ * @image latex img/widget/photocam/preview-00.eps
*
- * If enabled, the widget's view will only display folder items,
- * naturally.
+ * This is a widget specifically for displaying high-resolution digital
+ * camera photos giving speedy feedback (fast load), low memory footprint
+ * and zooming and panning as well as fitting logic. It is entirely focused
+ * on jpeg images, and takes advantage of properties of the jpeg format (via
+ * evas loader features in the jpeg loader).
*
- * @see elm_fileselector_folder_only_get()
+ * Signals that you can add callbacks for are:
+ * @li "clicked" - This is called when a user has clicked the photo without
+ * dragging around.
+ * @li "press" - This is called when a user has pressed down on the photo.
+ * @li "longpressed" - This is called when a user has pressed down on the
+ * photo for a long time without dragging around.
+ * @li "clicked,double" - This is called when a user has double-clicked the
+ * photo.
+ * @li "load" - Photo load begins.
+ * @li "loaded" - This is called when the image file load is complete for the
+ * first view (low resolution blurry version).
+ * @li "load,detail" - Photo detailed data load begins.
+ * @li "loaded,detail" - This is called when the image file load is complete
+ * for the detailed image data (full resolution needed).
+ * @li "zoom,start" - Zoom animation started.
+ * @li "zoom,stop" - Zoom animation stopped.
+ * @li "zoom,change" - Zoom changed when using an auto zoom mode.
+ * @li "scroll" - the content has been scrolled (moved)
+ * @li "scroll,anim,start" - scrolling animation has started
+ * @li "scroll,anim,stop" - scrolling animation has stopped
+ * @li "scroll,drag,start" - dragging the contents around has started
+ * @li "scroll,drag,stop" - dragging the contents around has stopped
*
- * @ingroup Fileselector
+ * @ref tutorial_photocam shows the API in action.
+ * @{
*/
- EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
-
/**
- * Get whether folder-only view is set for a given file selector
- * widget
- *
- * @param obj The file selector object
- * @return only @c EINA_TRUE if @p obj is only displaying
- * directories, @c EINA_FALSE if files are being displayed in it
- * too (and on errors)
- *
- * @see elm_fileselector_folder_only_get()
+ * @brief Types of zoom available.
+ */
+ typedef enum _Elm_Photocam_Zoom_Mode
+ {
+ ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
+ ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
+ ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
+ ELM_PHOTOCAM_ZOOM_MODE_LAST
+ } Elm_Photocam_Zoom_Mode;
+ /**
+ * @brief Add a new Photocam object
*
- * @ingroup Fileselector
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
*/
- EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Enable/disable the "ok" and "cancel" buttons on a given file
- * selector widget
+ * @brief Set the photo file to be shown
*
- * @param obj The file selector object
- * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
+ * @param obj The photocam object
+ * @param file The photo file
+ * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
*
- * @note A file selector without those buttons will never emit the
- * @c "done" smart event, and is only usable if one is just hooking
- * to the other two events.
+ * This sets (and shows) the specified file (with a relative or absolute
+ * path) and will return a load error (same error that
+ * evas_object_image_load_error_get() will return). The image will change and
+ * adjust its size at this point and begin a background load process for this
+ * photo that at some time in the future will be displayed at the full
+ * quality needed.
+ */
+ EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Returns the path of the current image file
*
- * @see elm_fileselector_buttons_ok_cancel_get()
+ * @param obj The photocam object
+ * @return Returns the path
*
- * @ingroup Fileselector
+ * @see elm_photocam_file_set()
*/
- EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
-
+ EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get whether the "ok" and "cancel" buttons on a given file
- * selector widget are being shown.
- *
- * @param obj The file selector object
- * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
- * otherwise (and on errors)
+ * @brief Set the zoom level of the photo
*
- * @see elm_fileselector_buttons_ok_cancel_set() for more details
+ * @param obj The photocam object
+ * @param zoom The zoom level to set
*
- * @ingroup Fileselector
+ * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
+ * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
+ * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
+ * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
+ * 16, 32, etc.).
*/
- EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
/**
- * Enable/disable a tree view in the given file selector widget,
- * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
+ * @brief Get the zoom level of the photo
*
- * @param obj The file selector object
- * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
- * disable
+ * @param obj The photocam object
+ * @return The current zoom level
*
- * In a tree view, arrows are created on the sides of directories,
- * allowing them to expand in place.
+ * This returns the current zoom level of the photocam object. Note that if
+ * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
+ * (which is the default), the zoom level may be changed at any time by the
+ * photocam object itself to account for photo size and photocam viewpoer
+ * size.
*
- * @note If it's in other mode, the changes made by this function
- * will only be visible when one switches back to "list" mode.
+ * @see elm_photocam_zoom_set()
+ * @see elm_photocam_zoom_mode_set()
+ */
+ EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the zoom mode
*
- * @see elm_fileselector_expandable_get()
+ * @param obj The photocam object
+ * @param mode The desired mode
*
- * @ingroup Fileselector
+ * This sets the zoom mode to manual or one of several automatic levels.
+ * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
+ * elm_photocam_zoom_set() and will stay at that level until changed by code
+ * or until zoom mode is changed. This is the default mode. The Automatic
+ * modes will allow the photocam object to automatically adjust zoom mode
+ * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
+ * the photo fits EXACTLY inside the scroll frame with no pixels outside this
+ * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
+ * pixels within the frame are left unfilled.
*/
- EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
/**
- * Get whether tree view is enabled for the given file selector
- * widget
+ * @brief Get the zoom mode
*
- * @param obj The file selector object
- * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
- * otherwise (and or errors)
+ * @param obj The photocam object
+ * @return The current zoom mode
*
- * @see elm_fileselector_expandable_set() for more details
+ * This gets the current zoom mode of the photocam object.
*
- * @ingroup Fileselector
+ * @see elm_photocam_zoom_mode_set()
*/
- EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set, programmatically, the @b directory that a given file
- * selector widget will display contents from
+ * @brief Get the current image pixel width and height
*
- * @param obj The file selector object
- * @param path The path to display in @p obj
+ * @param obj The photocam object
+ * @param w A pointer to the width return
+ * @param h A pointer to the height return
*
- * This will change the @b directory that @p obj is displaying. It
- * will also clear the text entry area on the @p obj object, which
- * displays select files' names.
+ * This gets the current photo pixel width and height (for the original).
+ * The size will be returned in the integers @p w and @p h that are pointed
+ * to.
+ */
+ EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the area of the image that is currently shown
*
- * @see elm_fileselector_path_get()
+ * @param obj
+ * @param x A pointer to the X-coordinate of region
+ * @param y A pointer to the Y-coordinate of region
+ * @param w A pointer to the width
+ * @param h A pointer to the height
*
- * @ingroup Fileselector
+ * @see elm_photocam_image_region_show()
+ * @see elm_photocam_image_region_bring_in()
*/
- EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
/**
- * Get the parent directory's path that a given file selector
- * widget is displaying
- *
- * @param obj The file selector object
- * @return The (full) path of the directory the file selector is
- * displaying, a @b stringshared string
+ * @brief Set the viewed portion of the image
*
- * @see elm_fileselector_path_set()
+ * @param obj The photocam object
+ * @param x X-coordinate of region in image original pixels
+ * @param y Y-coordinate of region in image original pixels
+ * @param w Width of region in image original pixels
+ * @param h Height of region in image original pixels
*
- * @ingroup Fileselector
+ * This shows the region of the image without using animation.
*/
- EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
/**
- * Set, programmatically, the currently selected file/directory in
- * the given file selector widget
- *
- * @param obj The file selector object
- * @param path The (full) path to a file or directory
- * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
- * latter case occurs if the directory or file pointed to do not
- * exist.
+ * @brief Bring in the viewed portion of the image
*
- * @see elm_fileselector_selected_get()
+ * @param obj The photocam object
+ * @param x X-coordinate of region in image original pixels
+ * @param y Y-coordinate of region in image original pixels
+ * @param w Width of region in image original pixels
+ * @param h Height of region in image original pixels
*
- * @ingroup Fileselector
+ * This shows the region of the image using animation.
*/
- EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
/**
- * Get the currently selected item's (full) path, in the given file
- * selector widget
- *
- * @param obj The file selector object
- * @return The absolute path of the selected item, a @b
- * stringshared string
- *
- * @note Custom editions on @p obj object's text entry, if made,
- * will appear on the return string of this function, naturally.
+ * @brief Set the paused state for photocam
*
- * @see elm_fileselector_selected_set() for more details
+ * @param obj The photocam object
+ * @param paused The pause state to set
*
- * @ingroup Fileselector
+ * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
+ * photocam. The default is off. This will stop zooming using animation on
+ * zoom levels changes and change instantly. This will stop any existing
+ * animations that are running.
*/
- EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
/**
- * Set the mode in which a given file selector widget will display
- * (layout) file system entries in its view
+ * @brief Get the paused state for photocam
*
- * @param obj The file selector object
- * @param mode The mode of the fileselector, being it one of
- * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
- * first one, naturally, will display the files in a list. The
- * latter will make the widget to display its entries in a grid
- * form.
+ * @param obj The photocam object
+ * @return The current paused state
*
- * @note By using elm_fileselector_expandable_set(), the user may
- * trigger a tree view for that list.
+ * This gets the current paused state for the photocam object.
*
- * @note If Elementary is built with support of the Ethumb
- * thumbnailing library, the second form of view will display
- * preview thumbnails of files which it supports. You must have
- * elm_need_ethumb() called in your Elementary for thumbnailing to
- * work, though.
+ * @see elm_photocam_paused_set()
+ */
+ EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the internal low-res image used for photocam
*
- * @see elm_fileselector_expandable_set().
- * @see elm_fileselector_mode_get().
+ * @param obj The photocam object
+ * @return The internal image object handle, or NULL if none exists
*
- * @ingroup Fileselector
+ * This gets the internal image object inside photocam. Do not modify it. It
+ * is for inspection only, and hooking callbacks to. Nothing else. It may be
+ * deleted at any time as well.
*/
- EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
-
+ EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the mode in which a given file selector widget is displaying
- * (layouting) file system entries in its view
+ * @brief Set the photocam scrolling bouncing.
*
- * @param obj The fileselector object
- * @return The mode in which the fileselector is at
+ * @param obj The photocam object
+ * @param h_bounce bouncing for horizontal
+ * @param v_bounce bouncing for vertical
+ */
+ EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get the photocam scrolling bouncing.
*
- * @see elm_fileselector_mode_set() for more details
+ * @param obj The photocam object
+ * @param h_bounce bouncing for horizontal
+ * @param v_bounce bouncing for vertical
*
- * @ingroup Fileselector
+ * @see elm_photocam_bounce_set()
*/
- EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
+ EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
/**
* @}
*/
/**
- * @defgroup Progressbar Progress bar
+ * @defgroup Map Map
+ * @ingroup Elementary
*
- * The progress bar is a widget for visually representing the
- * progress status of a given job/task.
+ * @image html img/widget/map/preview-00.png
+ * @image latex img/widget/map/preview-00.eps
*
- * A progress bar may be horizontal or vertical. It may display an
- * icon besides it, as well as primary and @b units labels. The
- * former is meant to label the widget as a whole, while the
- * latter, which is formatted with floating point values (and thus
- * accepts a <c>printf</c>-style format string, like <c>"%1.2f
- * units"</c>), is meant to label the widget's <b>progress
- * value</b>. Label, icon and unit strings/objects are @b optional
- * for progress bars.
+ * This is a widget specifically for displaying a map. It uses basically
+ * OpenStreetMap provider http://www.openstreetmap.org/,
+ * but custom providers can be added.
*
- * A progress bar may be @b inverted, in which state it gets its
- * values inverted, with high values being on the left or top and
- * low values on the right or bottom, as opposed to normally have
- * the low values on the former and high values on the latter,
- * respectively, for horizontal and vertical modes.
+ * It supports some basic but yet nice features:
+ * @li zoom and scroll
+ * @li markers with content to be displayed when user clicks over it
+ * @li group of markers
+ * @li routes
*
- * The @b span of the progress, as set by
- * elm_progressbar_span_size_set(), is its length (horizontally or
- * vertically), unless one puts size hints on the widget to expand
- * on desired directions, by any container. That length will be
- * scaled by the object or applications scaling factor. At any
- * point code can query the progress bar for its value with
- * elm_progressbar_value_get().
+ * Smart callbacks one can listen to:
*
- * Available widget styles for progress bars:
+ * - "clicked" - This is called when a user has clicked the map without
+ * dragging around.
+ * - "press" - This is called when a user has pressed down on the map.
+ * - "longpressed" - This is called when a user has pressed down on the map
+ * for a long time without dragging around.
+ * - "clicked,double" - This is called when a user has double-clicked
+ * the map.
+ * - "load,detail" - Map detailed data load begins.
+ * - "loaded,detail" - This is called when all currently visible parts of
+ * the map are loaded.
+ * - "zoom,start" - Zoom animation started.
+ * - "zoom,stop" - Zoom animation stopped.
+ * - "zoom,change" - Zoom changed when using an auto zoom mode.
+ * - "scroll" - the content has been scrolled (moved).
+ * - "scroll,anim,start" - scrolling animation has started.
+ * - "scroll,anim,stop" - scrolling animation has stopped.
+ * - "scroll,drag,start" - dragging the contents around has started.
+ * - "scroll,drag,stop" - dragging the contents around has stopped.
+ * - "downloaded" - This is called when all currently required map images
+ * are downloaded.
+ * - "route,load" - This is called when route request begins.
+ * - "route,loaded" - This is called when route request ends.
+ * - "name,load" - This is called when name request begins.
+ * - "name,loaded- This is called when name request ends.
+ *
+ * Available style for map widget:
* - @c "default"
- * - @c "wheel" (simple style, no text, no progression, only
- * "pulse" effect is available)
- *
- * Here is an example on its usage:
- * @li @ref progressbar_example
- */
-
- /**
- * Add a new progress bar widget to the given parent Elementary
- * (container) object
*
- * @param parent The parent object
- * @return a new progress bar widget handle or @c NULL, on errors
+ * Available style for markers:
+ * - @c "radio"
+ * - @c "radio2"
+ * - @c "empty"
*
- * This function inserts a new progress bar widget on the canvas.
+ * Available style for marker bubble:
+ * - @c "default"
*
- * @ingroup Progressbar
+ * List of examples:
+ * @li @ref map_example_01
+ * @li @ref map_example_02
+ * @li @ref map_example_03
*/
- EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Set whether a given progress bar widget is at "pulsing mode" or
- * not.
- *
- * @param obj The progress bar object
- * @param pulse @c EINA_TRUE to put @obj in pulsing mode,
- * @c EINA_FALSE to put it back to its default one
- *
- * By default, progress bars will display values from the low to
- * high value boundaries. There are, though, contexts in which the
- * state of progression of a given task is @b unknown. For those,
- * one can set a progress bar widget to a "pulsing state", to give
- * the user an idea that some computation is being held, but
- * without exact progress values. In the default theme it will
- * animate its bar with the contents filling in constantly and back
- * to non-filled, in a loop. To start and stop this pulsing
- * animation, one has to explicitly call elm_progressbar_pulse().
- *
- * @see elm_progressbar_pulse_get()
- * @see elm_progressbar_pulse()
- *
- * @ingroup Progressbar
+ * @addtogroup Map
+ * @{
*/
- EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
/**
- * Get whether a given progress bar widget is at "pulsing mode" or
- * not.
+ * @enum _Elm_Map_Zoom_Mode
+ * @typedef Elm_Map_Zoom_Mode
*
- * @param obj The progress bar object
- * @return @c EINA_TRUE, if @obj is in pulsing mode, @c EINA_FALSE
- * if it's in the default one (and on errors)
+ * Set map's zoom behavior. It can be set to manual or automatic.
*
- * @ingroup Progressbar
- */
- EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /**
- * Start/stop a given progress bar "pulsing" animation, if its
- * under that mode
+ * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
*
- * @param obj The progress bar object
- * @param state @c EINA_TRUE, to @b start the pulsing animation,
- * @c EINA_FALSE to @b stop it
+ * Values <b> don't </b> work as bitmask, only one can be choosen.
*
- * @note This call won't do anything if @p obj is not under "pulsing mode".
+ * @note Valid sizes are 2^zoom, consequently the map may be smaller
+ * than the scroller view.
*
- * @see elm_progressbar_pulse_set() for more details.
+ * @see elm_map_zoom_mode_set()
+ * @see elm_map_zoom_mode_get()
*
- * @ingroup Progressbar
+ * @ingroup Map
*/
- EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Map_Zoom_Mode
+ {
+ ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
+ ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
+ ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
+ ELM_MAP_ZOOM_MODE_LAST
+ } Elm_Map_Zoom_Mode;
/**
- * Set the progress value (in percentage) on a given progress bar
- * widget
- *
- * @param obj The progress bar object
- * @param val The progress value (@b must be between @c 0.0 and @c
- * 1.0)
+ * @enum _Elm_Map_Route_Sources
+ * @typedef Elm_Map_Route_Sources
*
- * Use this call to set progress bar levels.
+ * Set route service to be used. By default used source is
+ * #ELM_MAP_ROUTE_SOURCE_YOURS.
*
- * @note If you passes a value out of the specified range for @p
- * val, it will be interpreted as the @b closest of the @b boundary
- * values in the range.
+ * @see elm_map_route_source_set()
+ * @see elm_map_route_source_get()
*
- * @ingroup Progressbar
+ * @ingroup Map
*/
- EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Map_Route_Sources
+ {
+ ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
+ ELM_MAP_ROUTE_SOURCE_MONAV, /**< MoNav offers exact routing without heuristic assumptions. Its routing core is based on Contraction Hierarchies. It's not working with Map yet. */
+ ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
+ ELM_MAP_ROUTE_SOURCE_LAST
+ } Elm_Map_Route_Sources;
- /**
- * Get the progress value (in percentage) on a given progress bar
- * widget
- *
- * @param obj The progress bar object
- * @return The value of the progressbar
- *
- * @see elm_progressbar_value_set() for more details
- *
- * @ingroup Progressbar
- */
- EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Map_Name_Sources
+ {
+ ELM_MAP_NAME_SOURCE_NOMINATIM,
+ ELM_MAP_NAME_SOURCE_LAST
+ } Elm_Map_Name_Sources;
/**
- * Set the label of a given progress bar widget
- *
- * @param obj The progress bar object
- * @param label The text label string, in UTF-8
+ * @enum _Elm_Map_Route_Type
+ * @typedef Elm_Map_Route_Type
*
- * @ingroup Progressbar
- * @deprecated use elm_object_text_set() instead.
- */
- EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
-
- /**
- * Get the label of a given progress bar widget
+ * Set type of transport used on route.
*
- * @param obj The progressbar object
- * @return The text label string, in UTF-8
+ * @see elm_map_route_add()
*
- * @ingroup Progressbar
- * @deprecated use elm_object_text_set() instead.
+ * @ingroup Map
*/
- EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Map_Route_Type
+ {
+ ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
+ ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
+ ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
+ ELM_MAP_ROUTE_TYPE_LAST
+ } Elm_Map_Route_Type;
/**
- * Set the icon object of a given progress bar widget
- *
- * @param obj The progress bar object
- * @param icon The icon object
- *
- * Use this call to decorate @p obj with an icon next to it.
+ * @enum _Elm_Map_Route_Method
+ * @typedef Elm_Map_Route_Method
*
- * @note Once the icon object is set, a previously set one will be
- * deleted. If you want to keep that old content object, use the
- * elm_progressbar_icon_unset() function.
+ * Set the routing method, what should be priorized, time or distance.
*
- * @see elm_progressbar_icon_get()
+ * @see elm_map_route_add()
*
- * @ingroup Progressbar
+ * @ingroup Map
*/
- EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+ typedef enum _Elm_Map_Route_Method
+ {
+ ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
+ ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
+ ELM_MAP_ROUTE_METHOD_LAST
+ } Elm_Map_Route_Method;
+
+ typedef enum _Elm_Map_Name_Method
+ {
+ ELM_MAP_NAME_METHOD_SEARCH,
+ ELM_MAP_NAME_METHOD_REVERSE,
+ ELM_MAP_NAME_METHOD_LAST
+ } Elm_Map_Name_Method;
+
+ typedef struct _Elm_Map_Marker Elm_Map_Marker; /**< A marker to be shown in a specific point of the map. Can be created with elm_map_marker_add() and deleted with elm_map_marker_remove(). */
+ typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class; /**< Each marker must be associated to a class. It's required to add a mark. The class defines the style of the marker when a marker is displayed alone (not grouped). A new class can be created with elm_map_marker_class_new(). */
+ typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class; /**< Each marker must be associated to a group class. It's required to add a mark. The group class defines the style of the marker when a marker is grouped to other markers. Markers with the same group are grouped if they are close. A new group class can be created with elm_map_marker_group_class_new(). */
+ typedef struct _Elm_Map_Route Elm_Map_Route; /**< A route to be shown in the map. Can be created with elm_map_route_add() and deleted with elm_map_route_remove(). */
+ typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
+ typedef struct _Elm_Map_Track Elm_Map_Track;
+
+ typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Bubble content fetching class function for marker classes. When the user click on a marker, a bubble is displayed with a content. */
+ typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
+ typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
+ typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
+
+ typedef char *(*ElmMapModuleSourceFunc) (void);
+ typedef int (*ElmMapModuleZoomMinFunc) (void);
+ typedef int (*ElmMapModuleZoomMaxFunc) (void);
+ typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
+ typedef int (*ElmMapModuleRouteSourceFunc) (void);
+ typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
+ typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
+ typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
+ typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
/**
- * Retrieve the icon object set for a given progress bar widget
+ * Add a new map widget to the given parent Elementary (container) object.
*
- * @param obj The progress bar object
- * @return The icon object's handle, if @p obj had one set, or @c NULL,
- * otherwise (and on errors)
+ * @param parent The parent object.
+ * @return a new map widget handle or @c NULL, on errors.
*
- * @see elm_progressbar_icon_set() for more details
+ * This function inserts a new map widget on the canvas.
*
- * @ingroup Progressbar
+ * @ingroup Map
*/
- EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
- * Unset an icon set on a given progress bar widget
- *
- * @param obj The progress bar object
- * @return The icon object that was being used, if any was set, or
- * @c NULL, otherwise (and on errors)
- *
- * This call will unparent and return the icon object which was set
- * for this widget, previously, on success.
+ * Set the zoom level of the map.
*
- * @see elm_progressbar_icon_set() for more details
+ * @param obj The map object.
+ * @param zoom The zoom level to set.
*
- * @ingroup Progressbar
- */
- EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /**
- * Set the (exact) length of the bar region of a given progress bar
- * widget
+ * This sets the zoom level.
*
- * @param obj The progress bar object
- * @param size The length of the progress bar's bar region
+ * It will respect limits defined by elm_map_source_zoom_min_set() and
+ * elm_map_source_zoom_max_set().
*
- * This sets the minimum width (when in horizontal mode) or height
- * (when in vertical mode) of the actual bar area of the progress
- * bar @p obj. This in turn affects the object's minimum size. Use
- * this when you're not setting other size hints expanding on the
- * given direction (like weight and alignment hints) and you would
- * like it to have a specific size.
+ * By default these values are 0 (world map) and 18 (maximum zoom).
*
- * @note Icon, label and unit text around @p obj will require their
- * own space, which will make @p obj to require more the @p size,
- * actually.
+ * This function should be used when zoom mode is set to
+ * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
+ * with elm_map_zoom_mode_set().
*
- * @see elm_progressbar_span_size_get()
+ * @see elm_map_zoom_mode_set().
+ * @see elm_map_zoom_get().
*
- * @ingroup Progressbar
+ * @ingroup Map
*/
- EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
/**
- * Get the length set for the bar region of a given progress bar
- * widget
+ * Get the zoom level of the map.
*
- * @param obj The progress bar object
- * @return The length of the progress bar's bar region
+ * @param obj The map object.
+ * @return The current zoom level.
*
- * If that size was not set previously, with
- * elm_progressbar_span_size_set(), this call will return @c 0.
+ * This returns the current zoom level of the map object.
*
- * @ingroup Progressbar
+ * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
+ * (which is the default), the zoom level may be changed at any time by the
+ * map object itself to account for map size and map viewport size.
+ *
+ * @see elm_map_zoom_set() for details.
+ *
+ * @ingroup Map
*/
- EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the format string for a given progress bar widget's units
- * label
+ * Set the zoom mode used by the map object.
*
- * @param obj The progress bar object
- * @param format The format string for @p obj's units label
+ * @param obj The map object.
+ * @param mode The zoom mode of the map, being it one of
+ * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
+ * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
*
- * If @c NULL is passed on @p format, it will make @p obj's units
- * area to be hidden completely. If not, it'll set the <b>format
- * string</b> for the units label's @b text. The units label is
- * provided a floating point value, so the units text is up display
- * at most one floating point falue. Note that the units label is
- * optional. Use a format string such as "%1.2f meters" for
- * example.
+ * This sets the zoom mode to manual or one of the automatic levels.
+ * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
+ * elm_map_zoom_set() and will stay at that level until changed by code
+ * or until zoom mode is changed. This is the default mode.
*
- * @note The default format string for a progress bar is an integer
- * percentage, as in @c "%.0f %%".
+ * The Automatic modes will allow the map object to automatically
+ * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
+ * adjust zoom so the map fits inside the scroll frame with no pixels
+ * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
+ * ensure no pixels within the frame are left unfilled. Do not forget that
+ * the valid sizes are 2^zoom, consequently the map may be smaller than
+ * the scroller view.
*
- * @see elm_progressbar_unit_format_get()
+ * @see elm_map_zoom_set()
*
- * @ingroup Progressbar
+ * @ingroup Map
*/
- EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
/**
- * Retrieve the format string set for a given progress bar widget's
- * units label
+ * Get the zoom mode used by the map object.
*
- * @param obj The progress bar object
- * @return The format set string for @p obj's units label or
- * @c NULL, if none was set (and on errors)
+ * @param obj The map object.
+ * @return The zoom mode of the map, being it one of
+ * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
+ * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
*
- * @see elm_progressbar_unit_format_set() for more details
+ * This function returns the current zoom mode used by the map object.
*
- * @ingroup Progressbar
+ * @see elm_map_zoom_mode_set() for more details.
+ *
+ * @ingroup Map
*/
- EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the orientation of a given progress bar widget
+ * Get the current coordinates of the map.
*
- * @param obj The progress bar object
- * @param horizontal Use @c EINA_TRUE to make @p obj to be
- * @b horizontal, @c EINA_FALSE to make it @b vertical
+ * @param obj The map object.
+ * @param lon Pointer where to store longitude.
+ * @param lat Pointer where to store latitude.
*
- * Use this function to change how your progress bar is to be
- * disposed: vertically or horizontally.
+ * This gets the current center coordinates of the map object. It can be
+ * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
*
- * @see elm_progressbar_horizontal_get()
+ * @see elm_map_geo_region_bring_in()
+ * @see elm_map_geo_region_show()
*
- * @ingroup Progressbar
+ * @ingroup Map
*/
- EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
/**
- * Retrieve the orientation of a given progress bar widget
+ * Animatedly bring in given coordinates to the center of the map.
*
- * @param obj The progress bar object
- * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
- * @c EINA_FALSE if it's @b vertical (and on errors)
+ * @param obj The map object.
+ * @param lon Longitude to center at.
+ * @param lat Latitude to center at.
*
- * @see elm_progressbar_horizontal_set() for more details
+ * This causes map to jump to the given @p lat and @p lon coordinates
+ * and show it (by scrolling) in the center of the viewport, if it is not
+ * already centered. This will use animation to do so and take a period
+ * of time to complete.
*
- * @ingroup Progressbar
+ * @see elm_map_geo_region_show() for a function to avoid animation.
+ * @see elm_map_geo_region_get()
+ *
+ * @ingroup Map
*/
- EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
/**
- * Invert a given progress bar widget's displaying values order
+ * Show the given coordinates at the center of the map, @b immediately.
*
- * @param obj The progress bar object
- * @param inverted Use @c EINA_TRUE to make @p obj inverted,
- * @c EINA_FALSE to bring it back to default, non-inverted values.
+ * @param obj The map object.
+ * @param lon Longitude to center at.
+ * @param lat Latitude to center at.
*
- * A progress bar may be @b inverted, in which state it gets its
- * values inverted, with high values being on the left or top and
- * low values on the right or bottom, as opposed to normally have
- * the low values on the former and high values on the latter,
- * respectively, for horizontal and vertical modes.
+ * This causes map to @b redraw its viewport's contents to the
+ * region contining the given @p lat and @p lon, that will be moved to the
+ * center of the map.
*
- * @see elm_progressbar_inverted_get()
+ * @see elm_map_geo_region_bring_in() for a function to move with animation.
+ * @see elm_map_geo_region_get()
*
- * @ingroup Progressbar
+ * @ingroup Map
*/
- EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
/**
- * Get whether a given progress bar widget's displaying values are
- * inverted or not
+ * Pause or unpause the map.
*
- * @param obj The progress bar object
- * @return @c EINA_TRUE, if @p obj has inverted values,
- * @c EINA_FALSE otherwise (and on errors)
+ * @param obj The map object.
+ * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
+ * to unpause it.
*
- * @see elm_progressbar_inverted_set() for more details
+ * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
+ * for map.
*
- * @ingroup Progressbar
- */
- EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /**
- * @defgroup Separator Separator
+ * The default is off.
*
- * @brief Separator is a very thin object used to separate other objects.
+ * This will stop zooming using animation, changing zoom levels will
+ * change instantly. This will stop any existing animations that are running.
*
- * A separator can be vertical or horizontal.
+ * @see elm_map_paused_get()
*
- * @ref tutorial_separator is a good example of how to use a separator.
- * @{
+ * @ingroup Map
*/
+ EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
+
/**
- * @brief Add a separator object to @p parent
- *
- * @param parent The parent object
+ * Get a value whether map is paused or not.
*
- * @return The separator object, or NULL upon failure
- */
- EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the horizontal mode of a separator object
+ * @param obj The map object.
+ * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
+ * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
*
- * @param obj The separator object
- * @param horizontal If true, the separator is horizontal
- */
- EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
- /**
- * @brief Get the horizontal mode of a separator object
+ * This gets the current paused state for the map object.
*
- * @param obj The separator object
- * @return If true, the separator is horizontal
+ * @see elm_map_paused_set() for details.
*
- * @see elm_separator_horizontal_set()
- */
- EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @}
+ * @ingroup Map
*/
+ EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @defgroup Spinner Spinner
- * @ingroup Elementary
+ * Set to show markers during zoom level changes or not.
*
- * @image html img/widget/spinner/preview-00.png
- * @image latex img/widget/spinner/preview-00.eps
+ * @param obj The map object.
+ * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
+ * to show them.
*
- * A spinner is a widget which allows the user to increase or decrease
- * numeric values using arrow buttons, or edit values directly, clicking
- * over it and typing the new value.
+ * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
+ * for map.
*
- * By default the spinner will not wrap and has a label
- * of "%.0f" (just showing the integer value of the double).
+ * The default is off.
*
- * A spinner has a label that is formatted with floating
- * point values and thus accepts a printf-style format string, like
- * “%1.2f units”.
+ * This will stop zooming using animation, changing zoom levels will
+ * change instantly. This will stop any existing animations that are running.
*
- * It also allows specific values to be replaced by pre-defined labels.
+ * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
+ * for the markers.
*
- * Smart callbacks one can register to:
+ * The default is off.
*
- * - "changed" - Whenever the spinner value is changed.
- * - "delay,changed" - A short time after the value is changed by the user.
- * This will be called only when the user stops dragging for a very short
- * period or when they release their finger/mouse, so it avoids possibly
- * expensive reactions to the value change.
+ * Enabling it will force the map to stop displaying the markers during
+ * zoom level changes. Set to on if you have a large number of markers.
*
- * Available styles for it:
- * - @c "default";
- * - @c "vertical": up/down buttons at the right side and text left aligned.
+ * @see elm_map_paused_markers_get()
*
- * Here is an example on its usage:
- * @ref spinner_example
- */
-
- /**
- * @addtogroup Spinner
- * @{
+ * @ingroup Map
*/
+ EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
/**
- * Add a new spinner widget to the given parent Elementary
- * (container) object.
+ * Get a value whether markers will be displayed on zoom level changes or not
*
- * @param parent The parent object.
- * @return a new spinner widget handle or @c NULL, on errors.
+ * @param obj The map object.
+ * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
+ * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
*
- * This function inserts a new spinner widget on the canvas.
+ * This gets the current markers paused state for the map object.
*
- * @ingroup Spinner
+ * @see elm_map_paused_markers_set() for details.
*
+ * @ingroup Map
*/
- EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the format string of the displayed label.
- *
- * @param obj The spinner object.
- * @param fmt The format string for the label display.
- *
- * If @c NULL, this sets the format to "%.0f". If not it sets the format
- * string for the label text. The label text is provided a floating point
- * value, so the label text can display up to 1 floating point value.
- * Note that this is optional.
- *
- * Use a format string such as "%1.2f meters" for example, and it will
- * display values like: "3.14 meters" for a value equal to 3.14159.
+ * Get the information of downloading status.
*
- * Default is "%0.f".
+ * @param obj The map object.
+ * @param try_num Pointer where to store number of tiles being downloaded.
+ * @param finish_num Pointer where to store number of tiles successfully
+ * downloaded.
*
- * @see elm_spinner_label_format_get()
+ * This gets the current downloading status for the map object, the number
+ * of tiles being downloaded and the number of tiles already downloaded.
*
- * @ingroup Spinner
+ * @ingroup Map
*/
- EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
/**
- * Get the label format of the spinner.
+ * Convert a pixel coordinate (x,y) into a geographic coordinate
+ * (longitude, latitude).
*
- * @param obj The spinner object.
- * @return The text label format string in UTF-8.
+ * @param obj The map object.
+ * @param x the coordinate.
+ * @param y the coordinate.
+ * @param size the size in pixels of the map.
+ * The map is a square and generally his size is : pow(2.0, zoom)*256.
+ * @param lon Pointer where to store the longitude that correspond to x.
+ * @param lat Pointer where to store the latitude that correspond to y.
*
- * @see elm_spinner_label_format_set() for details.
+ * @note Origin pixel point is the top left corner of the viewport.
+ * Map zoom and size are taken on account.
*
- * @ingroup Spinner
+ * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
+ *
+ * @ingroup Map
*/
- EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ 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);
/**
- * Set the minimum and maximum values for the spinner.
- *
- * @param obj The spinner object.
- * @param min The minimum value.
- * @param max The maximum value.
- *
- * Define the allowed range of values to be selected by the user.
- *
- * If actual value is less than @p min, it will be updated to @p min. If it
- * is bigger then @p max, will be updated to @p max. Actual value can be
- * get with elm_spinner_value_get().
+ * Convert a geographic coordinate (longitude, latitude) into a pixel
+ * coordinate (x, y).
*
- * By default, min is equal to 0, and max is equal to 100.
+ * @param obj The map object.
+ * @param lon the longitude.
+ * @param lat the latitude.
+ * @param size the size in pixels of the map. The map is a square
+ * and generally his size is : pow(2.0, zoom)*256.
+ * @param x Pointer where to store the horizontal pixel coordinate that
+ * correspond to the longitude.
+ * @param y Pointer where to store the vertical pixel coordinate that
+ * correspond to the latitude.
*
- * @warning Maximum must be greater than minimum.
+ * @note Origin pixel point is the top left corner of the viewport.
+ * Map zoom and size are taken on account.
*
- * @see elm_spinner_min_max_get()
+ * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
*
- * @ingroup Spinner
+ * @ingroup Map
*/
- EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
+ 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);
/**
- * Get the minimum and maximum values of the spinner.
+ * Convert a geographic coordinate (longitude, latitude) into a name
+ * (address).
*
- * @param obj The spinner object.
- * @param min Pointer where to store the minimum value.
- * @param max Pointer where to store the maximum value.
+ * @param obj The map object.
+ * @param lon the longitude.
+ * @param lat the latitude.
+ * @return name A #Elm_Map_Name handle for this coordinate.
*
- * @note If only one value is needed, the other pointer can be passed
- * as @c NULL.
+ * To get the string for this address, elm_map_name_address_get()
+ * should be used.
*
- * @see elm_spinner_min_max_set() for details.
+ * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
*
- * @ingroup Spinner
+ * @ingroup Map
*/
- EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
+ EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
/**
- * Set the step used to increment or decrement the spinner value.
- *
- * @param obj The spinner object.
- * @param step The step value.
- *
- * This value will be incremented or decremented to the displayed value.
- * It will be incremented while the user keep right or top arrow pressed,
- * and will be decremented while the user keep left or bottom arrow pressed.
+ * Convert a name (address) into a geographic coordinate
+ * (longitude, latitude).
*
- * The interval to increment / decrement can be set with
- * elm_spinner_interval_set().
+ * @param obj The map object.
+ * @param name The address.
+ * @return name A #Elm_Map_Name handle for this address.
*
- * By default step value is equal to 1.
+ * To get the longitude and latitude, elm_map_name_region_get()
+ * should be used.
*
- * @see elm_spinner_step_get()
+ * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
*
- * @ingroup Spinner
+ * @ingroup Map
*/
- EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
+ EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
/**
- * Get the step used to increment or decrement the spinner value.
- *
- * @param obj The spinner object.
- * @return The step value.
+ * Convert a pixel coordinate into a rotated pixel coordinate.
*
- * @see elm_spinner_step_get() for more details.
+ * @param obj The map object.
+ * @param x horizontal coordinate of the point to rotate.
+ * @param y vertical coordinate of the point to rotate.
+ * @param cx rotation's center horizontal position.
+ * @param cy rotation's center vertical position.
+ * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
+ * @param xx Pointer where to store rotated x.
+ * @param yy Pointer where to store rotated y.
*
- * @ingroup Spinner
+ * @ingroup Map
*/
- EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ 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);
/**
- * Set the value the spinner displays.
+ * Add a new marker to the map object.
*
- * @param obj The spinner object.
- * @param val The value to be displayed.
+ * @param obj The map object.
+ * @param lon The longitude of the marker.
+ * @param lat The latitude of the marker.
+ * @param clas The class, to use when marker @b isn't grouped to others.
+ * @param clas_group The class group, to use when marker is grouped to others
+ * @param data The data passed to the callbacks.
*
- * Value will be presented on the label following format specified with
- * elm_spinner_format_set().
+ * @return The created marker or @c NULL upon failure.
*
- * @warning The value must to be between min and max values. This values
- * are set by elm_spinner_min_max_set().
+ * A marker will be created and shown in a specific point of the map, defined
+ * by @p lon and @p lat.
*
- * @see elm_spinner_value_get().
- * @see elm_spinner_format_set().
- * @see elm_spinner_min_max_set().
+ * It will be displayed using style defined by @p class when this marker
+ * is displayed alone (not grouped). A new class can be created with
+ * elm_map_marker_class_new().
*
- * @ingroup Spinner
- */
- EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
-
- /**
- * Get the value displayed by the spinner.
+ * If the marker is grouped to other markers, it will be displayed with
+ * style defined by @p class_group. Markers with the same group are grouped
+ * if they are close. A new group class can be created with
+ * elm_map_marker_group_class_new().
*
- * @param obj The spinner object.
- * @return The value displayed.
+ * Markers created with this method can be deleted with
+ * elm_map_marker_remove().
*
- * @see elm_spinner_value_set() for details.
+ * A marker can have associated content to be displayed by a bubble,
+ * when a user click over it, as well as an icon. These objects will
+ * be fetch using class' callback functions.
*
- * @ingroup Spinner
+ * @see elm_map_marker_class_new()
+ * @see elm_map_marker_group_class_new()
+ * @see elm_map_marker_remove()
+ *
+ * @ingroup Map
*/
- EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ 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);
/**
- * Set whether the spinner should wrap when it reaches its
- * minimum or maximum value.
+ * Set the maximum numbers of markers' content to be displayed in a group.
*
- * @param obj The spinner object.
- * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
- * disable it.
+ * @param obj The map object.
+ * @param max The maximum numbers of items displayed in a bubble.
*
- * Disabled by default. If disabled, when the user tries to increment the
- * value,
- * but displayed value plus step value is bigger than maximum value,
- * the spinner
- * won't allow it. The same happens when the user tries to decrement it,
- * but the value less step is less than minimum value.
+ * A bubble will be displayed when the user clicks over the group,
+ * and will place the content of markers that belong to this group
+ * inside it.
*
- * When wrap is enabled, in such situations it will allow these changes,
- * but will get the value that would be less than minimum and subtracts
- * from maximum. Or add the value that would be more than maximum to
- * the minimum.
+ * A group can have a long list of markers, consequently the creation
+ * of the content of the bubble can be very slow.
*
- * E.g.:
- * @li min value = 10
- * @li max value = 50
- * @li step value = 20
- * @li displayed value = 20
+ * In order to avoid this, a maximum number of items is displayed
+ * in a bubble.
*
- * When the user decrement value (using left or bottom arrow), it will
- * displays @c 40, because max - (min - (displayed - step)) is
- * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
+ * By default this number is 30.
*
- * @see elm_spinner_wrap_get().
+ * Marker with the same group class are grouped if they are close.
*
- * @ingroup Spinner
+ * @see elm_map_marker_add()
+ *
+ * @ingroup Map
*/
- EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
/**
- * Get whether the spinner should wrap when it reaches its
- * minimum or maximum value.
+ * Remove a marker from the map.
*
- * @param obj The spinner object
- * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
- * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
+ * @param marker The marker to remove.
*
- * @see elm_spinner_wrap_set() for details.
+ * @see elm_map_marker_add()
*
- * @ingroup Spinner
+ * @ingroup Map
*/
- EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
/**
- * Set whether the spinner can be directly edited by the user or not.
- *
- * @param obj The spinner object.
- * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
- * don't allow users to edit it directly.
+ * Get the current coordinates of the marker.
*
- * Spinner objects can have edition @b disabled, in which state they will
- * be changed only by arrows.
- * Useful for contexts
- * where you don't want your users to interact with it writting the value.
- * Specially
- * when using special values, the user can see real value instead
- * of special label on edition.
+ * @param marker marker.
+ * @param lat Pointer where to store the marker's latitude.
+ * @param lon Pointer where to store the marker's longitude.
*
- * It's enabled by default.
+ * These values are set when adding markers, with function
+ * elm_map_marker_add().
*
- * @see elm_spinner_editable_get()
+ * @see elm_map_marker_add()
*
- * @ingroup Spinner
+ * @ingroup Map
*/
- EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
/**
- * Get whether the spinner can be directly edited by the user or not.
+ * Animatedly bring in given marker to the center of the map.
*
- * @param obj The spinner object.
- * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
- * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
+ * @param marker The marker to center at.
*
- * @see elm_spinner_editable_set() for details.
+ * This causes map to jump to the given @p marker's coordinates
+ * and show it (by scrolling) in the center of the viewport, if it is not
+ * already centered. This will use animation to do so and take a period
+ * of time to complete.
*
- * @ingroup Spinner
+ * @see elm_map_marker_show() for a function to avoid animation.
+ * @see elm_map_marker_region_get()
+ *
+ * @ingroup Map
*/
- EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
/**
- * Set a special string to display in the place of the numerical value.
+ * Show the given marker at the center of the map, @b immediately.
*
- * @param obj The spinner object.
- * @param value The value to be replaced.
- * @param label The label to be used.
+ * @param marker The marker to center at.
*
- * It's useful for cases when a user should select an item that is
- * better indicated by a label than a value. For example, weekdays or months.
+ * This causes map to @b redraw its viewport's contents to the
+ * region contining the given @p marker's coordinates, that will be
+ * moved to the center of the map.
*
- * E.g.:
- * @code
- * sp = elm_spinner_add(win);
- * elm_spinner_min_max_set(sp, 1, 3);
- * elm_spinner_special_value_add(sp, 1, "January");
- * elm_spinner_special_value_add(sp, 2, "February");
- * elm_spinner_special_value_add(sp, 3, "March");
- * evas_object_show(sp);
- * @endcode
+ * @see elm_map_marker_bring_in() for a function to move with animation.
+ * @see elm_map_markers_list_show() if more than one marker need to be
+ * displayed.
+ * @see elm_map_marker_region_get()
*
- * @ingroup Spinner
+ * @ingroup Map
*/
- EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
/**
- * Set the interval on time updates for an user mouse button hold
- * on spinner widgets' arrows.
+ * Move and zoom the map to display a list of markers.
*
- * @param obj The spinner object.
- * @param interval The (first) interval value in seconds.
+ * @param markers A list of #Elm_Map_Marker handles.
*
- * This interval value is @b decreased while the user holds the
- * mouse pointer either incrementing or decrementing spinner's value.
+ * The map will be centered on the center point of the markers in the list.
+ * Then the map will be zoomed in order to fit the markers using the maximum
+ * zoom which allows display of all the markers.
*
- * This helps the user to get to a given value distant from the
- * current one easier/faster, as it will start to change quicker and
- * quicker on mouse button holds.
+ * @warning All the markers should belong to the same map object.
*
- * The calculation for the next change interval value, starting from
- * the one set with this call, is the previous interval divided by
- * @c 1.05, so it decreases a little bit.
+ * @see elm_map_marker_show() to show a single marker.
+ * @see elm_map_marker_bring_in()
*
- * The default starting interval value for automatic changes is
- * @c 0.85 seconds.
+ * @ingroup Map
+ */
+ EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the Evas object returned by the ElmMapMarkerGetFunc callback
*
- * @see elm_spinner_interval_get()
+ * @param marker The marker wich content should be returned.
+ * @return Return the evas object if it exists, else @c NULL.
*
- * @ingroup Spinner
+ * To set callback function #ElmMapMarkerGetFunc for the marker class,
+ * elm_map_marker_class_get_cb_set() should be used.
+ *
+ * This content is what will be inside the bubble that will be displayed
+ * when an user clicks over the marker.
+ *
+ * This returns the actual Evas object used to be placed inside
+ * the bubble. This may be @c NULL, as it may
+ * not have been created or may have been deleted, at any time, by
+ * the map. <b>Do not modify this object</b> (move, resize,
+ * show, hide, etc.), as the map is controlling it. This
+ * function is for querying, emitting custom signals or hooking
+ * lower level callbacks for events on that object. Do not delete
+ * this object under any circumstances.
+ *
+ * @ingroup Map
*/
- EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
/**
- * Get the interval on time updates for an user mouse button hold
- * on spinner widgets' arrows.
+ * Update the marker
*
- * @param obj The spinner object.
- * @return The (first) interval value, in seconds, set on it.
+ * @param marker The marker to be updated.
*
- * @see elm_spinner_interval_set() for more details.
+ * If a content is set to this marker, it will call function to delete it,
+ * #ElmMapMarkerDelFunc, and then will fetch the content again with
+ * #ElmMapMarkerGetFunc.
*
- * @ingroup Spinner
+ * These functions are set for the marker class with
+ * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
+ *
+ * @ingroup Map
*/
- EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
/**
- * @}
+ * Close all the bubbles opened by the user.
+ *
+ * @param obj The map object.
+ *
+ * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
+ * when the user clicks on a marker.
+ *
+ * This functions is set for the marker class with
+ * elm_map_marker_class_get_cb_set().
+ *
+ * @ingroup Map
*/
+ EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @defgroup Index Index
+ * Create a new group class.
*
- * @image html img/widget/index/preview-00.png
+ * @param obj The map object.
+ * @return Returns the new group class.
*
- * An index widget gives you an index for fast access to whichever
- * group of other UI items one might have. It's a list of text
- * items (usually letters, for alphabetically ordered access).
+ * Each marker must be associated to a group class. Markers in the same
+ * group are grouped if they are close.
*
- * Index widgets are by default hidden and just appear when the
- * user clicks over it's reserved area in the canvas. In its
- * default theme, it's an area one @ref Fingers "finger" wide on
- * the right side of the index widget's container.
+ * The group class defines the style of the marker when a marker is grouped
+ * to others markers. When it is alone, another class will be used.
*
- * When items on the index are selected, smart callbacks get
- * called, so that its user can make other container objects to
- * show a given area or child object depending on the index item
- * selected. You'd probably be using an index together with @ref
- * List "lists", @ref Genlist "generic lists" or @ref Gengrid
- * "general grids".
+ * A group class will need to be provided when creating a marker with
+ * elm_map_marker_add().
*
- * Smart events one can add callbacks for are:
- * - @c "changed" - When the selected index item changes. @c
- * event_info is the selected item's data pointer.
- * - @c "delay,changed" - When the selected index item changes, but
- * after a small idling period. @c event_info is the selected
- * item's data pointer.
- * - @c "selected" - When the user releases a mouse button and
- * selects an item. @c event_info is the selected item's data
- * pointer.
- * - @c "level,up" - when the user moves a finger from the first
- * level to the second level
- * - @c "level,down" - when the user moves a finger from the second
- * level to the first level
+ * Some properties and functions can be set by class, as:
+ * - style, with elm_map_group_class_style_set()
+ * - data - to be associated to the group class. It can be set using
+ * elm_map_group_class_data_set().
+ * - min zoom to display markers, set with
+ * elm_map_group_class_zoom_displayed_set().
+ * - max zoom to group markers, set using
+ * elm_map_group_class_zoom_grouped_set().
+ * - visibility - set if markers will be visible or not, set with
+ * elm_map_group_class_hide_set().
+ * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
+ * It can be set using elm_map_group_class_icon_cb_set().
*
- * The @c "delay,changed" event is so that it'll wait a small time
- * before actually reporting those events and, moreover, just the
- * last event happening on those time frames will actually be
- * reported.
+ * @see elm_map_marker_add()
+ * @see elm_map_group_class_style_set()
+ * @see elm_map_group_class_data_set()
+ * @see elm_map_group_class_zoom_displayed_set()
+ * @see elm_map_group_class_zoom_grouped_set()
+ * @see elm_map_group_class_hide_set()
+ * @see elm_map_group_class_icon_cb_set()
*
- * Here are some examples on its usage:
- * @li @ref index_example_01
- * @li @ref index_example_02
+ * @ingroup Map
*/
+ EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @addtogroup Index
- * @{
+ * Set the marker's style of a group class.
+ *
+ * @param clas The group class.
+ * @param style The style to be used by markers.
+ *
+ * Each marker must be associated to a group class, and will use the style
+ * defined by such class when grouped to other markers.
+ *
+ * The following styles are provided by default theme:
+ * @li @c radio - blue circle
+ * @li @c radio2 - green circle
+ * @li @c empty
+ *
+ * @see elm_map_group_class_new() for more details.
+ * @see elm_map_marker_add()
+ *
+ * @ingroup Map
*/
-
- typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
+ EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
/**
- * Add a new index widget to the given parent Elementary
- * (container) object
+ * Set the icon callback function of a group class.
*
- * @param parent The parent object
- * @return a new index widget handle or @c NULL, on errors
+ * @param clas The group class.
+ * @param icon_get The callback function that will return the icon.
*
- * This function inserts a new index widget on the canvas.
+ * Each marker must be associated to a group class, and it can display a
+ * custom icon. The function @p icon_get must return this icon.
*
- * @ingroup Index
+ * @see elm_map_group_class_new() for more details.
+ * @see elm_map_marker_add()
+ *
+ * @ingroup Map
*/
- EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
/**
- * Set whether a given index widget is or not visible,
- * programatically.
+ * Set the data associated to the group class.
*
- * @param obj The index object
- * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
+ * @param clas The group class.
+ * @param data The new user data.
*
- * Not to be confused with visible as in @c evas_object_show() --
- * visible with regard to the widget's auto hiding feature.
+ * This data will be passed for callback functions, like icon get callback,
+ * that can be set with elm_map_group_class_icon_cb_set().
*
- * @see elm_index_active_get()
+ * If a data was previously set, the object will lose the pointer for it,
+ * so if needs to be freed, you must do it yourself.
*
- * @ingroup Index
+ * @see elm_map_group_class_new() for more details.
+ * @see elm_map_group_class_icon_cb_set()
+ * @see elm_map_marker_add()
+ *
+ * @ingroup Map
*/
- EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
/**
- * Get whether a given index widget is currently visible or not.
+ * Set the minimum zoom from where the markers are displayed.
*
- * @param obj The index object
- * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
+ * @param clas The group class.
+ * @param zoom The minimum zoom.
*
- * @see elm_index_active_set() for more details
+ * Markers only will be displayed when the map is displayed at @p zoom
+ * or bigger.
*
- * @ingroup Index
+ * @see elm_map_group_class_new() for more details.
+ * @see elm_map_marker_add()
+ *
+ * @ingroup Map
*/
- EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
/**
- * Set the items level for a given index widget.
+ * Set the zoom from where the markers are no more grouped.
*
- * @param obj The index object.
- * @param level @c 0 or @c 1, the currently implemented levels.
+ * @param clas The group class.
+ * @param zoom The maximum zoom.
*
- * @see elm_index_item_level_get()
+ * Markers only will be grouped when the map is displayed at
+ * less than @p zoom.
*
- * @ingroup Index
+ * @see elm_map_group_class_new() for more details.
+ * @see elm_map_marker_add()
+ *
+ * @ingroup Map
*/
- EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
/**
- * Get the items level set for a given index widget.
+ * Set if the markers associated to the group class @clas are hidden or not.
*
- * @param obj The index object.
- * @return @c 0 or @c 1, which are the levels @p obj might be at.
+ * @param clas The group class.
+ * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
+ * to show them.
*
- * @see elm_index_item_level_set() for more information
+ * If @p hide is @c EINA_TRUE the markers will be hidden, but default
+ * is to show them.
*
- * @ingroup Index
+ * @ingroup Map
*/
- EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
/**
- * Returns the last selected item's data, for a given index widget.
+ * Create a new marker class.
*
- * @param obj The index object.
- * @return The item @b data associated to the last selected item on
- * @p obj (or @c NULL, on errors).
+ * @param obj The map object.
+ * @return Returns the new group class.
*
- * @warning The returned value is @b not an #Elm_Index_Item item
- * handle, but the data associated to it (see the @c item parameter
- * in elm_index_item_append(), as an example).
+ * Each marker must be associated to a class.
+ *
+ * The marker class defines the style of the marker when a marker is
+ * displayed alone, i.e., not grouped to to others markers. When grouped
+ * it will use group class style.
+ *
+ * A marker class will need to be provided when creating a marker with
+ * elm_map_marker_add().
+ *
+ * Some properties and functions can be set by class, as:
+ * - style, with elm_map_marker_class_style_set()
+ * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
+ * It can be set using elm_map_marker_class_icon_cb_set().
+ * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
+ * Set using elm_map_marker_class_get_cb_set().
+ * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
+ * Set using elm_map_marker_class_del_cb_set().
*
- * @ingroup Index
+ * @see elm_map_marker_add()
+ * @see elm_map_marker_class_style_set()
+ * @see elm_map_marker_class_icon_cb_set()
+ * @see elm_map_marker_class_get_cb_set()
+ * @see elm_map_marker_class_del_cb_set()
+ *
+ * @ingroup Map
*/
- EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
+ EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Append a new item on a given index widget.
+ * Set the marker's style of a marker class.
*
- * @param obj The index object.
- * @param letter Letter under which the item should be indexed
- * @param item The item data to set for the index's item
+ * @param clas The marker class.
+ * @param style The style to be used by markers.
*
- * Despite the most common usage of the @p letter argument is for
- * single char strings, one could use arbitrary strings as index
- * entries.
+ * Each marker must be associated to a marker class, and will use the style
+ * defined by such class when alone, i.e., @b not grouped to other markers.
*
- * @c item will be the pointer returned back on @c "changed", @c
- * "delay,changed" and @c "selected" smart events.
+ * The following styles are provided by default theme:
+ * @li @c radio
+ * @li @c radio2
+ * @li @c empty
*
- * @ingroup Index
+ * @see elm_map_marker_class_new() for more details.
+ * @see elm_map_marker_add()
+ *
+ * @ingroup Map
*/
- EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
/**
- * Prepend a new item on a given index widget.
+ * Set the icon callback function of a marker class.
*
- * @param obj The index object.
- * @param letter Letter under which the item should be indexed
- * @param item The item data to set for the index's item
+ * @param clas The marker class.
+ * @param icon_get The callback function that will return the icon.
*
- * Despite the most common usage of the @p letter argument is for
- * single char strings, one could use arbitrary strings as index
- * entries.
+ * Each marker must be associated to a marker class, and it can display a
+ * custom icon. The function @p icon_get must return this icon.
*
- * @c item will be the pointer returned back on @c "changed", @c
- * "delay,changed" and @c "selected" smart events.
+ * @see elm_map_marker_class_new() for more details.
+ * @see elm_map_marker_add()
*
- * @ingroup Index
+ * @ingroup Map
*/
- EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
/**
- * Append a new item, on a given index widget, <b>after the item
- * having @p relative as data</b>.
+ * Set the bubble content callback function of a marker class.
*
- * @param obj The index object.
- * @param letter Letter under which the item should be indexed
- * @param item The item data to set for the index's item
- * @param relative The item data of the index item to be the
- * predecessor of this new one
+ * @param clas The marker class.
+ * @param get The callback function that will return the content.
*
- * Despite the most common usage of the @p letter argument is for
- * single char strings, one could use arbitrary strings as index
- * entries.
+ * Each marker must be associated to a marker class, and it can display a
+ * a content on a bubble that opens when the user click over the marker.
+ * The function @p get must return this content object.
*
- * @c item will be the pointer returned back on @c "changed", @c
- * "delay,changed" and @c "selected" smart events.
+ * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
+ * can be used.
*
- * @note If @p relative is @c NULL or if it's not found to be data
- * set on any previous item on @p obj, this function will behave as
- * elm_index_item_append().
+ * @see elm_map_marker_class_new() for more details.
+ * @see elm_map_marker_class_del_cb_set()
+ * @see elm_map_marker_add()
*
- * @ingroup Index
+ * @ingroup Map
*/
- EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
/**
- * Prepend a new item, on a given index widget, <b>after the item
- * having @p relative as data</b>.
+ * Set the callback function used to delete bubble content of a marker class.
*
- * @param obj The index object.
- * @param letter Letter under which the item should be indexed
- * @param item The item data to set for the index's item
- * @param relative The item data of the index item to be the
- * successor of this new one
+ * @param clas The marker class.
+ * @param del The callback function that will delete the content.
*
- * Despite the most common usage of the @p letter argument is for
- * single char strings, one could use arbitrary strings as index
- * entries.
+ * Each marker must be associated to a marker class, and it can display a
+ * a content on a bubble that opens when the user click over the marker.
+ * The function to return such content can be set with
+ * elm_map_marker_class_get_cb_set().
*
- * @c item will be the pointer returned back on @c "changed", @c
- * "delay,changed" and @c "selected" smart events.
+ * If this content must be freed, a callback function need to be
+ * set for that task with this function.
*
- * @note If @p relative is @c NULL or if it's not found to be data
- * set on any previous item on @p obj, this function will behave as
- * elm_index_item_prepend().
+ * If this callback is defined it will have to delete (or not) the
+ * object inside, but if the callback is not defined the object will be
+ * destroyed with evas_object_del().
*
- * @ingroup Index
+ * @see elm_map_marker_class_new() for more details.
+ * @see elm_map_marker_class_get_cb_set()
+ * @see elm_map_marker_add()
+ *
+ * @ingroup Map
*/
- EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
/**
- * Insert a new item into the given index widget, using @p cmp_func
- * function to sort items (by item handles).
+ * Get the list of available sources.
*
- * @param obj The index object.
- * @param letter Letter under which the item should be indexed
- * @param item The item data to set for the index's item
- * @param cmp_func The comparing function to be used to sort index
- * items <b>by #Elm_Index_Item item handles</b>
- * @param cmp_data_func A @b fallback function to be called for the
- * sorting of index items <b>by item data</b>). It will be used
- * when @p cmp_func returns @c 0 (equality), which means an index
- * item with provided item data already exists. To decide which
- * data item should be pointed to by the index item in question, @p
- * cmp_data_func will be used. If @p cmp_data_func returns a
- * non-negative value, the previous index item data will be
- * replaced by the given @p item pointer. If the previous data need
- * to be freed, it should be done by the @p cmp_data_func function,
- * because all references to it will be lost. If this function is
- * not provided (@c NULL is given), index items will be @b
- * duplicated, if @p cmp_func returns @c 0.
+ * @param obj The map object.
+ * @return The source names list.
*
- * Despite the most common usage of the @p letter argument is for
- * single char strings, one could use arbitrary strings as index
- * entries.
+ * It will provide a list with all available sources, that can be set as
+ * current source with elm_map_source_name_set(), or get with
+ * elm_map_source_name_get().
*
- * @c item will be the pointer returned back on @c "changed", @c
- * "delay,changed" and @c "selected" smart events.
+ * Available sources:
+ * @li "Mapnik"
+ * @li "Osmarender"
+ * @li "CycleMap"
+ * @li "Maplint"
*
- * @ingroup Index
+ * @see elm_map_source_name_set() for more details.
+ * @see elm_map_source_name_get()
+ *
+ * @ingroup Map
*/
- 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);
+ EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Remove an item from a given index widget, <b>to be referenced by
- * it's data value</b>.
+ * Set the source of the map.
*
- * @param obj The index object
- * @param item The item's data pointer for the item to be removed
- * from @p obj
+ * @param obj The map object.
+ * @param source The source to be used.
*
- * If a deletion callback is set, via elm_index_item_del_cb_set(),
- * that callback function will be called by this one.
+ * Map widget retrieves images that composes the map from a web service.
+ * This web service can be set with this method.
*
- * @warning The item to be removed from @p obj will be found via
- * its item data pointer, and not by an #Elm_Index_Item handle.
+ * A different service can return a different maps with different
+ * information and it can use different zoom values.
*
- * @ingroup Index
- */
- EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
-
- /**
- * Find a given index widget's item, <b>using item data</b>.
+ * The @p source_name need to match one of the names provided by
+ * elm_map_source_names_get().
*
- * @param obj The index object
- * @param item The item data pointed to by the desired index item
- * @return The index item handle, if found, or @c NULL otherwise
+ * The current source can be get using elm_map_source_name_get().
*
- * @ingroup Index
+ * @see elm_map_source_names_get()
+ * @see elm_map_source_name_get()
+ *
+ *
+ * @ingroup Map
*/
- EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
/**
- * Removes @b all items from a given index widget.
+ * Get the name of currently used source.
*
- * @param obj The index object.
+ * @param obj The map object.
+ * @return Returns the name of the source in use.
*
- * If deletion callbacks are set, via elm_index_item_del_cb_set(),
- * that callback function will be called for each item in @p obj.
+ * @see elm_map_source_name_set() for more details.
*
- * @ingroup Index
+ * @ingroup Map
*/
- EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Go to a given items level on a index widget
+ * Set the source of the route service to be used by the map.
*
- * @param obj The index object
- * @param level The index level (one of @c 0 or @c 1)
+ * @param obj The map object.
+ * @param source The route service to be used, being it one of
+ * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
+ * and #ELM_MAP_ROUTE_SOURCE_ORS.
*
- * @ingroup Index
+ * Each one has its own algorithm, so the route retrieved may
+ * differ depending on the source route. Now, only the default is working.
+ *
+ * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
+ * http://www.yournavigation.org/.
+ *
+ * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
+ * assumptions. Its routing core is based on Contraction Hierarchies.
+ *
+ * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
+ *
+ * @see elm_map_route_source_get().
+ *
+ * @ingroup Map
*/
- EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
/**
- * Return the data associated with a given index widget item
+ * Get the current route source.
*
- * @param it The index widget item handle
- * @return The data associated with @p it
+ * @param obj The map object.
+ * @return The source of the route service used by the map.
*
- * @see elm_index_item_data_set()
+ * @see elm_map_route_source_set() for details.
*
- * @ingroup Index
+ * @ingroup Map
*/
- EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Set the data associated with a given index widget item
- *
- * @param it The index widget item handle
- * @param data The new data pointer to set to @p it
+ * Set the minimum zoom of the source.
*
- * This sets new item data on @p it.
+ * @param obj The map object.
+ * @param zoom New minimum zoom value to be used.
*
- * @warning The old data pointer won't be touched by this function, so
- * the user had better to free that old data himself/herself.
+ * By default, it's 0.
*
- * @ingroup Index
+ * @ingroup Map
*/
- EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
/**
- * Set the function to be called when a given index widget item is freed.
+ * Get the minimum zoom of the source.
*
- * @param it The item to set the callback on
- * @param func The function to call on the item's deletion
+ * @param obj The map object.
+ * @return Returns the minimum zoom of the source.
*
- * When called, @p func will have both @c data and @c event_info
- * arguments with the @p it item's data value and, naturally, the
- * @c obj argument with a handle to the parent index widget.
+ * @see elm_map_source_zoom_min_set() for details.
*
- * @ingroup Index
+ * @ingroup Map
*/
- EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
+ EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Get the letter (string) set on a given index widget item.
+ * Set the maximum zoom of the source.
*
- * @param it The index item handle
- * @return The letter string set on @p it
+ * @param obj The map object.
+ * @param zoom New maximum zoom value to be used.
*
- * @ingroup Index
+ * By default, it's 18.
+ *
+ * @ingroup Map
*/
- EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
/**
- * @}
+ * Get the maximum zoom of the source.
+ *
+ * @param obj The map object.
+ * @return Returns the maximum zoom of the source.
+ *
+ * @see elm_map_source_zoom_min_set() for details.
+ *
+ * @ingroup Map
*/
+ EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * @defgroup Photocam Photocam
+ * Set the user agent used by the map object to access routing services.
*
- * @image html img/widget/photocam/preview-00.png
- * @image latex img/widget/photocam/preview-00.eps
+ * @param obj The map object.
+ * @param user_agent The user agent to be used by the map.
*
- * This is a widget specifically for displaying high-resolution digital
- * camera photos giving speedy feedback (fast load), low memory footprint
- * and zooming and panning as well as fitting logic. It is entirely focused
- * on jpeg images, and takes advantage of properties of the jpeg format (via
- * evas loader features in the jpeg loader).
+ * User agent is a client application implementing a network protocol used
+ * in communications within a client–server distributed computing system
*
- * Signals that you can add callbacks for are:
- * @li "clicked" - This is called when a user has clicked the photo without
- * dragging around.
- * @li "press" - This is called when a user has pressed down on the photo.
- * @li "longpressed" - This is called when a user has pressed down on the
- * photo for a long time without dragging around.
- * @li "clicked,double" - This is called when a user has double-clicked the
- * photo.
- * @li "load" - Photo load begins.
- * @li "loaded" - This is called when the image file load is complete for the
- * first view (low resolution blurry version).
- * @li "load,detail" - Photo detailed data load begins.
- * @li "loaded,detail" - This is called when the image file load is complete
- * for the detailed image data (full resolution needed).
- * @li "zoom,start" - Zoom animation started.
- * @li "zoom,stop" - Zoom animation stopped.
- * @li "zoom,change" - Zoom changed when using an auto zoom mode.
- * @li "scroll" - the content has been scrolled (moved)
- * @li "scroll,anim,start" - scrolling animation has started
- * @li "scroll,anim,stop" - scrolling animation has stopped
- * @li "scroll,drag,start" - dragging the contents around has started
- * @li "scroll,drag,stop" - dragging the contents around has stopped
+ * The @p user_agent identification string will transmitted in a header
+ * field @c User-Agent.
*
- * @ref tutorial_photocam shows the API in action.
- * @{
- */
- /**
- * @brief Types of zoom available.
- */
- typedef enum _Elm_Photocam_Zoom_Mode
- {
- ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
- ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
- ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
- ELM_PHOTOCAM_ZOOM_MODE_LAST
- } Elm_Photocam_Zoom_Mode;
- /**
- * @brief Add a new Photocam object
+ * @see elm_map_user_agent_get()
*
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
+ * @ingroup Map
*/
- EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
+
/**
- * @brief Set the photo file to be shown
+ * Get the user agent used by the map object.
*
- * @param obj The photocam object
- * @param file The photo file
- * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
+ * @param obj The map object.
+ * @return The user agent identification string used by the map.
*
- * This sets (and shows) the specified file (with a relative or absolute
- * path) and will return a load error (same error that
- * evas_object_image_load_error_get() will return). The image will change and
- * adjust its size at this point and begin a background load process for this
- * photo that at some time in the future will be displayed at the full
- * quality needed.
+ * @see elm_map_user_agent_set() for details.
+ *
+ * @ingroup Map
*/
- EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
- * @brief Returns the path of the current image file
+ * Add a new route to the map object.
*
- * @param obj The photocam object
- * @return Returns the path
+ * @param obj The map object.
+ * @param type The type of transport to be considered when tracing a route.
+ * @param method The routing method, what should be priorized.
+ * @param flon The start longitude.
+ * @param flat The start latitude.
+ * @param tlon The destination longitude.
+ * @param tlat The destination latitude.
*
- * @see elm_photocam_file_set()
- */
- EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the zoom level of the photo
+ * @return The created route or @c NULL upon failure.
*
- * @param obj The photocam object
- * @param zoom The zoom level to set
+ * A route will be traced by point on coordinates (@p flat, @p flon)
+ * to point on coordinates (@p tlat, @p tlon), using the route service
+ * set with elm_map_route_source_set().
*
- * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
- * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
- * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
- * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
- * 16, 32, etc.).
+ * It will take @p type on consideration to define the route,
+ * depending if the user will be walking or driving, the route may vary.
+ * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
+ * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
+ *
+ * Another parameter is what the route should priorize, the minor distance
+ * or the less time to be spend on the route. So @p method should be one
+ * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
+ *
+ * Routes created with this method can be deleted with
+ * elm_map_route_remove(), colored with elm_map_route_color_set(),
+ * and distance can be get with elm_map_route_distance_get().
+ *
+ * @see elm_map_route_remove()
+ * @see elm_map_route_color_set()
+ * @see elm_map_route_distance_get()
+ * @see elm_map_route_source_set()
+ *
+ * @ingroup Map
*/
- EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
+ 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);
+
/**
- * @brief Get the zoom level of the photo
+ * Remove a route from the map.
*
- * @param obj The photocam object
- * @return The current zoom level
+ * @param route The route to remove.
*
- * This returns the current zoom level of the photocam object. Note that if
- * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
- * (which is the default), the zoom level may be changed at any time by the
- * photocam object itself to account for photo size and photocam viewpoer
- * size.
+ * @see elm_map_route_add()
*
- * @see elm_photocam_zoom_set()
- * @see elm_photocam_zoom_mode_set()
+ * @ingroup Map
*/
- EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the zoom mode
+ * Set the route color.
*
- * @param obj The photocam object
- * @param mode The desired mode
+ * @param route The route object.
+ * @param r Red channel value, from 0 to 255.
+ * @param g Green channel value, from 0 to 255.
+ * @param b Blue channel value, from 0 to 255.
+ * @param a Alpha channel value, from 0 to 255.
*
- * This sets the zoom mode to manual or one of several automatic levels.
- * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
- * elm_photocam_zoom_set() and will stay at that level until changed by code
- * or until zoom mode is changed. This is the default mode. The Automatic
- * modes will allow the photocam object to automatically adjust zoom mode
- * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
- * the photo fits EXACTLY inside the scroll frame with no pixels outside this
- * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
- * pixels within the frame are left unfilled.
+ * It uses an additive color model, so each color channel represents
+ * how much of each primary colors must to be used. 0 represents
+ * ausence of this color, so if all of the three are set to 0,
+ * the color will be black.
+ *
+ * These component values should be integers in the range 0 to 255,
+ * (single 8-bit byte).
+ *
+ * This sets the color used for the route. By default, it is set to
+ * solid red (r = 255, g = 0, b = 0, a = 255).
+ *
+ * For alpha channel, 0 represents completely transparent, and 255, opaque.
+ *
+ * @see elm_map_route_color_get()
+ *
+ * @ingroup Map
*/
- EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the zoom mode
+ * Get the route color.
*
- * @param obj The photocam object
- * @return The current zoom mode
+ * @param route The route object.
+ * @param r Pointer where to store the red channel value.
+ * @param g Pointer where to store the green channel value.
+ * @param b Pointer where to store the blue channel value.
+ * @param a Pointer where to store the alpha channel value.
*
- * This gets the current zoom mode of the photocam object.
+ * @see elm_map_route_color_set() for details.
*
- * @see elm_photocam_zoom_mode_set()
+ * @ingroup Map
*/
- EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the current image pixel width and height
+ * Get the route distance in kilometers.
*
- * @param obj The photocam object
- * @param w A pointer to the width return
- * @param h A pointer to the height return
+ * @param route The route object.
+ * @return The distance of route (unit : km).
*
- * This gets the current photo pixel width and height (for the original).
- * The size will be returned in the integers @p w and @p h that are pointed
- * to.
+ * @ingroup Map
*/
- EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
+ EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the area of the image that is currently shown
+ * Get the information of route nodes.
*
- * @param obj
- * @param x A pointer to the X-coordinate of region
- * @param y A pointer to the Y-coordinate of region
- * @param w A pointer to the width
- * @param h A pointer to the height
+ * @param route The route object.
+ * @return Returns a string with the nodes of route.
*
- * @see elm_photocam_image_region_show()
- * @see elm_photocam_image_region_bring_in()
+ * @ingroup Map
*/
- EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the viewed portion of the image
+ * Get the information of route waypoint.
*
- * @param obj The photocam object
- * @param x X-coordinate of region in image original pixels
- * @param y Y-coordinate of region in image original pixels
- * @param w Width of region in image original pixels
- * @param h Height of region in image original pixels
+ * @param route the route object.
+ * @return Returns a string with information about waypoint of route.
*
- * This shows the region of the image without using animation.
+ * @ingroup Map
*/
- EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
+
/**
- * @brief Bring in the viewed portion of the image
+ * Get the address of the name.
*
- * @param obj The photocam object
- * @param x X-coordinate of region in image original pixels
- * @param y Y-coordinate of region in image original pixels
- * @param w Width of region in image original pixels
- * @param h Height of region in image original pixels
+ * @param name The name handle.
+ * @return Returns the address string of @p name.
*
- * This shows the region of the image using animation.
+ * This gets the coordinates of the @p name, created with one of the
+ * conversion functions.
+ *
+ * @see elm_map_utils_convert_name_into_coord()
+ * @see elm_map_utils_convert_coord_into_name()
+ *
+ * @ingroup Map
*/
- EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the paused state for photocam
+ * Get the current coordinates of the name.
*
- * @param obj The photocam object
- * @param paused The pause state to set
+ * @param name The name handle.
+ * @param lat Pointer where to store the latitude.
+ * @param lon Pointer where to store The longitude.
*
- * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
- * photocam. The default is off. This will stop zooming using animation on
- * zoom levels changes and change instantly. This will stop any existing
- * animations that are running.
+ * This gets the coordinates of the @p name, created with one of the
+ * conversion functions.
+ *
+ * @see elm_map_utils_convert_name_into_coord()
+ * @see elm_map_utils_convert_coord_into_name()
+ *
+ * @ingroup Map
*/
- EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the paused state for photocam
+ * Remove a name from the map.
*
- * @param obj The photocam object
- * @return The current paused state
+ * @param name The name to remove.
*
- * This gets the current paused state for the photocam object.
+ * Basically the struct handled by @p name will be freed, so convertions
+ * between address and coordinates will be lost.
*
- * @see elm_photocam_paused_set()
+ * @see elm_map_utils_convert_name_into_coord()
+ * @see elm_map_utils_convert_coord_into_name()
+ *
+ * @ingroup Map
*/
- EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
+
/**
- * @brief Get the internal low-res image used for photocam
+ * Rotate the map.
*
- * @param obj The photocam object
- * @return The internal image object handle, or NULL if none exists
+ * @param obj The map object.
+ * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
+ * @param cx Rotation's center horizontal position.
+ * @param cy Rotation's center vertical position.
*
- * This gets the internal image object inside photocam. Do not modify it. It
- * is for inspection only, and hooking callbacks to. Nothing else. It may be
- * deleted at any time as well.
+ * @see elm_map_rotate_get()
+ *
+ * @ingroup Map
*/
- EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
+
/**
- * @brief Set the photocam scrolling bouncing.
+ * Get the rotate degree of the map
*
- * @param obj The photocam object
- * @param h_bounce bouncing for horizontal
- * @param v_bounce bouncing for vertical
+ * @param obj The map object
+ * @param degree Pointer where to store degrees from 0.0 to 360.0
+ * to rotate arount Z axis.
+ * @param cx Pointer where to store rotation's center horizontal position.
+ * @param cy Pointer where to store rotation's center vertical position.
+ *
+ * @see elm_map_rotate_set() to set map rotation.
+ *
+ * @ingroup Map
*/
- EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+ 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);
+
/**
- * @brief Get the photocam scrolling bouncing.
+ * Enable or disable mouse wheel to be used to zoom in / out the map.
*
- * @param obj The photocam object
- * @param h_bounce bouncing for horizontal
- * @param v_bounce bouncing for vertical
+ * @param obj The map object.
+ * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
+ * to enable it.
*
- * @see elm_photocam_bounce_set()
+ * Mouse wheel can be used for the user to zoom in or zoom out the map.
+ *
+ * It's disabled by default.
+ *
+ * @see elm_map_wheel_disabled_get()
+ *
+ * @ingroup Map
*/
- EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
+ EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+
/**
- * @}
+ * Get a value whether mouse wheel is enabled or not.
+ *
+ * @param obj The map object.
+ * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
+ * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
+ *
+ * Mouse wheel can be used for the user to zoom in or zoom out the map.
+ *
+ * @see elm_map_wheel_disabled_set() for details.
+ *
+ * @ingroup Map
*/
-
- /* map */
- typedef enum _Elm_Map_Zoom_Mode
- {
- ELM_MAP_ZOOM_MODE_MANUAL,
- ELM_MAP_ZOOM_MODE_AUTO_FIT,
- ELM_MAP_ZOOM_MODE_AUTO_FILL,
- ELM_MAP_ZOOM_MODE_LAST
- } Elm_Map_Zoom_Mode;
-
- typedef enum _Elm_Map_Route_Sources
- {
- ELM_MAP_ROUTE_SOURCE_YOURS,
- ELM_MAP_ROUTE_SOURCE_MONAV,
- ELM_MAP_ROUTE_SOURCE_ORS,
- ELM_MAP_ROUTE_SOURCE_LAST
- } Elm_Map_Route_Sources;
-
- typedef enum _Elm_Map_Name_Sources
- {
- ELM_MAP_NAME_SOURCE_NOMINATIM,
- ELM_MAP_NAME_SOURCE_LAST
- } Elm_Map_Name_Sources;
-
- typedef enum _Elm_Map_Route_Type
- {
- ELM_MAP_ROUTE_TYPE_MOTOCAR,
- ELM_MAP_ROUTE_TYPE_BICYCLE,
- ELM_MAP_ROUTE_TYPE_FOOT,
- ELM_MAP_ROUTE_TYPE_LAST
- } Elm_Map_Route_Type;
-
- typedef enum _Elm_Map_Route_Method
- {
- ELM_MAP_ROUTE_METHOD_FASTEST,
- ELM_MAP_ROUTE_METHOD_SHORTEST,
- ELM_MAP_ROUTE_METHOD_LAST
- } Elm_Map_Route_Method;
-
- typedef enum _Elm_Map_Name_Method
- {
- ELM_MAP_NAME_METHOD_SEARCH,
- ELM_MAP_NAME_METHOD_REVERSE,
- ELM_MAP_NAME_METHOD_LAST
- } Elm_Map_Name_Method;
-
- typedef struct _Elm_Map_Marker Elm_Map_Marker;
- typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
- typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
- typedef struct _Elm_Map_Route Elm_Map_Route;
- typedef struct _Elm_Map_Name Elm_Map_Name;
- typedef struct _Elm_Map_Track Elm_Map_Track;
-
- typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
- typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
- typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
- typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
-
- typedef char *(*ElmMapModuleSourceFunc) (void);
- typedef int (*ElmMapModuleZoomMinFunc) (void);
- typedef int (*ElmMapModuleZoomMaxFunc) (void);
- typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
- typedef int (*ElmMapModuleRouteSourceFunc) (void);
- typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
- typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
- typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
- typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
-
- EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
- EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
- EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
- EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
- EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
- EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
- EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
- 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);
- 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);
- EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
- EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
- 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);
- 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);
- EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
- EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
- EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
- EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
- EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
- EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
- EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
- EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
- EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
- EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
- EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
- EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
- EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
- EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
- EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
- EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
- EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
- EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
- EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
- EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
- EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
- EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
- EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
- EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- 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);
- EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
- EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
- EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
- EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
- EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
- EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
- EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
- EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
- EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
- EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
- 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);
- EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
#ifdef ELM_EMAP
+ /**
+ * Add a track on the map
+ *
+ * @param obj The map object.
+ * @param emap The emap route object.
+ * @return The route object. This is an elm object of type Route.
+ *
+ * @see elm_route_add() for details.
+ *
+ * @ingroup Map
+ */
EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
#endif
+
+ /**
+ * Remove a track from the map
+ *
+ * @param obj The map object.
+ * @param route The track to remove.
+ *
+ * @ingroup Map
+ */
EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
- /* smart callbacks called:
- * "clicked" - when image clicked
- * "press" - when mouse/finger held down initially on image
- * "longpressed" - when mouse/finger held for long time on image
- * "clicked,double" - when mouse/finger double-clicked
- * "load,details" - when detailed image load begins
- * "loaded,details" - when detailed image load done
- * "zoom,start" - when zooming started
- * "zoom,stop" - when zooming stopped
- * "zoom,change" - when auto zoom mode changed zoom level
- * "scroll - the content has been scrolled (moved)
- * "scroll,anim,start" - scrolling animation has started
- * "scroll,anim,stop" - scrolling animation has stopped
- * "scroll,drag,start" - dragging the contents around has started
- * "scroll,drag,stop" - dragging the contents around has stopped
+ /**
+ * @}
*/
/* Route */
EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
- * Unset the right content used for the panes..
+ * Unset the right content used for the panes.
*
* @param obj The panes object.
* @return The right content object that was being used.
* Get a value whether map is enabled or not.
*
* @param obj The mapbuf object.
- * @return The value that the enabled state is set to.
* @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
* it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
*
* @ingroup Flipselector
*/
EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
- /**
- * @}
- */
-
- /**
- * @addtogroup Animator Animator
- * @ingroup Elementary
- *
- * @brief Functions to ease creation of animations.
- *
- * elm_animator is designed to provide an easy way to create animations.
- * Creating an animation with elm_animator is as simple as setting a
- * duration, an operating callback and telling it to run the animation.
- * However that is not the full extent of elm_animator's ability, animations
- * can be paused and resumed, reversed and the animation need not be linear.
- *
- * To run an animation you must specify at least a duration and operation
- * callback, not setting any other properties will create a linear animation
- * that runs once and is not reversed.
- *
- * @ref elm_animator_example_page_01 "This" example should make all of that
- * very clear.
- *
- * @warning elm_animator is @b not a widget.
- * @{
- */
- /**
- * @brief Type of curve desired for animation.
- *
- * The speed in which an animation happens doesn't have to be linear, some
- * animations will look better if they're accelerating or decelerating, so
- * elm_animator provides four options in this regard:
- *
- * @image html elm_animator_curve_style.png
- * @image latex elm_animator_curve_style.eps width=\textwidth
- * As can be seen in the image the speed of the animation will be:
- * @li ELM_ANIMATOR_CURVE_LINEAR constant
- * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
- * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
- * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
- */
- typedef enum
- {
- ELM_ANIMATOR_CURVE_LINEAR,
- ELM_ANIMATOR_CURVE_IN_OUT,
- ELM_ANIMATOR_CURVE_IN,
- ELM_ANIMATOR_CURVE_OUT
- } Elm_Animator_Curve_Style;
- typedef struct _Elm_Animator Elm_Animator;
- /**
- * Called back per loop of an elementary animators cycle
- * @param data user-data given to elm_animator_operation_callback_set()
- * @param animator the animator being run
- * @param double the position in the animation
- */
- typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
- /**
- * Called back when an elementary animator finishes
- * @param data user-data given to elm_animator_completion_callback_set()
- */
- typedef void (*Elm_Animator_Completion_Cb) (void *data);
-
- /**
- * @brief Create a new animator.
- *
- * @param[in] parent Parent object
- *
- * The @a parent argument can be set to NULL for no parent. If a parent is set
- * there is no need to call elm_animator_del(), when the parent is deleted it
- * will delete the animator.
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
- /**
- * Deletes the animator freeing any resources it used. If the animator was
- * created with a NULL parent this must be called, otherwise it will be
- * automatically called when the parent is deleted.
- *
- * @param[in] animator Animator object
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
- /**
- * Set the duration of the animation.
- *
- * @param[in] animator Animator object
- * @param[in] duration Duration in second
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
- /**
- * @brief Set the callback function for animator operation.
- *
- * @param[in] animator Animator object
- * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
- * @param[in] data Callback function user argument
- *
- * The @p func callback will be called with a frame value in range [0, 1] which
- * indicates how far along the animation should be. It is the job of @p func to
- * actually change the state of any object(or objects) that are being animated.
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
- /**
- * Set the callback function for the when the animation ends.
- *
- * @param[in] animator Animator object
- * @param[in] func Callback function pointe
- * @param[in] data Callback function user argument
- *
- * @warning @a func will not be executed if elm_animator_stop() is called.
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
- /**
- * @brief Stop animator.
- *
- * @param[in] animator Animator object
- *
- * If called before elm_animator_animate() it does nothing. If there is an
- * animation in progress the animation will be stopped(the operation callback
- * will not be executed again) and it can't be restarted using
- * elm_animator_resume().
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
- /**
- * Set the animator repeat count.
- *
- * @param[in] animator Animator object
- * @param[in] repeat_cnt Repeat count
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
- /**
- * @brief Start animation.
- *
- * @param[in] animator Animator object
- *
- * This function starts the animation if the nescessary properties(duration
- * and operation callback) have been set. Once started the animation will
- * run until complete or elm_animator_stop() is called.
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
- /**
- * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
- *
- * @param[in] animator Animator object
- * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
- /**
- * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
- *
- * @param[in] animator Animator object
- * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
- /**
- * @brief Sets wether the animation should be automatically reversed.
- *
- * @param[in] animator Animator object
- * @param[in] reverse Reverse or not
- *
- * This controls wether the animation will be run on reverse imediately after
- * running forward. When this is set together with repetition the animation
- * will run in reverse once for each time it ran forward.@n
- * Runnin an animation in reverse is accomplished by calling the operation
- * callback with a frame value starting at 1 and diminshing until 0.
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
- /**
- * Gets wether the animation will automatically reversed
- *
- * @param[in] animator Animator object
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
- /**
- * Gets the status for the animator operation. The status of the animator @b
- * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
- * only informs if the animation was started and has not ended(either normally
- * or through elm_animator_stop()).
- *
- * @param[in] animator Animator object
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
- /**
- * Gets how many times the animation will be repeated
- *
- * @param[in] animator Animator object
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
- /**
- * Pause the animator.
- *
- * @param[in] animator Animator object
- *
- * This causes the animation to be temporarily stopped(the operation callback
- * will not be called). If the animation is not yet running this is a no-op.
- * Once an animation has been paused with this function it can be resumed
- * using elm_animator_resume().
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
- /**
- * @brief Resumes the animator.
- *
- * @param[in] animator Animator object
- *
- * Resumes an animation that was paused using elm_animator_pause(), after
- * calling this function calls to the operation callback will happen
- * normally. If an animation is stopped by means of elm_animator_stop it
- * @b can't be restarted with this function.@n
- *
- * @warning When an animation is resumed it doesn't start from where it was paused, it
- * will go to where it would have been if it had not been paused. If an
- * animation with a duration of 3 seconds is paused after 1 second for 1 second
- * it will resume as if it had ben animating for 2 seconds, the operating
- * callback will be called with a frame value of aproximately 2/3.
- * @deprecated Use @ref Transit instead.
- */
- EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
/**
* @}
*/
/**
- * @defgroup Calendar Calendar
- * @ingroup Elementary
- *
- * @image html img/widget/calendar/preview-00.png
- * @image latex img/widget/calendar/preview-00.eps
- *
- * A calendar is a widget that displays a regular calendar, one
- * month at a time, to the user, and can allows the user to select a date.
- *
- * It has support to adding check marks (holidays and checks are supported
- * by default theme).
- *
- * Weekday names and the function used to format month and year to
- * be displayed can be set, giving more flexibility to this widget.
- *
- * Smart callbacks one can register to:
- * - "changed" - emitted when the user selects a day or changes the
- * displayed month, what actually changes the selected day as well.
- *
- * Available styles for it:
- * - @c "default"
- *
- * List of examples:
- * @li @ref calendar_example_01
- * @li @ref calendar_example_02
- * @li @ref calendar_example_03
- * @li @ref calendar_example_04
- * @li @ref calendar_example_05
- * @li @ref calendar_example_06
- */
-
- /**
* @addtogroup Calendar
* @{
*/
* there will be marks every week after this date. Marks will be displayed
* at 13th, 20th, 27th, 3rd June ...
*
- * Values don't work as bitmaks, only one can be choosen.
+ * Values don't work as bitmask, only one can be choosen.
*
* @see elm_calendar_mark_add()
*
* Set weekdays names to be displayed by the calendar.
*
* @param obj The calendar object.
- * @param weedays Array of seven strings to be used as weekday names.
+ * @param weekdays Array of seven strings to be used as weekday names.
* @warning It must have 7 elements, or it will access invalid memory.
* @warning The strings must be NULL terminated ('@\0').
*
* date in the calendar.
* @param repeat Repeat the event following this periodicity. Can be a unique
* mark (that don't repeat), daily, weekly, monthly or annually.
- * @return The created mark or @NULL upon failure.
+ * @return The created mark or @p NULL upon failure.
*
* Add a mark that will be drawn in the calendar respecting the insertion
* time and periodicity. It will emit the type as signal to the widget theme.
EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
/**
+ * Get the number of items in the diskselector object.
+ *
+ * @param obj The diskselector object.
+ *
+ * @ingroup Diskselector
+ */
+ EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
* Set bouncing behaviour when the scrolled content reaches an edge.
*
* Tell the internal scroller object whether it should bounce or not
* @param policy_v Vertical scrollbar policy.
*
* This sets the scrollbar visibility policy for the given scroller.
- * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
+ * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
* is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
* it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
* This applies respectively for the horizontal and vertical scrollbars.
* @param it The diskselector item
* @return The data associated to @p it
*
- * The return value is a pointer to data associated to @item when it was
+ * The return value is a pointer to data associated to @p item when it was
* created, with function elm_diskselector_item_append(). If no data
* was passed as argument, it will return @c NULL.
*
* @param it The diskselector item
* @return The icon associated to @p it
*
- * The return value is a pointer to the icon associated to @item when it was
+ * The return value is a pointer to the icon associated to @p item when it was
* created, with function elm_diskselector_item_append(), or later
* with function elm_diskselector_item_icon_set. If no icon
* was passed as argument, it will return @c NULL.
* elm_diskselector_side_label_lenght_set(), or "Janu", if this property
* is set to 4.
*
- * When this @item is selected, the entire label will be displayed,
+ * When this @p item is selected, the entire label will be displayed,
* except for width restrictions.
* In this case label will be cropped and "..." will be concatenated,
* but only for display purposes. It will keep the entire string, so
* @param it The item of diskselector.
* @return The label of item.
*
- * The return value is a pointer to the label associated to @item when it was
+ * The return value is a pointer to the label associated to @p item when it was
* created, with function elm_diskselector_item_append(), or later
* with function elm_diskselector_item_label_set. If no label
* was passed as argument, it will return @c NULL.
* @return The item before @p item, or @c NULL if none or on failure.
*
* The list of items follows append order. So it will return item appended
- * just before @item and that wasn't deleted.
+ * just before @p item and that wasn't deleted.
*
* If it is the first item, @c NULL will be returned.
* First item can be get by elm_diskselector_first_item_get().
* @return The item after @p item, or @c NULL if none or on failure.
*
* The list of items follows append order. So it will return item appended
- * just after @item and that wasn't deleted.
+ * just after @p item and that wasn't deleted.
*
* If it is the last item, @c NULL will be returned.
* Last item can be get by elm_diskselector_last_item_get().
* @param func the function used to create the tooltip contents.
* @param data what to provide to @a func as callback data/context.
* @param del_cb called when data is not needed anymore, either when
- * another callback replaces @func, the tooltip is unset with
+ * another callback replaces @p func, the tooltip is unset with
* elm_diskselector_item_tooltip_unset() or the owner @a item
* dies. This callback receives as the first parameter the
* given @a data, and @c event_info is the item.
* @{
*
* @image html img/widget/colorselector/preview-00.png
+ * @image latex img/widget/colorselector/preview-00.eps
*
* @brief Widget for user to select a color.
*
*/
/**
- * @defgroup Ctxpopup
+ * @defgroup Ctxpopup Ctxpopup
*
* @image html img/widget/ctxpopup/preview-00.png
* @image latex img/widget/ctxpopup/preview-00.eps
* @ref tutorial_ctxpopup shows the usage of a good deal of the API.
* @{
*/
- typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
-
typedef enum _Elm_Ctxpopup_Direction
{
ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
the clicked area */
ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
area */
+ ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
} Elm_Ctxpopup_Direction;
/**
*
* @see elm_ctxpopup_content_set()
*/
- 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);
+ Elm_Object_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);
/**
* @brief Delete the given item in a ctxpopup object.
*
- * @param item Ctxpopup item to be deleted
+ * @param it Ctxpopup item to be deleted
*
* @see elm_ctxpopup_item_append()
*/
- EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
+ EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
/**
* @brief Set the ctxpopup item's state as disabled or enabled.
*
- * @param item Ctxpopup item to be enabled/disabled
+ * @param it Ctxpopup item to be enabled/disabled
* @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
*
* When disabled the item is greyed out to indicate it's state.
*/
- EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+ EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
/**
* @brief Get the ctxpopup item's disabled/enabled state.
*
- * @param item Ctxpopup item to be enabled/disabled
+ * @param it Ctxpopup item to be enabled/disabled
* @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
*
* @see elm_ctxpopup_item_disabled_set()
*/
- EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
/**
* @brief Get the icon object for the given ctxpopup item.
*
- * @param item Ctxpopup item
+ * @param it Ctxpopup item
* @return icon object or @c NULL, if the item does not have icon or an error
* occurred
*
* @see elm_ctxpopup_item_append()
* @see elm_ctxpopup_item_icon_set()
*/
- EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
+ EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
/**
* @brief Sets the side icon associated with the ctxpopup item
*
- * @param item Ctxpopup item
+ * @param it Ctxpopup item
* @param icon Icon object to be set
*
* Once the icon object is set, a previously set one will be deleted.
*
* @see elm_ctxpopup_item_append()
*/
- EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
+ EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
/**
* @brief Get the label for the given ctxpopup item.
*
- * @param item Ctxpopup item
+ * @param it Ctxpopup item
* @return label string or @c NULL, if the item does not have label or an
* error occured
*
* @see elm_ctxpopup_item_append()
* @see elm_ctxpopup_item_label_set()
*/
- EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
+ EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
/**
* @brief (Re)set the label on the given ctxpopup item.
*
- * @param item Ctxpopup item
+ * @param it Ctxpopup item
* @param label String to set as label
*/
- EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
+ EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
/**
* @brief Set an elm widget as the content of the ctxpopup.
*
* @see elm_ctxpopup_direction_priority_set() for more information.
*/
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);
+
+ /**
+ * @brief Get the current direction of a ctxpopup.
+ *
+ * @param obj Ctxpopup object
+ * @return current direction of a ctxpopup
+ *
+ * @warning Once the ctxpopup showed up, the direction would be determined
+ */
+ EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
* positioned at left.
*
* @see elm_segment_control_item_add()
- * @see elm_segment_control_count_get()
+ * @see elm_segment_control_item_count_get()
* @see elm_segment_control_item_del()
*
* @ingroup SegmentControl
* @}
*/
+ /**
+ * @defgroup Grid Grid
+ *
+ * The grid is a grid layout widget that lays out a series of children as a
+ * fixed "grid" of widgets using a given percentage of the grid width and
+ * height each using the child object.
+ *
+ * The Grid uses a "Virtual resolution" that is stretched to fill the grid
+ * widgets size itself. The default is 100 x 100, so that means the
+ * position and sizes of children will effectively be percentages (0 to 100)
+ * of the width or height of the grid widget
+ *
+ * @{
+ */
+ /**
+ * Add a new grid to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Grid
+ */
EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
+
+ /**
+ * Set the virtual size of the grid
+ *
+ * @param obj The grid object
+ * @param w The virtual width of the grid
+ * @param h The virtual height of the grid
+ *
+ * @ingroup Grid
+ */
EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
+
+ /**
+ * Get the virtual size of the grid
+ *
+ * @param obj The grid object
+ * @param w Pointer to integer to store the virtual width of the grid
+ * @param h Pointer to integer to store the virtual height of the grid
+ *
+ * @ingroup Grid
+ */
EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
+
+ /**
+ * Pack child at given position and size
+ *
+ * @param obj The grid object
+ * @param subobj The child to pack
+ * @param x The virtual x coord at which to pack it
+ * @param y The virtual y coord at which to pack it
+ * @param w The virtual width at which to pack it
+ * @param h The virtual height at which to pack it
+ *
+ * @ingroup Grid
+ */
EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
+
+ /**
+ * Unpack a child from a grid object
+ *
+ * @param obj The grid object
+ * @param subobj The child to unpack
+ *
+ * @ingroup Grid
+ */
EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
+
+ /**
+ * Faster way to remove all child objects from a grid object.
+ *
+ * @param obj The grid object
+ * @param clear If true, it will delete just removed children
+ *
+ * @ingroup Grid
+ */
EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
+
+ /**
+ * Set packing of an existing child at to position and size
+ *
+ * @param subobj The child to set packing of
+ * @param x The virtual x coord at which to pack it
+ * @param y The virtual y coord at which to pack it
+ * @param w The virtual width at which to pack it
+ * @param h The virtual height at which to pack it
+ *
+ * @ingroup Grid
+ */
EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
+
+ /**
+ * get packing of a child
+ *
+ * @param subobj The child to query
+ * @param x Pointer to integer to store the virtual x coord
+ * @param y Pointer to integer to store the virtual y coord
+ * @param w Pointer to integer to store the virtual width
+ * @param h Pointer to integer to store the virtual height
+ *
+ * @ingroup Grid
+ */
EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
- EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
- EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
+ /**
+ * @}
+ */
+
+ EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
+ EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
+ EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
+ EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
+ EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
+ EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
+ /**
+ * @defgroup Video Video
+ *
+ * This object display an player that let you control an Elm_Video
+ * object. It take care of updating it's content according to what is
+ * going on inside the Emotion object. It does activate the remember
+ * function on the linked Elm_Video object.
+ *
+ * Signals that you can add callback for are :
+ *
+ * "forward,clicked" - the user clicked the forward button.
+ * "info,clicked" - the user clicked the info button.
+ * "next,clicked" - the user clicked the next button.
+ * "pause,clicked" - the user clicked the pause button.
+ * "play,clicked" - the user clicked the play button.
+ * "prev,clicked" - the user clicked the prev button.
+ * "rewind,clicked" - the user clicked the rewind button.
+ * "stop,clicked" - the user clicked the stop button.
+ */
EAPI Evas_Object *elm_video_add(Evas_Object *parent);
EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
EAPI Evas_Object *elm_player_add(Evas_Object *parent);
EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
- /* naviframe */
- typedef struct _Elm_Naviframe_Item Elm_Naviframe_Item;
-
- typedef enum
- {
- ELM_NAVIFRAME_PREV_BUTTON,
- ELM_NAVIFRAME_NEXT_BUTTON
- } Elm_Naviframe_Button_Type;
-
+ /**
+ * @defgroup Naviframe Naviframe
+ *
+ * @brief Naviframe is a kind of view manager for the applications.
+ *
+ * Naviframe provides functions to switch different pages with stack
+ * mechanism. It means if one page(item) needs to be changed to the new one,
+ * then naviframe would push the new page to it's internal stack. Of course,
+ * it can be back to the previous page by popping the top page. Naviframe
+ * provides some transition effect while the pages are switching (same as
+ * pager).
+ *
+ * Since each item could keep the different styles, users could keep the
+ * same look & feel for the pages or different styles for the items in it's
+ * application.
+ *
+ * Signals that you can add callback for are:
+ *
+ * @li "transition,finished" - When the transition is finished in changing
+ * the item
+ * @li "title,clicked" - User clicked title area
+ *
+ * Default contents parts for the naviframe items that you can use for are:
+ *
+ * @li "elm.swallow.content" - The main content of the page
+ * @li "elm.swallow.prev_btn" - The button to go to the previous page
+ * @li "elm.swallow.next_btn" - The button to go to the next page
+ *
+ * Default text parts of naviframe items that you can be used are:
+ *
+ * @li "elm.text.title" - The title label in the title area
+ *
+ * @ref tutorial_naviframe gives a good overview of the usage of the API.
+ * @{
+ */
+ /**
+ * @brief Add a new Naviframe object to the parent.
+ *
+ * @param parent Parent object
+ * @return New object or @c NULL, if it cannot be created
+ */
EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
- EAPI Elm_Naviframe_Item *elm_naviframe_item_push(Evas_Object *obj, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
+ /**
+ * @brief Push a new item to the top of the naviframe stack (and show it).
+ *
+ * @param obj The naviframe object
+ * @param title_label The label in the title area. The name of the title
+ * label part is "elm.text.title"
+ * @param prev_btn The button to go to the previous item. If it is NULL,
+ * then naviframe will create a back button automatically. The name of
+ * the prev_btn part is "elm.swallow.prev_btn"
+ * @param next_btn The button to go to the next item. Or It could be just an
+ * extra function button. The name of the next_btn part is
+ * "elm.swallow.next_btn"
+ * @param content The main content object. The name of content part is
+ * "elm.swallow.content"
+ * @param item_style The current item style name. @c NULL would be default.
+ * @return The created item or @c NULL upon failure.
+ *
+ * The item pushed becomes one page of the naviframe, this item will be
+ * deleted when it is popped.
+ *
+ * @see also elm_naviframe_item_style_set()
+ *
+ * The following styles are available for this item:
+ * @li @c "default"
+ */
+ EAPI Elm_Object_Item *elm_naviframe_item_push(Evas_Object *obj, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
+ /**
+ * @brief Pop an item that is on top of the stack
+ *
+ * @param obj The naviframe object
+ * @return @c NULL or the content object(if the
+ * elm_naviframe_content_preserve_on_pop_get is true).
+ *
+ * This pops an item that is on the top(visible) of the naviframe, makes it
+ * disappear, then deletes the item. The item that was underneath it on the
+ * stack will become visible.
+ *
+ * @see also elm_naviframe_content_preserve_on_pop_get()
+ */
EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Pop the items between the top and the above one on the given item.
+ *
+ * @param it The naviframe item
+ */
+ EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+ /**
+ * @brief preserve the content objects when items are popped.
+ *
+ * @param obj The naviframe object
+ * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
+ *
+ * @see also elm_naviframe_content_preserve_on_pop_get()
+ */
EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get a value whether preserve mode is enabled or not.
+ *
+ * @param obj The naviframe object
+ * @return If @c EINA_TRUE, preserve mode is enabled
+ *
+ * @see also elm_naviframe_content_preserve_on_pop_set()
+ */
EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_naviframe_item_content_set(Elm_Naviframe_Item *item, Evas_Object *content) EINA_ARG_NONNULL(1);
- EAPI Evas_Object *elm_naviframe_item_content_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
- EAPI void elm_naviframe_item_title_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
- EAPI const char *elm_naviframe_item_title_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
- EAPI void elm_naviframe_item_subtitle_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
- EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
- EAPI Elm_Naviframe_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI Elm_Naviframe_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- EAPI void elm_naviframe_item_button_set(Elm_Naviframe_Item *it, Evas_Object *btn, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
- EAPI Evas_Object *elm_naviframe_item_button_get(const Elm_Naviframe_Item *it, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
- EAPI void elm_naviframe_item_icon_set(Elm_Naviframe_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
- EAPI Evas_Object *elm_naviframe_item_icon_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
- EAPI void elm_naviframe_item_style_set(Elm_Naviframe_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
- EAPI const char *elm_naviframe_item_style_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
- EAPI void elm_naviframe_item_title_visible_set(Elm_Naviframe_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
- EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get a top item on the naviframe stack
+ *
+ * @param obj The naviframe object
+ * @return The top item on the naviframe stack or @c NULL, if the stack is
+ * empty
+ */
+ EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get a bottom item on the naviframe stack
+ *
+ * @param obj The naviframe object
+ * @return The bottom item on the naviframe stack or @c NULL, if the stack is
+ * empty
+ */
+ EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set an item style
+ *
+ * @param obj The naviframe item
+ * @param item_style The current item style name. @c NULL would be default
+ *
+ * The following styles are available for this item:
+ * @li @c "default"
+ *
+ * @see also elm_naviframe_item_style_get()
+ */
+ EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get an item style
+ *
+ * @param obj The naviframe item
+ * @return The current item style name
+ *
+ * @see also elm_naviframe_item_style_set()
+ */
+ EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Show/Hide the title area
+ *
+ * @param it The naviframe item
+ * @param visible If @c EINA_TRUE, title area will be visible, hidden
+ * otherwise
+ *
+ * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
+ *
+ * @see also elm_naviframe_item_title_visible_get()
+ */
+ EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Get a value whether title area is visible or not.
+ *
+ * @param it The naviframe item
+ * @return If @c EINA_TRUE, title area is visible
+ *
+ * @see also elm_naviframe_item_title_visible_set()
+ */
+ EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
+ /**
+ * @}
+ */
#ifdef __cplusplus
}
projects / framework / uifw / elementary.git / blobdiff