Enumerations | |
enum | Elm_Slider_Indicator_Visible_Mode { ELM_SLIDER_INDICATOR_VISIBLE_MODE_DEFAULT, ELM_SLIDER_INDICATOR_VISIBLE_MODE_ALWAYS, ELM_SLIDER_INDICATOR_VISIBLE_MODE_ON_FOCUS, ELM_SLIDER_INDICATOR_VISIBLE_MODE_NONE } |
Slider's indicator visiblity mode. More... | |
Functions | |
void | elm_config_slider_indicator_visible_mode_set (Elm_Slider_Indicator_Visible_Mode mode) |
Sets the slider's indicator visible mode. More... | |
Elm_Slider_Indicator_Visible_Mode | elm_config_slider_indicator_visible_mode_get (void) |
Get the slider's indicator visible mode. More... | |
EOAPI void | elm_obj_slider_horizontal_set (Eina_Bool horizontal) |
Set the orientation of a given slider widget. More... | |
EOAPI Eina_Bool | elm_obj_slider_horizontal_get (void) |
Get the orientation of a given slider widget. More... | |
EOAPI void | elm_obj_slider_value_set (double val) |
Set the value the slider displays. More... | |
EOAPI double | elm_obj_slider_value_get (void) |
Get the value displayed by the slider. More... | |
EOAPI void | elm_obj_slider_indicator_format_set (const char *indicator) |
Set the format string for the indicator label. More... | |
EOAPI const char * | elm_obj_slider_indicator_format_get (void) |
Get the indicator label format of the slider. More... | |
EOAPI void | elm_obj_slider_inverted_set (Eina_Bool inverted) |
Invert a given slider widget's displaying values order. More... | |
EOAPI Eina_Bool | elm_obj_slider_inverted_get (void) |
Get whether a given slider widget's displaying values are inverted or not. More... | |
EOAPI void | elm_obj_slider_indicator_show_set (Eina_Bool show) |
Set whether to enlarge slider indicator (augmented knob) or not. More... | |
EOAPI Eina_Bool | elm_obj_slider_indicator_show_get (void) |
Get whether a given slider widget's enlarging indicator or not. More... | |
EOAPI void | elm_obj_slider_min_max_set (double min, double max) |
Set the minimum and maximum values for the slider. More... | |
EOAPI void | elm_obj_slider_min_max_get (double *min, double *max) |
Get the minimum and maximum values of the slider. More... | |
EOAPI void | elm_obj_slider_unit_format_set (const char *units) |
Set the format string for the unit label. More... | |
EOAPI const char * | elm_obj_slider_unit_format_get (void) |
Get the unit label format of the slider. More... | |
EOAPI void | elm_obj_slider_indicator_show_on_focus_set (Eina_Bool flag) |
Show the indicator of slider on focus. More... | |
EOAPI Eina_Bool | elm_obj_slider_indicator_show_on_focus_get (void) |
Get whether the indicator of the slider is set or not. More... | |
EOAPI void | elm_obj_slider_span_size_set (Evas_Coord size) |
Set the (exact) length of the bar region of a given slider widget. More... | |
EOAPI Evas_Coord | elm_obj_slider_span_size_get (void) |
Get the length set for the bar region of a given slider widget. More... | |
EOAPI void | elm_obj_slider_step_set (double step) |
Set the step by which slider indicator will move. More... | |
EOAPI double | elm_obj_slider_step_get (void) |
Get the step by which slider indicator moves. More... | |
EOAPI void | elm_obj_slider_indicator_visible_mode_set (Elm_Slider_Indicator_Visible_Mode indicator_visible_mode) |
Set the visible mode of indicator. More... | |
EOAPI Elm_Slider_Indicator_Visible_Mode | elm_obj_slider_indicator_visible_mode_get (void) |
Get the visible mode of indicator. More... | |
EOAPI void | elm_obj_slider_indicator_format_function_set (slider_func_type func, slider_freefunc_type free_func) |
Set the format function pointer for the indicator label. More... | |
EOAPI void | elm_obj_slider_units_format_function_set (slider_func_type func, slider_freefunc_type free_func) |
Set the format function pointer for the units label. More... | |
bool | elm_slider::horizontal_get () const |
Retrieve the orientation of a given slider widget. More... | |
void | elm_slider::horizontal_set (bool horizontal_) const |
Retrieve the orientation of a given slider widget. More... | |
double | elm_slider::value_get () const |
Get the value displayed by the slider. More... | |
void | elm_slider::value_set (double val_) const |
Get the value displayed by the slider. More... | |
std::string | elm_slider::indicator_format_get () const |
Get the indicator label format of the slider. More... | |
void | elm_slider::indicator_format_set (std::string indicator_) const |
Get the indicator label format of the slider. More... | |
bool | elm_slider::inverted_get () const |
Get whether a given slider widget's displaying values are inverted or not. More... | |
void | elm_slider::inverted_set (bool inverted_) const |
Get whether a given slider widget's displaying values are inverted or not. More... | |
bool | elm_slider::indicator_show_get () const |
Get whether a given slider widget's enlarging indicator or not. More... | |
void | elm_slider::indicator_show_set (bool show_) const |
Get whether a given slider widget's enlarging indicator or not. More... | |
void | elm_slider::min_max_get (double *min_, double *max_) const |
Get the minimum and maximum values of the slider. More... | |
void | elm_slider::min_max_set (double min_, double max_) const |
Get the minimum and maximum values of the slider. More... | |
std::string | elm_slider::unit_format_get () const |
Get the unit label format of the slider. More... | |
void | elm_slider::unit_format_set (std::string units_) const |
Get the unit label format of the slider. More... | |
bool | elm_slider::indicator_show_on_focus_get () const |
Get whether the indicator of the slider is set or not. More... | |
void | elm_slider::indicator_show_on_focus_set (bool flag_) const |
Get whether the indicator of the slider is set or not. More... | |
Evas_Coord | elm_slider::span_size_get () const |
Get the length set for the bar region of a given slider widget. More... | |
void | elm_slider::span_size_set (Evas_Coord size_) const |
Get the length set for the bar region of a given slider widget. More... | |
double | elm_slider::step_get () const |
void | elm_slider::step_set (double step_) const |
void | elm_slider_horizontal_set (Elm_Slider *obj, Eina_Bool horizontal) |
Set the orientation of a given slider widget. More... | |
Eina_Bool | elm_slider_horizontal_get (const Elm_Slider *obj) |
Get the orientation of a given slider widget. More... | |
void | elm_slider_value_set (Elm_Slider *obj, double val) |
Set the value the slider displays. More... | |
double | elm_slider_value_get (const Elm_Slider *obj) |
Get the value displayed by the slider. More... | |
void | elm_slider_indicator_format_set (Elm_Slider *obj, const char *indicator) |
Set the format string for the indicator label. More... | |
const char * | elm_slider_indicator_format_get (const Elm_Slider *obj) |
Get the indicator label format of the slider. More... | |
void | elm_slider_inverted_set (Elm_Slider *obj, Eina_Bool inverted) |
Invert a given slider widget's displaying values order. More... | |
Eina_Bool | elm_slider_inverted_get (const Elm_Slider *obj) |
Get whether a given slider widget's displaying values are inverted or not. More... | |
void | elm_slider_indicator_show_set (Elm_Slider *obj, Eina_Bool show) |
Set whether to enlarge slider indicator (augmented knob) or not. More... | |
Eina_Bool | elm_slider_indicator_show_get (const Elm_Slider *obj) |
Get whether a given slider widget's enlarging indicator or not. More... | |
void | elm_slider_min_max_set (Elm_Slider *obj, double min, double max) |
Set the minimum and maximum values for the slider. More... | |
void | elm_slider_min_max_get (const Elm_Slider *obj, double *min, double *max) |
Get the minimum and maximum values of the slider. More... | |
void | elm_slider_unit_format_set (Elm_Slider *obj, const char *units) |
Set the format string for the unit label. More... | |
const char * | elm_slider_unit_format_get (const Elm_Slider *obj) |
Get the unit label format of the slider. More... | |
void | elm_slider_indicator_show_on_focus_set (Elm_Slider *obj, Eina_Bool flag) |
Show the indicator of slider on focus. More... | |
Eina_Bool | elm_slider_indicator_show_on_focus_get (const Elm_Slider *obj) |
Get whether the indicator of the slider is set or not. More... | |
void | elm_slider_span_size_set (Elm_Slider *obj, Evas_Coord size) |
Set the (exact) length of the bar region of a given slider widget. More... | |
Evas_Coord | elm_slider_span_size_get (const Elm_Slider *obj) |
Get the length set for the bar region of a given slider widget. More... | |
void | elm_slider_step_set (Elm_Slider *obj, double step) |
Set the step by which slider indicator will move. More... | |
double | elm_slider_step_get (const Elm_Slider *obj) |
Get the step by which slider indicator moves. More... | |
void | elm_slider_indicator_visible_mode_set (Elm_Slider *obj, Elm_Slider_Indicator_Visible_Mode indicator_visible_mode) |
Set the visible mode of indicator. More... | |
Elm_Slider_Indicator_Visible_Mode | elm_slider_indicator_visible_mode_get (const Elm_Slider *obj) |
Get the visible mode of indicator. More... | |
void | elm_slider_indicator_format_function_set (Elm_Slider *obj, slider_func_type func, slider_freefunc_type free_func) |
Set the format function pointer for the indicator label. More... | |
void | elm_slider_units_format_function_set (Elm_Slider *obj, slider_func_type func, slider_freefunc_type free_func) |
Set the format function pointer for the units label. More... | |
Evas_Object * | elm_slider_add (Evas_Object *parent) |
Add a new slider widget to the given parent Elementary (container) object. More... | |
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."focused"
- When the slider has received focus. (since 1.8)"unfocused"
- When the slider has lost focus. (since 1.8)"language,changed"
- the program's language changed (since 1.9)Available styles for it:
"default"
Default content parts of the slider widget that you can use for are:
Default text parts of the slider widget that you can use for are:
Supported elm_object common APIs.
Here is an example on its usage:
Slider's indicator visiblity mode.
Elm_Slider_Indicator_Visible_Mode elm_config_slider_indicator_visible_mode_get | ( | void | ) |
Get the slider's indicator visible mode.
obj | The slider object. |
ELM_SLIDER_INDICATOR_VISIBLE_MODE_DEFAULT
if not set anything by the user. ELM_SLIDER_INDICATOR_VISIBLE_MODE_ALWAYS
, ELM_SLIDER_INDICATOR_VISIBLE_MODE_ON_FOCUS, ELM_SLIDER_INDICATOR_VISIBLE_MODE_NONE if any of the above is set by user.void elm_config_slider_indicator_visible_mode_set | ( | Elm_Slider_Indicator_Visible_Mode | mode | ) |
Sets the slider's indicator visible mode.
obj | The slider object. |
mode | Elm_Slider_Indicator_Visible_Mode. viewport. |
EOAPI Eina_Bool elm_obj_slider_horizontal_get | ( | void | ) |
Get the orientation of a given slider widget.
EINA_TRUE
, if obj
is set to be horizontal, EINA_FALSE
if it's vertical (and on errors).Referenced by elm_slider_horizontal_get(), and elm_slider::horizontal_get().
EOAPI void elm_obj_slider_horizontal_set | ( | Eina_Bool | horizontal | ) |
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.
[in] | horizontal | Use EINA_TRUE to make obj to be horizontal, EINA_FALSE to make it vertical. |
Referenced by elm_slider_horizontal_set(), and elm_slider::horizontal_set().
EOAPI void elm_obj_slider_indicator_format_function_set | ( | slider_func_type | func, |
slider_freefunc_type | free_func | ||
) |
Set the format function pointer for the indicator label.
Set the callback function to format the indicator string.
[in] | func | The indicator format function. |
[in] | free_func | The freeing function for the format string. |
Referenced by elm_slider_indicator_format_function_set().
EOAPI const char* elm_obj_slider_indicator_format_get | ( | void | ) |
Get the indicator label format of the slider.
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.
Referenced by elm_slider_indicator_format_get(), and elm_slider::indicator_format_get().
EOAPI void elm_obj_slider_indicator_format_set | ( | const char * | indicator | ) |
Set the format string for the indicator label.
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.
[in] | indicator | The format string for the indicator display. |
Referenced by elm_slider_indicator_format_set(), and elm_slider::indicator_format_set().
EOAPI Eina_Bool elm_obj_slider_indicator_show_get | ( | void | ) |
Get whether a given slider widget's enlarging indicator or not.
EINA_TRUE
, if obj
is enlarging indicator, or EINA_FALSE
otherwise (and on errors).Referenced by elm_slider_indicator_show_get(), and elm_slider::indicator_show_get().
EOAPI Eina_Bool elm_obj_slider_indicator_show_on_focus_get | ( | void | ) |
Get whether the indicator of the slider is set or not.
EINA_TRUE
, if indicator is set EINA_FALSE
otherwise. Referenced by elm_slider_indicator_show_on_focus_get(), and elm_slider::indicator_show_on_focus_get().
EOAPI void elm_obj_slider_indicator_show_on_focus_set | ( | Eina_Bool | flag | ) |
Show the indicator of slider on focus.
[in] | flag | @ EINA_TRUE sets the indicator visible |
Referenced by elm_slider_indicator_show_on_focus_set(), and elm_slider::indicator_show_on_focus_set().
EOAPI void elm_obj_slider_indicator_show_set | ( | Eina_Bool | show | ) |
Set whether to enlarge slider indicator (augmented knob) or not.
By default, indicator will be bigger while dragged by the user.
[in] | show | EINA_TRUE will make it enlarge, EINA_FALSE will let the knob always at default size. |
Referenced by elm_slider_indicator_show_set(), and elm_slider::indicator_show_set().
EOAPI Elm_Slider_Indicator_Visible_Mode elm_obj_slider_indicator_visible_mode_get | ( | void | ) |
Get the visible mode of indicator.
Referenced by elm_slider_indicator_visible_mode_get().
EOAPI void elm_obj_slider_indicator_visible_mode_set | ( | Elm_Slider_Indicator_Visible_Mode | indicator_visible_mode | ) |
Set the visible mode of indicator.
[in] | indicator_visible_mode | The indicator visible mode. |
Referenced by elm_slider_indicator_visible_mode_set().
EOAPI Eina_Bool elm_obj_slider_inverted_get | ( | void | ) |
Get whether a given slider widget's displaying values are inverted or not.
EINA_TRUE
, if obj
has inverted values, EINA_FALSE
otherwise (and on errors).Referenced by elm_slider_inverted_get(), and elm_slider::inverted_get().
EOAPI void elm_obj_slider_inverted_set | ( | Eina_Bool | inverted | ) |
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.
[in] | inverted | Use EINA_TRUE to make obj inverted, EINA_FALSE to bring it back to default, non-inverted values. |
Referenced by elm_slider_inverted_set(), and elm_slider::inverted_set().
EOAPI void elm_obj_slider_min_max_get | ( | double * | min, |
double * | max | ||
) |
Get the minimum and maximum values of the slider.
NULL
.[out] | min | The minimum value. |
[out] | max | The maximum value. |
Referenced by elm_slider_min_max_get(), and elm_slider::min_max_get().
EOAPI void elm_obj_slider_min_max_set | ( | double | min, |
double | max | ||
) |
Set the minimum and maximum values for the slider.
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.
[in] | min | The minimum value. |
[in] | max | The maximum value. |
Referenced by elm_slider_min_max_set(), and elm_slider::min_max_set().
EOAPI Evas_Coord elm_obj_slider_span_size_get | ( | void | ) |
Get the length set for the bar region of a given slider widget.
If that size was not set previously, with elm_slider_span_size_set(), this call will return 0
.
Referenced by elm_slider_span_size_get(), and elm_slider::span_size_get().
EOAPI void elm_obj_slider_span_size_set | ( | Evas_Coord | size | ) |
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 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.
obj
will require their own space, which will make obj
to require more the size
, actually.[in] | size | The length of the slider's bar region. |
Referenced by elm_slider_span_size_set(), and elm_slider::span_size_set().
EOAPI double elm_obj_slider_step_get | ( | void | ) |
Get the step by which slider indicator moves.
Referenced by elm_slider_step_get(), and elm_slider::step_get().
EOAPI void elm_obj_slider_step_set | ( | double | step | ) |
Set the step by which slider indicator will move.
This value is used when draggable object is moved automatically i.e., in case of key event when up/down/left/right key is pressed or in case when accessibility is set and flick event is used to inc/dec slider values. By default step value is equal to 0.05.
[in] | step | The step value. |
Referenced by elm_slider_step_set(), and elm_slider::step_set().
EOAPI const char* elm_obj_slider_unit_format_get | ( | void | ) |
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.
Referenced by elm_slider_unit_format_get(), and elm_slider::unit_format_get().
EOAPI void elm_obj_slider_unit_format_set | ( | const char * | units | ) |
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 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.
[in] | units | The format string for the unit display. |
Referenced by elm_slider_unit_format_set(), and elm_slider::unit_format_set().
EOAPI void elm_obj_slider_units_format_function_set | ( | slider_func_type | func, |
slider_freefunc_type | free_func | ||
) |
Set the format function pointer for the units label.
Set the callback function to format the units string.
[in] | func | The units format function. |
[in] | free_func | The freeing function for the format string. |
Referenced by elm_slider_units_format_function_set().
EOAPI double elm_obj_slider_value_get | ( | void | ) |
Get the value displayed by the slider.
Referenced by elm_slider_value_get(), and elm_slider::value_get().
EOAPI void elm_obj_slider_value_set | ( | double | val | ) |
Set the value the slider displays.
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().
[in] | val | The value to be displayed. |
Referenced by elm_slider_value_set(), and elm_slider::value_set().
Evas_Object* elm_slider_add | ( | Evas_Object * | parent | ) |
Add a new slider widget to the given parent Elementary (container) object.
parent | The parent object. |
NULL
, on errors.This function inserts a new slider widget on the canvas.
Eina_Bool elm_slider_horizontal_get | ( | const Elm_Slider * | obj | ) |
Get the orientation of a given slider widget.
EINA_TRUE
, if obj
is set to be horizontal, EINA_FALSE
if it's vertical (and on errors).References elm_obj_slider_horizontal_get().
void elm_slider_horizontal_set | ( | Elm_Slider * | obj, |
Eina_Bool | horizontal | ||
) |
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.
[in] | horizontal | Use EINA_TRUE to make obj to be horizontal, EINA_FALSE to make it vertical. |
References elm_obj_slider_horizontal_set().
void elm_slider_indicator_format_function_set | ( | Elm_Slider * | obj, |
slider_func_type | func, | ||
slider_freefunc_type | free_func | ||
) |
Set the format function pointer for the indicator label.
Set the callback function to format the indicator string.
[in] | func | The indicator format function. |
[in] | free_func | The freeing function for the format string. |
References elm_obj_slider_indicator_format_function_set().
const char* elm_slider_indicator_format_get | ( | const Elm_Slider * | obj | ) |
Get the indicator label format of the slider.
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.
References elm_obj_slider_indicator_format_get().
void elm_slider_indicator_format_set | ( | Elm_Slider * | obj, |
const char * | indicator | ||
) |
Set the format string for the indicator label.
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.
[in] | indicator | The format string for the indicator display. |
References elm_obj_slider_indicator_format_set().
Eina_Bool elm_slider_indicator_show_get | ( | const Elm_Slider * | obj | ) |
Get whether a given slider widget's enlarging indicator or not.
EINA_TRUE
, if obj
is enlarging indicator, or EINA_FALSE
otherwise (and on errors).References elm_obj_slider_indicator_show_get().
Eina_Bool elm_slider_indicator_show_on_focus_get | ( | const Elm_Slider * | obj | ) |
Get whether the indicator of the slider is set or not.
EINA_TRUE
, if indicator is set EINA_FALSE
otherwise. References elm_obj_slider_indicator_show_on_focus_get().
void elm_slider_indicator_show_on_focus_set | ( | Elm_Slider * | obj, |
Eina_Bool | flag | ||
) |
Show the indicator of slider on focus.
[in] | flag | @ EINA_TRUE sets the indicator visible |
References elm_obj_slider_indicator_show_on_focus_set().
void elm_slider_indicator_show_set | ( | Elm_Slider * | obj, |
Eina_Bool | show | ||
) |
Set whether to enlarge slider indicator (augmented knob) or not.
By default, indicator will be bigger while dragged by the user.
[in] | show | EINA_TRUE will make it enlarge, EINA_FALSE will let the knob always at default size. |
References elm_obj_slider_indicator_show_set().
Elm_Slider_Indicator_Visible_Mode elm_slider_indicator_visible_mode_get | ( | const Elm_Slider * | obj | ) |
Get the visible mode of indicator.
References elm_obj_slider_indicator_visible_mode_get().
void elm_slider_indicator_visible_mode_set | ( | Elm_Slider * | obj, |
Elm_Slider_Indicator_Visible_Mode | indicator_visible_mode | ||
) |
Set the visible mode of indicator.
[in] | indicator_visible_mode | The indicator visible mode. |
References elm_obj_slider_indicator_visible_mode_set().
Eina_Bool elm_slider_inverted_get | ( | const Elm_Slider * | obj | ) |
Get whether a given slider widget's displaying values are inverted or not.
EINA_TRUE
, if obj
has inverted values, EINA_FALSE
otherwise (and on errors).References elm_obj_slider_inverted_get().
void elm_slider_inverted_set | ( | Elm_Slider * | obj, |
Eina_Bool | inverted | ||
) |
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.
[in] | inverted | Use EINA_TRUE to make obj inverted, EINA_FALSE to bring it back to default, non-inverted values. |
References elm_obj_slider_inverted_set().
void elm_slider_min_max_get | ( | const Elm_Slider * | obj, |
double * | min, | ||
double * | max | ||
) |
Get the minimum and maximum values of the slider.
NULL
.[out] | min | The minimum value. |
[out] | max | The maximum value. |
References elm_obj_slider_min_max_get().
void elm_slider_min_max_set | ( | Elm_Slider * | obj, |
double | min, | ||
double | max | ||
) |
Set the minimum and maximum values for the slider.
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.
[in] | min | The minimum value. |
[in] | max | The maximum value. |
References elm_obj_slider_min_max_set().
Evas_Coord elm_slider_span_size_get | ( | const Elm_Slider * | obj | ) |
Get the length set for the bar region of a given slider widget.
If that size was not set previously, with elm_slider_span_size_set(), this call will return 0
.
References elm_obj_slider_span_size_get().
void elm_slider_span_size_set | ( | Elm_Slider * | obj, |
Evas_Coord | size | ||
) |
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 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.
obj
will require their own space, which will make obj
to require more the size
, actually.[in] | size | The length of the slider's bar region. |
References elm_obj_slider_span_size_set().
double elm_slider_step_get | ( | const Elm_Slider * | obj | ) |
Get the step by which slider indicator moves.
References elm_obj_slider_step_get().
void elm_slider_step_set | ( | Elm_Slider * | obj, |
double | step | ||
) |
Set the step by which slider indicator will move.
This value is used when draggable object is moved automatically i.e., in case of key event when up/down/left/right key is pressed or in case when accessibility is set and flick event is used to inc/dec slider values. By default step value is equal to 0.05.
[in] | step | The step value. |
References elm_obj_slider_step_set().
const char* elm_slider_unit_format_get | ( | const Elm_Slider * | obj | ) |
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.
References elm_obj_slider_unit_format_get().
void elm_slider_unit_format_set | ( | Elm_Slider * | obj, |
const char * | units | ||
) |
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 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.
[in] | units | The format string for the unit display. |
References elm_obj_slider_unit_format_set().
void elm_slider_units_format_function_set | ( | Elm_Slider * | obj, |
slider_func_type | func, | ||
slider_freefunc_type | free_func | ||
) |
Set the format function pointer for the units label.
Set the callback function to format the units string.
[in] | func | The units format function. |
[in] | free_func | The freeing function for the format string. |
References elm_obj_slider_units_format_function_set().
double elm_slider_value_get | ( | const Elm_Slider * | obj | ) |
Get the value displayed by the slider.
References elm_obj_slider_value_get().
void elm_slider_value_set | ( | Elm_Slider * | obj, |
double | val | ||
) |
Set the value the slider displays.
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().
[in] | val | The value to be displayed. |
References elm_obj_slider_value_set().
|
inline |
Retrieve the orientation of a given slider widget.
EINA_TRUE
, if obj
is set to be horizontal, EINA_FALSE
if it's vertical (and on errors).horizontal | Use EINA_TRUE to make obj to be horizontal, EINA_FALSE to make it vertical. |
References elm_obj_slider_horizontal_get().
|
inline |
Retrieve the orientation of a given slider widget.
EINA_TRUE
, if obj
is set to be horizontal, EINA_FALSE
if it's vertical (and on errors).horizontal | Use EINA_TRUE to make obj to be horizontal, EINA_FALSE to make it vertical. |
References elm_obj_slider_horizontal_set().
|
inline |
Get the indicator label format of the slider.
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.
indicator | The format string for the indicator display. |
References elm_obj_slider_indicator_format_get().
|
inline |
Get the indicator label format of the slider.
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.
indicator | The format string for the indicator display. |
References elm_obj_slider_indicator_format_set().
|
inline |
Get whether a given slider widget's enlarging indicator or not.
EINA_TRUE
, if obj
is enlarging indicator, or EINA_FALSE
otherwise (and on errors).show | EINA_TRUE will make it enlarge, EINA_FALSE will let the knob always at default size. |
References elm_obj_slider_indicator_show_get().
|
inline |
Get whether the indicator of the slider is set or not.
EINA_TRUE
, if indicator is set EINA_FALSE
otherwise.flag | @ EINA_TRUE sets the indicator visible |
References elm_obj_slider_indicator_show_on_focus_get().
|
inline |
Get whether the indicator of the slider is set or not.
EINA_TRUE
, if indicator is set EINA_FALSE
otherwise.flag | @ EINA_TRUE sets the indicator visible |
References elm_obj_slider_indicator_show_on_focus_set().
|
inline |
Get whether a given slider widget's enlarging indicator or not.
EINA_TRUE
, if obj
is enlarging indicator, or EINA_FALSE
otherwise (and on errors).show | EINA_TRUE will make it enlarge, EINA_FALSE will let the knob always at default size. |
References elm_obj_slider_indicator_show_set().
|
inline |
Get whether a given slider widget's displaying values are inverted or not.
EINA_TRUE
, if obj
has inverted values, EINA_FALSE
otherwise (and on errors).inverted | Use EINA_TRUE to make obj inverted, EINA_FALSE to bring it back to default, non-inverted values. |
References elm_obj_slider_inverted_get().
|
inline |
Get whether a given slider widget's displaying values are inverted or not.
EINA_TRUE
, if obj
has inverted values, EINA_FALSE
otherwise (and on errors).inverted | Use EINA_TRUE to make obj inverted, EINA_FALSE to bring it back to default, non-inverted values. |
References elm_obj_slider_inverted_set().
|
inline |
Get the minimum and maximum values of the slider.
NULL
.min | The minimum value. |
max | The maximum value. |
References elm_obj_slider_min_max_get().
|
inline |
Get the minimum and maximum values of the slider.
NULL
.min | The minimum value. |
max | The maximum value. |
References elm_obj_slider_min_max_set().
|
inline |
Get the length set for the bar region of a given slider widget.
If that size was not set previously, with elm_slider_span_size_set(), this call will return 0
.
size | The length of the slider's bar region. |
References elm_obj_slider_span_size_get().
|
inline |
Get the length set for the bar region of a given slider widget.
If that size was not set previously, with elm_slider_span_size_set(), this call will return 0
.
size | The length of the slider's bar region. |
References elm_obj_slider_span_size_set().
|
inline |
step | The step value. |
References elm_obj_slider_step_get().
|
inline |
step | The step value. |
References elm_obj_slider_step_set().
|
inline |
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.
units | The format string for the unit display. |
References elm_obj_slider_unit_format_get().
|
inline |
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.
units | The format string for the unit display. |
References elm_obj_slider_unit_format_set().
|
inline |
Get the value displayed by the slider.
val | The value to be displayed. |
References elm_obj_slider_value_get().
|
inline |
Get the value displayed by the slider.
val | The value to be displayed. |
References elm_obj_slider_value_set().