Slider

Functions

Evas_Object * elm_slider_add (Evas_Object *parent)
 Add a new slider widget to the given parent Elementary (container) object.
void elm_slider_span_size_set (Evas_Object *obj, Evas_Coord size)
 Set the (exact) length of the bar region of a given slider widget.
Evas_Coord elm_slider_span_size_get (const Evas_Object *obj)
 Get the length set for the bar region of a given slider widget.
void elm_slider_unit_format_set (Evas_Object *obj, const char *format)
 Set the format string for the unit label.
const char * elm_slider_unit_format_get (const Evas_Object *obj)
 Get the unit label format of the slider.
void elm_slider_indicator_format_set (Evas_Object *obj, const char *indicator)
 Set the format string for the indicator label.
const char * elm_slider_indicator_format_get (const Evas_Object *obj)
 Get the indicator label format of the slider.
void elm_slider_indicator_format_function_set (Evas_Object *obj, char *(*func)(double val), void(*free_func)(char *str))
 Set the format function pointer for the indicator label.
void elm_slider_units_format_function_set (Evas_Object *obj, char *(*func)(double val), void(*free_func)(char *str))
 Set the format function pointer for the units label.
void elm_slider_horizontal_set (Evas_Object *obj, Eina_Bool horizontal)
 Set the orientation of a given slider widget.
Eina_Bool elm_slider_horizontal_get (const Evas_Object *obj)
 Retrieve the orientation of a given slider widget.
void elm_slider_min_max_set (Evas_Object *obj, double min, double max)
 Set the minimum and maximum values for the slider.
void elm_slider_min_max_get (const Evas_Object *obj, double *min, double *max)
 Get the minimum and maximum values of the slider.
void elm_slider_value_set (Evas_Object *obj, double val)
 Set the value the slider displays.
double elm_slider_value_get (const Evas_Object *obj)
 Get the value displayed by the spinner.
void elm_slider_inverted_set (Evas_Object *obj, Eina_Bool inverted)
 Invert a given slider widget's displaying values order.
Eina_Bool elm_slider_inverted_get (const Evas_Object *obj)
 Get whether a given slider widget's displaying values are inverted or not.
void elm_slider_indicator_show_set (Evas_Object *obj, Eina_Bool show)
 Set whether to enlarge slider indicator (augmented knob) or not.
Eina_Bool elm_slider_indicator_show_get (const Evas_Object *obj)
 Get whether a given slider widget's enlarging indicator or not.

Detailed Description

slider_inheritance_tree.png
preview-00.png

The slider adds a draggable “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().

This widget inherits from the Layout one, so that all the functions acting on it also work for slider objects.

This widget emits the following signals, besides the ones sent from Layout:

  • "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:

  • "default"

Default content parts of the slider widget that you can use for are:

  • "icon" - An icon of the slider
  • "end" - A end part content of the slider

Default text parts of the slider widget that you can use for are:

  • "default" - Label of the slider

Supported elm_object common APIs.

Here is an example on its usage:


Function Documentation

Evas_Object* elm_slider_add ( Evas_Object *  parent)

Add a new slider widget to the given parent Elementary (container) object.

Parameters:
parentThe parent object.
Returns:
a new slider widget handle or NULL, on errors.

This function inserts a new slider widget on the canvas.

Eina_Bool elm_slider_horizontal_get ( const Evas_Object *  obj)

Retrieve the orientation of a given slider widget.

Parameters:
objThe slider object.
Returns:
EINA_TRUE, if obj is set to be horizontal, EINA_FALSE if it's vertical (and on errors).
See also:
elm_slider_horizontal_set() for more details.
void elm_slider_horizontal_set ( Evas_Object *  obj,
Eina_Bool  horizontal 
)

Set the orientation of a given slider widget.

Parameters:
objThe slider object.
horizontalUse EINA_TRUE to make obj to be horizontal, EINA_FALSE to make it vertical.

Use this function to change how your slider is to be disposed: vertically or horizontally.

By default it's displayed horizontally.

See also:
elm_slider_horizontal_get()

References ELM_WIDGET_DATA.

void elm_slider_indicator_format_function_set ( Evas_Object *  obj,
char *(*)(double val)  func,
void(*)(char *str)  free_func 
)

Set the format function pointer for the indicator label.

Parameters:
objThe slider object.
funcThe indicator format function.
free_funcThe freeing function for the format string.

Set the callback function to format the indicator string.

See also:
elm_slider_indicator_format_set() for more info on how this works.
Examples:
slider_example.c.
const char* elm_slider_indicator_format_get ( const Evas_Object *  obj)

Get the indicator label format of the slider.

Parameters:
objThe slider object.
Returns:
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 also:
elm_slider_indicator_format_set() for more information on how this works.
void elm_slider_indicator_format_set ( Evas_Object *  obj,
const char *  indicator 
)

Set the format string for the indicator label.

Parameters:
objThe slider object.
indicatorThe 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 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 also:
elm_slider_indicator_format_get()
Eina_Bool elm_slider_indicator_show_get ( const Evas_Object *  obj)

Get whether a given slider widget's enlarging indicator or not.

Parameters:
objThe slider object.
Returns:
EINA_TRUE, if obj is enlarging indicator, or EINA_FALSE otherwise (and on errors).
See also:
elm_slider_indicator_show_set() for details.
void elm_slider_indicator_show_set ( Evas_Object *  obj,
Eina_Bool  show 
)

Set whether to enlarge slider indicator (augmented knob) or not.

Parameters:
objThe slider object.
showEINA_TRUE will make it enlarge, 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.

References elm_layout_signal_emit().

Eina_Bool elm_slider_inverted_get ( const Evas_Object *  obj)

Get whether a given slider widget's displaying values are inverted or not.

Parameters:
objThe slider object.
Returns:
EINA_TRUE, if obj has inverted values, EINA_FALSE otherwise (and on errors).
See also:
elm_slider_inverted_set() for more details.
void elm_slider_inverted_set ( Evas_Object *  obj,
Eina_Bool  inverted 
)

Invert a given slider widget's displaying values order.

Parameters:
objThe slider object.
invertedUse EINA_TRUE to make obj inverted, EINA_FALSE to bring it back to default, non-inverted values.

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.

See also:
elm_slider_inverted_get()

References elm_layout_signal_emit(), and ELM_WIDGET_DATA.

void elm_slider_min_max_get ( const Evas_Object *  obj,
double *  min,
double *  max 
)

Get the minimum and maximum values of the slider.

Parameters:
objThe slider object.
minPointer to store the minimum value.
maxPointer to store the maximum value.
Note:
If only one value is needed, the other pointer can be passed as NULL.
See also:
elm_slider_min_max_set() for details.
void elm_slider_min_max_set ( Evas_Object *  obj,
double  min,
double  max 
)

Set the minimum and maximum values for the slider.

Parameters:
objThe slider object.
minThe minimum value.
maxThe maximum value.

Define the allowed range of values to be selected by the user.

If actual value is less than min, it will be updated to min. If it is bigger then max, will be updated to 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 also:
elm_slider_min_max_get()
Evas_Coord elm_slider_span_size_get ( const Evas_Object *  obj)

Get the length set for the bar region of a given slider widget.

Parameters:
objThe slider object.
Returns:
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 0.

void elm_slider_span_size_set ( Evas_Object *  obj,
Evas_Coord  size 
)

Set the (exact) length of the bar region of a given slider widget.

Parameters:
objThe slider object.
sizeThe 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 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 obj will require their own space, which will make obj to require more the size, actually.
See also:
elm_slider_span_size_get()

References elm_layout_signal_emit().

const char* elm_slider_unit_format_get ( const Evas_Object *  obj)

Get the unit label format of the slider.

Parameters:
objThe slider object.
Returns:
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 also:
elm_slider_unit_format_set() for more information on how this works.
void elm_slider_unit_format_set ( Evas_Object *  obj,
const char *  format 
)

Set the format string for the unit label.

Parameters:
objThe slider object.
formatThe 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 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 also:
elm_slider_indicator_format_get()

References elm_layout_signal_emit(), and ELM_WIDGET_DATA.

void elm_slider_units_format_function_set ( Evas_Object *  obj,
char *(*)(double val)  func,
void(*)(char *str)  free_func 
)

Set the format function pointer for the units label.

Parameters:
objThe slider object.
funcThe units format function.
free_funcThe freeing function for the format string.

Set the callback function to format the units string.

See also:
elm_slider_unit_format_set() for more info on how this works.
double elm_slider_value_get ( const Evas_Object *  obj)

Get the value displayed by the spinner.

Parameters:
objThe spinner object.
Returns:
The value displayed.
See also:
elm_spinner_value_set() for details.
void elm_slider_value_set ( Evas_Object *  obj,
double  val 
)

Set the value the slider displays.

Parameters:
objThe slider object.
valThe 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 also:
elm_slider_value_get()
elm_slider_unit_format_set()
elm_slider_indicator_format_set()
elm_slider_min_max_set()