Spinner

Functions

Evas_Object * elm_spinner_add (Evas_Object *parent)
 Add a new spinner widget to the given parent Elementary (container) object.
void elm_spinner_label_format_set (Evas_Object *obj, const char *fmt)
 Set the format string of the displayed label.
const char * elm_spinner_label_format_get (const Evas_Object *obj)
 Get the label format of the spinner.
void elm_spinner_min_max_set (Evas_Object *obj, double min, double max)
 Set the minimum and maximum values for the spinner.
void elm_spinner_min_max_get (const Evas_Object *obj, double *min, double *max)
 Get the minimum and maximum values of the spinner.
void elm_spinner_step_set (Evas_Object *obj, double step)
 Set the step used to increment or decrement the spinner value.
double elm_spinner_step_get (const Evas_Object *obj)
 Get the step used to increment or decrement the spinner value.
void elm_spinner_value_set (Evas_Object *obj, double val)
 Set the value the spinner displays.
double elm_spinner_value_get (const Evas_Object *obj)
 Get the value displayed by the spinner.
void elm_spinner_wrap_set (Evas_Object *obj, Eina_Bool wrap)
 Set whether the spinner should wrap when it reaches its minimum or maximum value.
Eina_Bool elm_spinner_wrap_get (const Evas_Object *obj)
 Get whether the spinner should wrap when it reaches its minimum or maximum value.
void elm_spinner_editable_set (Evas_Object *obj, Eina_Bool editable)
 Set whether the spinner can be directly edited by the user or not.
Eina_Bool elm_spinner_editable_get (const Evas_Object *obj)
 Get whether the spinner can be directly edited by the user or not.
void elm_spinner_special_value_add (Evas_Object *obj, double value, const char *label)
 Set a special string to display in the place of the numerical value.
void elm_spinner_interval_set (Evas_Object *obj, double interval)
 Set the interval on time updates for an user mouse button hold on spinner widgets' arrows.
double elm_spinner_interval_get (const Evas_Object *obj)
 Get the interval on time updates for an user mouse button hold on spinner widgets' arrows.
void elm_spinner_base_set (Evas_Object *obj, double base)
 Set the base for rounding.
double elm_spinner_base_get (const Evas_Object *obj)
 Get the base for rounding.
void elm_spinner_round_set (Evas_Object *obj, int rnd)
 Set the round value for rounding.
int elm_spinner_round_get (const Evas_Object *obj)
 Get the round value for rounding.

Detailed Description

spinner_inheritance_tree.png
preview-00.png

A spinner is a widget which allows the user to increase or decrease numeric values using arrow buttons, or edit values directly, clicking over it and typing the new value.

By default the spinner will not wrap and has a label of "%.0f" (just showing the integer value of the double).

A spinner has a label that is formatted with floating point values and thus accepts a printf-style format string, like “%1.2f units”.

It also allows specific values to be replaced by pre-defined labels.

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

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

  • "changed" - Whenever the spinner value is changed.
  • "delay,changed" - A short time after the value is changed by the user. This will be called only when the user stops dragging for a very short period or when they release their finger/mouse, so it avoids possibly expensive reactions to the value change.

Available styles for it:

  • "default";
  • "vertical": up/down buttons at the right side and text left aligned.

Supported elm_object common APIs.

Here is an example on its usage: Spinner widget example


Function Documentation

Evas_Object* elm_spinner_add ( Evas_Object *  parent)

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

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

This function inserts a new spinner widget on the canvas.

double elm_spinner_base_get ( const Evas_Object *  obj)

Get the base for rounding.

Parameters:
objThe spinner object
Returns:
The base rounding value

This returns the base for rounding.

See also:
elm_spinner_round_set() too.
elm_spinner_base_set() too.
void elm_spinner_base_set ( Evas_Object *  obj,
double  base 
)

Set the base for rounding.

Parameters:
objThe spinner object
baseThe base value

Rounding works as follows:

rounded_val = base + (double)(((value - base) / round) * round)

Where rounded_val, value and base are doubles, and round is an integer.

This means that things will be rounded to increments (or decrements) of "round" starting from value base. The default base for rounding is 0.

Example: round = 3, base = 2 Values: 3, 6, 9, 12, 15, ...

Example: round = 2, base = 5.5 Values: 5.5, 7.5, 9.5, 11.5, ...

See also:
elm_spinner_round_get()
elm_spinner_base_get() too.
Eina_Bool elm_spinner_editable_get ( const Evas_Object *  obj)

Get whether the spinner can be directly edited by the user or not.

Parameters:
objThe spinner object.
Returns:
EINA_TRUE means edition is enabled. EINA_FALSE indicates it's disabled. If obj is NULL, EINA_FALSE is returned.
See also:
elm_spinner_editable_set() for details.
void elm_spinner_editable_set ( Evas_Object *  obj,
Eina_Bool  editable 
)

Set whether the spinner can be directly edited by the user or not.

Parameters:
objThe spinner object.
editableEINA_TRUE to allow users to edit it or EINA_FALSE to don't allow users to edit it directly.

Spinner objects can have edition disabled, in which state they will be changed only by arrows. Useful for contexts where you don't want your users to interact with it writing the value. Specially when using special values, the user can see real value instead of special label on edition.

It's enabled by default.

See also:
elm_spinner_editable_get()
double elm_spinner_interval_get ( const Evas_Object *  obj)

Get the interval on time updates for an user mouse button hold on spinner widgets' arrows.

Parameters:
objThe spinner object.
Returns:
The (first) interval value, in seconds, set on it.
See also:
elm_spinner_interval_set() for more details.
void elm_spinner_interval_set ( Evas_Object *  obj,
double  interval 
)

Set the interval on time updates for an user mouse button hold on spinner widgets' arrows.

Parameters:
objThe spinner object.
intervalThe (first) interval value in seconds.

This interval value is decreased while the user holds the mouse pointer either incrementing or decrementing spinner's value.

This helps the user to get to a given value distant from the current one easier/faster, as it will start to change quicker and quicker on mouse button holds.

The calculation for the next change interval value, starting from the one set with this call, is the previous interval divided by 1.05, so it decreases a little bit.

The default starting interval value for automatic changes is 0.85 seconds.

See also:
elm_spinner_interval_get()
const char* elm_spinner_label_format_get ( const Evas_Object *  obj)

Get the label format of the spinner.

Parameters:
objThe spinner object.
Returns:
The text label format string in UTF-8.
See also:
elm_spinner_label_format_set() for details.
void elm_spinner_label_format_set ( Evas_Object *  obj,
const char *  fmt 
)

Set the format string of the displayed label.

Parameters:
objThe spinner object.
fmtThe format string for the label display.

If NULL, this sets the format to "%.0f". If not it sets the format string for the label text. The label text is provided a floating point value, so the label text can display up to 1 floating point value. Note that this is optional.

Use a format string such as "%1.2f meters" for example, and it will display values like: "3.14 meters" for a value equal to 3.14159.

Default is "%0.f".

See also:
elm_spinner_label_format_get()

References elm_layout_sizing_eval().

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

Get the minimum and maximum values of the spinner.

Parameters:
objThe spinner 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_spinner_min_max_set() for details.
void elm_spinner_min_max_set ( Evas_Object *  obj,
double  min,
double  max 
)

Set the minimum and maximum values for the spinner.

Parameters:
objThe spinner 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_spinner_value_get().

By default, min is equal to 0, and max is equal to 100.

Warning:
Maximum must be greater than minimum.
See also:
elm_spinner_min_max_get()
int elm_spinner_round_get ( const Evas_Object *  obj)

Get the round value for rounding.

Parameters:
objThe spinner object
Returns:
The rounding value

This returns the round value for rounding.

See also:
elm_spinner_round_set() too.
elm_spinner_base_set() too.
void elm_spinner_round_set ( Evas_Object *  obj,
int  rnd 
)

Set the round value for rounding.

Parameters:
objThe spinner object
rndThe rounding value

Sets the rounding value used for value rounding in the spinner.

See also:
elm_spinner_round_get()
elm_spinner_base_set()
void elm_spinner_special_value_add ( Evas_Object *  obj,
double  value,
const char *  label 
)

Set a special string to display in the place of the numerical value.

Parameters:
objThe spinner object.
valueThe value to be replaced.
labelThe label to be used.

It's useful for cases when a user should select an item that is better indicated by a label than a value. For example, weekdays or months.

E.g.:

 sp = elm_spinner_add(win);
 elm_spinner_min_max_set(sp, 1, 3);
 elm_spinner_special_value_add(sp, 1, "January");
 elm_spinner_special_value_add(sp, 2, "February");
 elm_spinner_special_value_add(sp, 3, "March");
 evas_object_show(sp);
double elm_spinner_step_get ( const Evas_Object *  obj)

Get the step used to increment or decrement the spinner value.

Parameters:
objThe spinner object.
Returns:
The step value.
See also:
elm_spinner_step_get() for more details.
void elm_spinner_step_set ( Evas_Object *  obj,
double  step 
)

Set the step used to increment or decrement the spinner value.

Parameters:
objThe spinner object.
stepThe step value.

This value will be incremented or decremented to the displayed value. It will be incremented while the user keep right or top arrow pressed, and will be decremented while the user keep left or bottom arrow pressed.

The interval to increment / decrement can be set with elm_spinner_interval_set().

By default step value is equal to 1.

See also:
elm_spinner_step_get()
double elm_spinner_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_spinner_value_set ( Evas_Object *  obj,
double  val 
)

Set the value the spinner displays.

Parameters:
objThe spinner object.
valThe value to be displayed.

Value will be presented on the label following format specified with elm_spinner_format_set().

Warning:
The value must to be between min and max values. This values are set by elm_spinner_min_max_set().
See also:
elm_spinner_value_get().
elm_spinner_format_set().
elm_spinner_min_max_set().
Eina_Bool elm_spinner_wrap_get ( const Evas_Object *  obj)

Get whether the spinner should wrap when it reaches its minimum or maximum value.

Parameters:
objThe spinner object
Returns:
EINA_TRUE means wrap is enabled. EINA_FALSE indicates it's disabled. If obj is NULL, EINA_FALSE is returned.
See also:
elm_spinner_wrap_set() for details.
void elm_spinner_wrap_set ( Evas_Object *  obj,
Eina_Bool  wrap 
)

Set whether the spinner should wrap when it reaches its minimum or maximum value.

Parameters:
objThe spinner object.
wrapEINA_TRUE to enable wrap or EINA_FALSE to disable it.

Disabled by default. If disabled, when the user tries to increment the value, but displayed value plus step value is bigger than maximum value, the spinner won't allow it. The same happens when the user tries to decrement it, but the value less step is less than minimum value.

When wrap is enabled, in such situations it will allow these changes, but will get the value that would be less than minimum and subtracts from maximum. Or add the value that would be more than maximum to the minimum.

E.g.:

  • min value = 10
  • max value = 50
  • step value = 20
  • displayed value = 20

When the user decrement value (using left or bottom arrow), it will displays 40, because max - (min - (displayed - step)) is 50 - (10 - (20 - 20)) = 40.

See also:
elm_spinner_wrap_get().