Tizen Native API  5.0
Actionslider

actionslider_inheritance_tree.png

An actionslider is a switcher for 2 or 3 labels with customizable magnet properties. The user drags and releases the indicator, to choose a label.

Labels occupy the following positions. a. Left b. Right c. Center

Positions can be enabled or disabled.

Magnets can be set on the above positions.

When the indicator is released, it will move to its nearest "enabled and magnetized" position.

Note:
By default all positions are set as enabled.

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

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

  • "selected" - when user selects an enabled position (the label is passed as event info).
  • "pos_changed" - when the indicator reaches any of the positions("left", "right" or "center").
  • "language,changed" - the program's language changed (since 1.9)

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

  • "indicator" - An indicator label of the actionslider
  • "left" - A left label of the actionslider
  • "right" - A right label of the actionslider
  • "center" - A center label of the actionslider

Supported elm_object common APIs.

See an example of actionslider usage here

Functions

void elm_actionslider_indicator_pos_set (Elm_Actionslider *obj, Elm_Actionslider_Pos pos)
 Actionslider position indicator.
Elm_Actionslider_Pos elm_actionslider_indicator_pos_get (const Elm_Actionslider *obj)
 Actionslider position indicator.
void elm_actionslider_magnet_pos_set (Elm_Actionslider *obj, Elm_Actionslider_Pos pos)
 Actionslider magnet position.
Elm_Actionslider_Pos elm_actionslider_magnet_pos_get (const Elm_Actionslider *obj)
 Actionslider magnet position.
void elm_actionslider_enabled_pos_set (Elm_Actionslider *obj, Elm_Actionslider_Pos pos)
 Actionslider enabled position.
Elm_Actionslider_Pos elm_actionslider_enabled_pos_get (const Elm_Actionslider *obj)
 Actionslider enabled position.
const char * elm_actionslider_selected_label_get (const Elm_Actionslider *obj)
 Get actionslider selected label.
Evas_Objectelm_actionslider_add (Evas_Object *parent)

Enumeration Type Documentation

A position for indicators, magnets, and enabled items.

Enumerator:
ELM_ACTIONSLIDER_NONE 

No position is set.

ELM_ACTIONSLIDER_LEFT 

Left position.

ELM_ACTIONSLIDER_CENTER 

Center position.

ELM_ACTIONSLIDER_RIGHT 

Right position.

ELM_ACTIONSLIDER_ALL 

All positions for left/center/right.


Function Documentation

Add a new actionslider to the parent.

Parameters:
parentThe parent object
Returns:
The new actionslider object or NULL if it cannot be created
Examples:
actionslider_example_01.c.
Elm_Actionslider_Pos elm_actionslider_enabled_pos_get ( const Elm_Actionslider *  obj)

Actionslider enabled position.

Parameters:
[in]objThe object.
Returns:
Bit mask indicating the enabled positions.
void elm_actionslider_enabled_pos_set ( Elm_Actionslider *  obj,
Elm_Actionslider_Pos  pos 
)

Actionslider enabled position.

To set multiple positions as enabled OR them together(e.g. ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).

Note:
All the positions are enabled by default.
Parameters:
[in]objThe object.
[in]posBit mask indicating the enabled positions.
Examples:
actionslider_example_01.c.
Elm_Actionslider_Pos elm_actionslider_indicator_pos_get ( const Elm_Actionslider *  obj)

Actionslider position indicator.

Parameters:
[in]objThe object.
Returns:
The position of the indicator.
void elm_actionslider_indicator_pos_set ( Elm_Actionslider *  obj,
Elm_Actionslider_Pos  pos 
)

Actionslider position indicator.

Parameters:
[in]objThe object.
[in]posThe position of the indicator.
Examples:
actionslider_example_01.c.
Elm_Actionslider_Pos elm_actionslider_magnet_pos_get ( const Elm_Actionslider *  obj)

Actionslider magnet position.

Parameters:
[in]objThe object.
Returns:
Bit mask indicating the magnet positions.
void elm_actionslider_magnet_pos_set ( Elm_Actionslider *  obj,
Elm_Actionslider_Pos  pos 
)

Actionslider magnet position.

To make multiple positions magnets OR them together (e.g. ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)

Parameters:
[in]objThe object.
[in]posBit mask indicating the magnet positions.
Examples:
actionslider_example_01.c.
const char* elm_actionslider_selected_label_get ( const Elm_Actionslider *  obj)

Get actionslider selected label.

Parameters:
[in]objThe object.
Returns:
Selected label
Examples:
actionslider_example_01.c.