frame:preview-00.png:widget_preview_frame:100:50 \
label:preview-00.png:widget_preview_label:70:30 \
clock:preview-00.png:widget_preview_clock:200:100 \
+ slider:preview-00.png:widget_preview_slider:200:100 \
ctxpopup:preview-00.png:widget_preview_ctxpopup:200:130 \
icon:preview-00.png:widget_preview_icon:50:50 \
image:preview-00.png:widget_preview_image:50:50 \
*
* @ref spinner_example
*
+ * @ref slider_example
+ *
* @ref clock_example
*
* @ref diskselector_example_01
*/
/**
+ * @page slider_example Slider widget example
+ *
+ * This code places seven Elementary slider widgets on a window, each of
+ * them exemplifying a part of the widget's API.
+ *
+ * The first of them is the default slider:
+ * @dontinclude slider_example.c
+ * @skipline elm_slider_add
+ * @until evas_object_show
+ *
+ * As you see, the defaults for a slider are:
+ * @li horizontal
+ * @li no label
+ * @li no values (on indicator or unit labels)
+ *
+ * Actually it's pretty useless this way. So let's learn how to improve it.
+ *
+ * If some decoration is required, a label can be set, and icon before and
+ * after the bar as well. On the second slider will add a @c home icon
+ * and a @c folder icon at @c end.
+ * @skipline text_set
+ * @until end_set
+ *
+ * If the bar size need to be changed, it can be done with span set function,
+ * that doesn't accounts other widget's parts size. Also the bar can starts
+ * with a not default value (0.0), as we done on third slider:
+ * @skipline value_set
+ * @skipline span_size_set
+ *
+ * So far, users won't be able to see the slider value. If it's required,
+ * it can be displayed in two different areas, units label or above
+ * the indicator.
+ *
+ * Let's place a units label on our widget, and also let's set minimum and
+ * maximum value (uses 0.0 and 1.0 by default):
+ * @skipline unit_format_set
+ * @skipline min_max_set
+ *
+ * If above the indicator is the place to display the value, just set it.
+ * Also, is possible to invert a bar, as you can see:
+ * @skipline indicator_format_set
+ * @skipline inverted_set
+ *
+ * But if you require to use a function a bit more customized to show the value,
+ * is possible to registry a callback function that will be called
+ * to display unit or indicator label. Only the value will be passed to this
+ * function, that should return a string.
+ * In this case, a function to free this string will be required.
+ *
+ * Let's exemplify with indicator label on our sixth slider:
+ * @dontinclude slider_example.c
+ * @skip static
+ * @skip }
+ * @skip static
+ * @skip }
+ * @skip static
+ * @skip }
+ * @skipline static
+ * @until }
+ * @until }
+ *
+ * Setting callback functions:
+ * @skipline indicator_format_function_set
+ * @skipline _indicator_free
+ *
+ * Also, a slider can be displayed vertically:
+ * @dontinclude slider_example.c
+ * @skipline elm_slider_horizontal_set
+ *
+ * Finally the last widget will exemplify how to listen to widget's signals,
+ * <tt> changed </tt> and <tt> delay,changed </tt>. First we need to
+ * implement callback functions that will simply print slider's value:
+ * @dontinclude slider_example.c
+ * @skip static
+ * @skip }
+ * @skipline static
+ * @until }
+ * @until }
+ *
+ * The first callback function should be called everytime value changes,
+ * the second one only after user stops to increment or decrement. Try
+ * to keep arrows pressed and check the difference.
+ * @skip smart_callback
+ * @skipline smart_callback
+ * @skipline smart_callback
+ *
+ * See the full @ref slider_example.c "example", whose window should
+ * look like this picture:
+ *
+ * @image html screenshots/slider_example.png
+ * @image latex screenshots/slider_example.eps width=\textwidth
+ *
+ * See the full @ref slider_example_c "source code" for this example.
+ *
+ * @example slider_example.c
+ */
+
+/**
* @page clock_example Clock widget example
*
* This code places five Elementary clock widgets on a window, each of
* @image html img/widget/separator/preview-00.png
* @image latex img/widget/separator/preview-00.eps
* @li @ref Slider
+ *
+ * @image html img/widget/slider/preview-00.png
+ * @image latex img/widget/slider/preview-00.eps
* @li @ref Slideshow
* @li @ref Spinner
*
widget_preview_clock \
widget_preview_label \
widget_preview_frame \
+widget_preview_slider \
widget_preview_ctxpopup \
widget_preview_icon \
widget_preview_image \
widget_preview_clock.c \
widget_preview_colorselector.c \
widget_preview_conformant.c \
+ widget_preview_slider.c \
widget_preview_ctxpopup.c \
widget_preview_diskselector.c \
widget_preview_entry1.c \
--- /dev/null
+#include "widget_preview_tmpl_head.c"
+
+Evas_Object *o = elm_slider_add(win);
+evas_object_size_hint_weight_set(o, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+elm_win_resize_object_add(win, o);
+evas_object_show(o);
+
+#include "widget_preview_tmpl_foot.c"
genlist_example_03.c \
theme_example.edc \
layout_example.edc \
+ slider_example.c \
ctxpopup_example_01.c \
pager_example_01.c \
separator_example_01.c \
list_example_01 \
list_example_02 \
list_example_03 \
+ slider_example \
ctxpopup_example_01 \
flipselector_example \
fileselector_example \
flipselector_example:flipselector_example.png:0.0 \
fileselector_example:fileselector_example.png:0.0 \
index_example_02:index_example_03.png:0.3 \
+ slider_example:slider_example.png:0.0 \
ctxpopup_example_01:ctxpopup_example_01.png:0.0 \
pager_example_01:pager_example_01.png:0.0 \
separator_example_01:separator_example_01.png:0.0 \
--- /dev/null
+/**
+ * Simple Elementary's <b>slider widget</b> example, illustrating its
+ * usage and API.
+ *
+ * See stdout/stderr for output. Compile with:
+ *
+ * @verbatim
+ * gcc -g `pkg-config --cflags --libs elementary` slider_example.c -o slider_example
+ * @endverbatim
+ */
+
+#include <Elementary.h>
+#ifdef HAVE_CONFIG_H
+# include "elementary_config.h"
+#else
+# define __UNUSED__
+#endif
+
+static void
+_on_done(void *data __UNUSED__,
+ Evas_Object *obj __UNUSED__,
+ void *event_info __UNUSED__)
+{
+ elm_exit();
+}
+
+static void
+_changed_cb(void *data __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
+{
+ double val = elm_slider_value_get(obj);
+ printf("Changed to %1.2f\n", val);
+}
+
+static void
+_delay_changed_cb(void *data __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
+{
+ double val = elm_slider_value_get(obj);
+ printf("Delay changed to %1.2f\n", val);
+}
+
+static char*
+_indicator_format(double val)
+{
+ char *indicator = malloc(sizeof(char) * 32);
+ snprintf(indicator, 32, "%1.2f u", val);
+ return indicator;
+}
+
+static void
+_indicator_free(char *str)
+{
+ free(str);
+}
+
+int
+elm_main(int argc __UNUSED__, char **argv __UNUSED__)
+{
+ Evas_Object *win, *bg, *bx, *sl, *ic;
+
+ win = elm_win_add(NULL, "slider", ELM_WIN_BASIC);
+ elm_win_title_set(win, "Slider Example");
+ evas_object_smart_callback_add(win, "delete,request", _on_done, NULL);
+
+ bg = elm_bg_add(win);
+ elm_win_resize_object_add(win, bg);
+ evas_object_size_hint_weight_set(bg, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+ evas_object_show(bg);
+
+ bx = elm_box_add(win);
+ evas_object_size_hint_weight_set(bx, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+ elm_win_resize_object_add(win, bx);
+ evas_object_show(bx);
+
+ /* default */
+ sl = elm_slider_add(win);
+ evas_object_size_hint_align_set(sl, EVAS_HINT_FILL, 0.5);
+ evas_object_size_hint_weight_set(sl, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+ elm_box_pack_end(bx, sl);
+ evas_object_show(sl);
+
+ /* with icon, end and label */
+ sl = elm_slider_add(win);
+ elm_object_text_set(sl, "Counter");
+
+ ic = elm_icon_add(win);
+ elm_icon_standard_set(ic, "home");
+ elm_icon_scale_set(ic, EINA_FALSE, EINA_FALSE);
+ elm_slider_icon_set(sl, ic);
+
+ ic = elm_icon_add(win);
+ elm_icon_standard_set(ic, "folder");
+ elm_icon_scale_set(ic, EINA_FALSE, EINA_FALSE);
+ elm_slider_end_set(sl, ic);
+
+ evas_object_size_hint_align_set(sl, EVAS_HINT_FILL, 0.5);
+ evas_object_size_hint_weight_set(sl, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+ elm_box_pack_end(bx, sl);
+ evas_object_show(sl);
+
+ /* value set and span size */
+ sl = elm_slider_add(win);
+ elm_slider_value_set(sl, 1);
+ elm_slider_span_size_set(sl, 200);
+ evas_object_size_hint_align_set(sl, EVAS_HINT_FILL, 0.5);
+ evas_object_size_hint_weight_set(sl, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+ elm_box_pack_end(bx, sl);
+ evas_object_show(sl);
+
+ /* with unit label and min - max */
+ sl = elm_slider_add(win);
+ elm_slider_unit_format_set(sl, "%1.0f units");
+ elm_slider_min_max_set(sl, 0, 100);
+ evas_object_size_hint_align_set(sl, EVAS_HINT_FILL, 0.5);
+ evas_object_size_hint_weight_set(sl, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+ elm_box_pack_end(bx, sl);
+ evas_object_show(sl);
+
+ /* with indicator label and inverted */
+ sl = elm_slider_add(win);
+ elm_slider_indicator_format_set(sl, "%1.2f");
+ elm_slider_inverted_set(sl, EINA_TRUE);
+ evas_object_size_hint_align_set(sl, EVAS_HINT_FILL, 0.5);
+ evas_object_size_hint_weight_set(sl, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+ elm_box_pack_end(bx, sl);
+ evas_object_show(sl);
+
+ /* vertical with indicator format func */
+ sl = elm_slider_add(win);
+ elm_slider_horizontal_set(sl, EINA_FALSE);
+ elm_slider_indicator_format_function_set(sl, _indicator_format,
+ _indicator_free);
+ evas_object_size_hint_align_set(sl, 0.5, EVAS_HINT_FILL);
+ evas_object_size_hint_weight_set(sl, 0, EVAS_HINT_EXPAND);
+ elm_box_pack_end(bx, sl);
+ evas_object_show(sl);
+
+ /* callbacks */
+ sl = elm_slider_add(win);
+ elm_slider_unit_format_set(sl, "%1.3f units");
+ evas_object_size_hint_align_set(sl, EVAS_HINT_FILL, 0.5);
+ evas_object_size_hint_weight_set(sl, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+ elm_box_pack_end(bx, sl);
+ evas_object_show(sl);
+ evas_object_smart_callback_add(sl, "changed", _changed_cb, NULL);
+ evas_object_smart_callback_add(sl, "delay,changed", _delay_changed_cb, NULL);
+
+ evas_object_show(win);
+
+ elm_run();
+ return 0;
+}
+ELM_MAIN()
* @}
*/
- /* slider */
+ /**
+ * @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.
+ *
+ * Available styles for it:
+ * - @c "default"
+ *
+ * Here is an example on its usage:
+ * @li @ref slider_example
+ */
+
+ /**
+ * @addtogroup Slider
+ * @{
+ */
+
+ /**
+ * Add a new slider widget to the given parent Elementary
+ * (container) object.
+ *
+ * @param parent The parent object.
+ * @return a new slider widget handle or @c NULL, on errors.
+ *
+ * This function inserts a new slider widget on the canvas.
+ *
+ * @ingroup Slider
+ */
EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the label of a given slider widget
+ *
+ * @param obj The progress bar object
+ * @param label The text label string, in UTF-8
+ *
+ * @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
+ *
+ * @param obj The progressbar object
+ * @return The text label string, in UTF-8
+ *
+ * @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);
+
+ /**
+ * 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);
+
+ /**
+ * 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).
+ *
+ * On horizontal mode, icon is placed at left, and on vertical mode,
+ * placed at top.
+ *
+ * This call will unparent and return the icon object which was set
+ * for this widget, previously, on success.
+ *
+ * @see elm_slider_icon_set() for more details
+ * @see elm_slider_icon_get()
+ *
+ * @ingroup Slider
+ */
EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Retrieve the icon object set for a given slider 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).
+ *
+ * On horizontal mode, icon is placed at left, and on vertical mode,
+ * placed at top.
+ *
+ * @see elm_slider_icon_set() for more details
+ * @see elm_slider_icon_unset()
+ *
+ * @ingroup Slider
+ */
EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the end object of the slider object.
+ *
+ * @param obj The slider object.
+ * @param end The end object.
+ *
+ * On horizontal mode, end is placed at left, and on vertical mode,
+ * placed at bottom.
+ *
+ * @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.
+ *
+ * @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_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
+
+ /**
+ * Unset an end object set on a given slider widget.
+ *
+ * @param obj The slider object.
+ * @return The end object that was being used, if any was set, or
+ * @c NULL, otherwise (and on errors).
+ *
+ * On horizontal mode, end is placed at left, and on vertical mode,
+ * placed at bottom.
+ *
+ * This call will unparent and return the icon object which was set
+ * for this widget, previously, on success.
+ *
+ * @see elm_slider_end_set() for more details.
+ * @see elm_slider_end_get()
+ *
+ * @ingroup Slider
+ */
EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Retrieve the end object set for a given slider widget.
+ *
+ * @param obj The slider object.
+ * @return The end object's handle, if @p obj had one set, or @c NULL,
+ * otherwise (and on errors).
+ *
+ * On horizontal mode, icon is placed at right, and on vertical mode,
+ * placed at bottom.
+ *
+ * @see elm_slider_end_set() for more details.
+ * @see elm_slider_end_unset()
+ *
+ * @ingroup Slider
+ */
EAPI Evas_Object *elm_slider_end_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.
+ *
+ * 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.
+ *
+ * @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_slider_span_size_get()
+ *
+ * @ingroup Slider
+ */
EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the length set for the bar region of a given slider widget
+ *
+ * @param obj The slider object.
+ * @return The length of the slider's bar region.
+ *
+ * If that size was not set previously, with
+ * elm_slider_span_size_set(), this call will return @c 0.
+ *
+ * @ingroup Slider
+ */
EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) 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.
+ *
+ * Default is unit label disabled.
+ *
+ * @see elm_slider_indicator_format_get()
+ *
+ * @ingroup Slider
+ */
EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) 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.
+ *
+ * Unit label is displayed all the time, if set, after slider's bar.
+ * In horizontal mode, at right and in vertical mode, at bottom.
+ *
+ * @see elm_slider_unit_format_set() for more
+ * information on how this works.
+ *
+ * @ingroup Slider
+ */
EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the format string for the indicator label.
+ *
+ * @param obj The slider object.
+ * @param indicator The format string for the indicator display.
+ *
+ * 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.
+ *
+ * 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.
+ *
+ * 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 indicator label disabled.
+ *
+ * @see elm_slider_indicator_format_get()
+ *
+ * @ingroup Slider
+ */
EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the indicator label format of the slider.
+ *
+ * @param obj The slider object.
+ * @return The indicator label format string in UTF-8.
+ *
+ * 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.
+ *
+ * @see elm_slider_indicator_format_set() for more
+ * information on how this works.
+ *
+ * @ingroup Slider
+ */
EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the format function pointer for the indicator label
+ *
+ * @param obj The slider object.
+ * @param func The indicator format function.
+ * @param free_func The freeing function for the format string.
+ *
+ * Set the callback function to format the indicator string.
+ *
+ * @see elm_slider_indicator_format_set() for more info on how this works.
+ *
+ * @ingroup Slider
+ */
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);
+
+ /**
+ * Retrieve the orientation of a given slider widget
+ *
+ * @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_slider_horizontal_set() for more details.
+ *
+ * @ingroup Slider
+ */
EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the minimum and maximum values for the slider.
+ *
+ * @param obj The slider 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_slider_value_get().
+ *
+ * By default, min is equal to 0.0, and max is equal to 1.0.
+ *
+ * @warning Maximum must be greater than minimum, otherwise behavior
+ * is undefined.
+ *
+ * @see elm_slider_min_max_get()
+ *
+ * @ingroup Slider
+ */
EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the minimum and maximum values of the slider.
+ *
+ * @param obj The slider object.
+ * @param min Pointer where to store the minimum value.
+ * @param max Pointer where to store the maximum value.
+ *
+ * @note If only one value is needed, the other pointer can be passed
+ * as @c NULL.
+ *
+ * @see elm_slider_min_max_set() for details.
+ *
+ * @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.
+ *
+ * @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().
+ *
+ * @warning The value must to be between min and max values. This values
+ * are set by elm_slider_min_max_set().
+ *
+ * @see elm_slider_value_get()
+ * @see elm_slider_unit_format_set()
+ * @see elm_slider_indicator_format_set()
+ * @see elm_slider_min_max_set()
+ *
+ * @ingroup Slider
+ */
EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the value displayed by the spinner.
+ *
+ * @param obj The spinner object.
+ * @return The value displayed.
+ *
+ * @see elm_spinner_value_set() for details.
+ *
+ * @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
+ *
+ * @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.
+ *
+ * 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_slider_inverted_get()
+ *
+ * @ingroup Slider
+ */
EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) 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).
+ *
+ * @see elm_slider_inverted_set() for more details.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * By default, indicator will be bigger while dragged by the user.
+ *
+ * @warning It won't display values set with
+ * elm_slider_indicator_format_set() if you disable indicator.
+ *
+ * @ingroup Slider
+ */
EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get whether a given slider widget's enlarging indicator 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).
+ *
+ * @see elm_slider_indicator_show_set() for details.
+ *
+ * @ingroup Slider
+ */
EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /* smart callbacks called:
- * "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.
+
+ /**
+ * @}
*/
/**
#include <Elementary.h>
#include "elm_priv.h"
-/**
- * @defgroup Slider Slider
- *
- * 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().
- *
- * Signals that you can add callbacks for are:
- *
- * "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.
- */
-
typedef struct _Widget_Data Widget_Data;
struct _Widget_Data
return wd->label;
}
-/**
- * Add a new slider to the parent
- *
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
- *
- * @ingroup Slider
- */
EAPI Evas_Object *
elm_slider_add(Evas_Object *parent)
{
return obj;
}
-/**
- * Set the label of the slider
- *
- * @param obj The slider object
- * @param label The text label string in UTF-8
- *
- * @ingroup Slider
- */
EAPI void
elm_slider_label_set(Evas_Object *obj, const char *label)
{
_elm_slider_label_set(obj, NULL, label);
}
-/**
- * Get the label of the slider
- *
- * @param obj The slider object
- * @return The text label string in UTF-8
- *
- * @ingroup Slider
- */
EAPI const char *
elm_slider_label_get(const Evas_Object *obj)
{
return _elm_slider_label_get(obj, NULL);
}
-/**
- * Set the icon object (leftmost widget) of the slider 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_slider_icon_unset() function.
- *
- * @param obj The slider object
- * @param icon The icon object
- *
- * @note 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)
{
_sizing_eval(obj);
}
-/**
- * Unset the leftmost widget of the slider, unparenting and
- * returning it.
- *
- * @param obj The slider object
- * @return the previously set icon sub-object of this slider, on
- * success.
- *
- * @see elm_slider_icon_set()
- *
- * @ingroup Slider
- */
EAPI Evas_Object *
elm_slider_icon_unset(Evas_Object *obj)
{
return ret;
}
-/**
- * Get the icon object of the slider object. This object is owned by
- * the scrolled entry and should not be modified.
- *
- * @param obj The slider object
- * @return The icon object
- *
- * @ingroup Slider
- */
EAPI Evas_Object *
elm_slider_icon_get(const Evas_Object *obj)
{
return wd->icon;
}
-/**
- * Set the length of the dragable region of the slider
- *
- * This sets the minimum width or height (depending on orientation) of the
- * area of the slider that allows the slider to be dragged around. This in
- * turn affects the objects minimum size (along with icon label and unit
- * text). Note that this will also get multiplied by the scale factor.
- *
- * @param obj The slider object
- * @param size The length of the slider area
- *
- * @ingroup Slider
- */
EAPI void
elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size)
{
_sizing_eval(obj);
}
-/**
- * Get the length of the dragable region of the slider
- *
- * This gets the minimum width or height (depending on orientation) of
- * the area of the slider that allows the slider to be dragged
- * around. Note that this will also get multiplied by the scale
- * factor.
- *
- * @param obj The slider object
- * @return The length of the slider area
- *
- * @ingroup Slider
- */
EAPI Evas_Coord
elm_slider_span_size_get(const Evas_Object *obj)
{
return wd->size;
}
-/**
- * Set the format string of the unit area
- *
- * If NULL, this disabls the unit area display. If not it sets the format
- * string for the unit text. The unit text is provided a floating point
- * value, so the unit 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.
- *
- * @param obj The slider object
- * @param units The format string for the units display
- *
- * @ingroup Slider
- */
EAPI void
elm_slider_unit_format_set(Evas_Object *obj, const char *units)
{
_sizing_eval(obj);
}
-/**
- * Get the format string for the unit area
- *
- * The slider may also display a value (the value of the slider) somewhere
- * (for example above the slider knob that is dragged around). This sets the
- * format string for this. See elm_slider_unit_format_set() for more
- * information on how this works.
- *
- * @param obj The slider object
- * @return The format string for the unit display.
- *
- * @ingroup Slider
- */
EAPI const char *
elm_slider_unit_format_get(const Evas_Object *obj)
{
return wd->units;
}
-/**
- * Set the format string for the indicator area
- *
- * The slider may also display a value (the value of the slider) somewhere
- * (for example above the slider knob that is dragged around). This sets the
- * format string for this. See elm_slider_unit_format_set() for more
- * information on how this works.
- *
- * @param obj The slider object
- * @param indicator The format string for the indicator display
- *
- * @ingroup Slider
- */
EAPI void
elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator)
{
_indicator_set(obj);
}
-/**
- * Get the format string for the indicator area
- *
- * The slider may also display a value (the value of the slider) somewhere
- * (for example above the slider knob that is dragged around). This sets the
- * format string for this. See elm_slider_indicator_format_set() for more
- * information on how this works.
- *
- * @param obj The slider object
- * @return The format string for the indicator display.
- *
- * @ingroup Slider
- */
EAPI const char *
elm_slider_indicator_format_get(const Evas_Object *obj)
{
return wd->indicator;
}
-/**
- * Set orientation of the slider
- *
- * @param obj The slider object
- * @param horizontal If set, the slider will be horizontal
- *
- * @ingroup Slider
- */
EAPI void
elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal)
{
_theme_hook(obj);
}
-/**
- * Get orientation of the slider
- *
- * @param obj The slider object
- * @return If @c EINA_TRUE the slider will be horizontal, else it is
- * vertical.
- * @ingroup Slider
- */
EAPI Eina_Bool
elm_slider_horizontal_get(const Evas_Object *obj)
{
return wd->horizontal;
}
-/**
- * Set the minimum and maximum values for the slider
- *
- * Maximum mut be greater than minimum.
- *
- * @param obj The slider object
- * @param min The minimum value
- * @param max The maximum value
- *
- * @ingroup Slider
- */
EAPI void
elm_slider_min_max_set(Evas_Object *obj, double min, double max)
{
_indicator_set(obj);
}
-/**
- * Get the minimum and maximum values for the slider
- *
- * @param obj The slider object
- * @param min The pointer to store minimum value, may be @c NULL.
- * @param max The pointer to store maximum value, may be @c NULL.
- *
- * @ingroup Slider
- */
EAPI void
elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max)
{
if (max) *max = wd->val_max;
}
-/**
- * Set the value the slider indicates
- *
- * @param obj The slider object
- * @param val The value (must be between min and max for the slider)
- *
- * @ingroup Slider
- */
EAPI void
elm_slider_value_set(Evas_Object *obj, double val)
{
_indicator_set(obj);
}
-/**
- * Get the value the slider has
- *
- * @param obj The slider object
- * @return The value of the slider
- *
- * @ingroup Slider
- */
EAPI double
elm_slider_value_get(const Evas_Object *obj)
{
return wd->val;
}
-/**
- * Invert the slider display
- *
- * Normally the slider will display and interpret values from low to high
- * and when horizontal that is left to right. When vertical that is top
- * to bottom. This inverts this (so from right to left or bottom to top) if
- * inverted is set to 1.
- *
- * @param obj The slider object
- * @param inverted The inverted flag. 1 == inverted, 0 == normal
- *
- * @ingroup Slider
- */
EAPI void
elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted)
{
_indicator_set(obj);
}
-/**
- * Get if the slider display is inverted (backwards)
- *
- * @param obj The slider object
- * @return If @c EINA_TRUE the slider will be inverted.
- * @ingroup Slider
- */
EAPI Eina_Bool
elm_slider_inverted_get(const Evas_Object *obj)
{
return wd->inverted;
}
-/**
- * Set the format function pointer for the indicator area
- *
- * Set the callback function to format the indicator string.
- * See elm_slider_indicator_format_set() for more info on how this works.
- *
- * @param obj The slider object
- * @param indicator The format string for the indicator display
- * @param func The indicator format function
- * @param free_func The freeing function for the format string
- *
- * @ingroup Slider
- */
EAPI void
elm_slider_indicator_format_function_set(Evas_Object *obj, const char *(*func)(double val), void (*free_func)(const char *str))
{
_indicator_set(obj);
}
-/**
- * Set the format function pointer for the units area
- *
- * Set the callback function to format the indicator string.
- * See elm_slider_units_format_set() for more info on how this works.
- *
- * @param obj The slider object
- * @param indicator The format string for the units display
- * @param func The units format function
- * @param free_func The freeing function for the format string
- *
- * @ingroup Slider
- */
EAPI void
elm_slider_units_format_function_set(Evas_Object *obj, const char *(*func)(double val), void (*free_func)(const char *str))
{
_indicator_set(obj);
}
-/**
- * Set the end object (rightmost widget) of the slider object.
- *
- * Once the end object is set, a previously set one will be deleted.
- * If you want to keep that old content object, use the
- * elm_button_end_unset() function.
- *
- * @param obj The slider object
- * @param end The end object
- *
- * @note If the object being set does not have minimum size hints set,
- * it won't get properly displayed.
- *
- * @ingroup Slider
- */
EAPI void
elm_slider_end_set(Evas_Object *obj, Evas_Object *end)
{
_sizing_eval(obj);
}
-/**
- * Unset the rightmost widget of the slider, unparenting and
- * returning it.
- *
- * @param obj The slider object
- * @return the previously set end sub-object of this slider, on
- * success.
- *
- * @see elm_slider_end_set()
- *
- * @ingroup Slider
- */
EAPI Evas_Object *
elm_slider_end_unset(Evas_Object *obj)
{
return ret;
}
-/**
- * Get the end icon object of the slider object. This object is owned
- * by the scrolled entry and should not be modified.
- *
- * @param obj The slider object
- * @return The end icon object
- *
- * @ingroup Slider
- */
EAPI Evas_Object *
elm_slider_end_get(const Evas_Object *obj)
{
return wd->end;
}
-/**
- * Set whether to the slider indicator (augmented knob) at all.
- *
- * @param obj The slider object
- * @param show @c EINA_TRUE will make it show it, @c EINA_FALSE will
- * let the knob alwayes at default size.
- *
- * @note It will conflict with elm_slider_indicator_format_set(), if
- * you wanted those effects.
- *
- * @ingroup Slider
- */
EAPI void
elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show)
{
}
}
-/**
- * Get the state of indicator in the slider (if it's being shown or
- * not).
- *
- * @param obj The slider object
- * @return @c EINA_TRUE if the indicator is being shown, @c EINA_FALSE
- * otherwise.
- *
- * @ingroup Slider
- */
EAPI Eina_Bool
elm_slider_indicator_show_get(const Evas_Object *obj)
{
projects / framework / uifw / elementary.git / commitdiff