forked from enlightenment/efl
162 lines
5.0 KiB
C
162 lines
5.0 KiB
C
/**
|
|
* 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 Elm_Slider
|
|
*/
|
|
EAPI Evas_Object *elm_slider_add(Evas_Object *parent);
|
|
|
|
/**
|
|
* @brief Set the orientation of a given slider widget.
|
|
*
|
|
* Use this function to change how your slider is to be disposed: vertically or
|
|
* horizontally.
|
|
*
|
|
* By default it's displayed horizontally.
|
|
*
|
|
* @param[in] horizontal
|
|
*
|
|
* @ingroup Elm_Slider
|
|
*/
|
|
EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
|
|
|
|
/** Get the orientation of a given slider widget.
|
|
*
|
|
* @ingroup Elm_Slider
|
|
*/
|
|
EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Set the value the slider displays.
|
|
*
|
|
* Value will be presented on the unit label following format specified with
|
|
* @ref elm_slider_unit_format_set and on indicator with
|
|
* @ref elm_slider_indicator_format_set.
|
|
*
|
|
* @note The value must to be between min and max values. This values are set
|
|
* by @ref elm_slider_min_max_set.
|
|
*
|
|
* @param[in] val The value to be displayed.
|
|
*
|
|
* @ingroup Elm_Slider
|
|
*/
|
|
EAPI void elm_slider_value_set(Evas_Object *obj, double val);
|
|
|
|
/**
|
|
* @brief Get the value displayed by the slider.
|
|
*
|
|
* @return The value to be displayed.
|
|
*
|
|
* @ingroup Elm_Slider
|
|
*/
|
|
EAPI double elm_slider_value_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Invert a given slider widget's displaying values order
|
|
*
|
|
* A slider may be 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.
|
|
*
|
|
* @param[in] inverted Use @c true to make @c obj inverted, @c false to bring
|
|
* it back to default, non-inverted values.
|
|
*
|
|
* @ingroup Elm_Slider
|
|
*/
|
|
EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted);
|
|
|
|
/**
|
|
* @brief Get whether a given slider widget's displaying values are inverted or
|
|
* not.
|
|
*
|
|
* @return Use @c true to make @c obj inverted, @c false to bring it back to
|
|
* default, non-inverted values.
|
|
*
|
|
* @ingroup Elm_Slider
|
|
*/
|
|
EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Set the (exact) length of the bar region of a given slider widget.
|
|
*
|
|
* This sets the minimum width (when in horizontal mode) or height (when in
|
|
* vertical mode) of the actual bar area of the slider @c 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 @c obj will require
|
|
* their own space, which will make @c obj to require more the @c size,
|
|
* actually.
|
|
*
|
|
* @param[in] size The length of the slider's bar region.
|
|
*
|
|
* @ingroup Elm_Slider
|
|
*/
|
|
EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size);
|
|
|
|
/**
|
|
* @brief Get the length set for the bar region of a given slider widget
|
|
*
|
|
* If that size was not set previously, with @ref elm_slider_span_size_set,
|
|
* this call will return $0.
|
|
*
|
|
* @return The length of the slider's bar region.
|
|
*
|
|
* @ingroup Elm_Slider
|
|
*/
|
|
EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Set the format string for the unit label.
|
|
*
|
|
* 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.
|
|
*
|
|
* @param[in] units The format string for the unit display.
|
|
*
|
|
* @ingroup Elm_Slider
|
|
*/
|
|
EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *units);
|
|
|
|
/**
|
|
* @brief Get the unit label format of the slider.
|
|
*
|
|
* Unit label is displayed all the time, if set, after slider's bar. In
|
|
* horizontal mode, at right and in vertical mode, at bottom.
|
|
*
|
|
* @return The format string for the unit display.
|
|
*
|
|
* @ingroup Elm_Slider
|
|
*/
|
|
EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Set the format function pointer for the units label
|
|
*
|
|
* Set the callback function to format the units string.
|
|
*
|
|
* @param[in] func The units format function.
|
|
* @param[in] free_func The freeing function for the format string.
|
|
*
|
|
* @ingroup Elm_Slider
|
|
*/
|
|
EAPI void elm_slider_units_format_function_set(Evas_Object *obj, slider_func_type func, slider_freefunc_type free_func);
|
|
|
|
#include "elm_slider.eo.legacy.h" |