Actionslider

Functions

Evas_Object * elm_actionslider_add (Evas_Object *parent)
 Add a new actionslider to the parent.
const char * elm_actionslider_selected_label_get (const Evas_Object *obj)
 Get actionslider selected label.
void elm_actionslider_indicator_pos_set (Evas_Object *obj, Elm_Actionslider_Pos pos)
 Set actionslider indicator position.
Elm_Actionslider_Pos elm_actionslider_indicator_pos_get (const Evas_Object *obj)
 Get actionslider indicator position.
void elm_actionslider_magnet_pos_set (Evas_Object *obj, Elm_Actionslider_Pos pos)
 Set actionslider magnet position.
Elm_Actionslider_Pos elm_actionslider_magnet_pos_get (const Evas_Object *obj)
 Get actionslider magnet position.
void elm_actionslider_enabled_pos_set (Evas_Object *obj, Elm_Actionslider_Pos pos)
 Set actionslider enabled position.
Elm_Actionslider_Pos elm_actionslider_enabled_pos_get (const Evas_Object *obj)
 Get actionslider enabled position.

Detailed Description

actionslider_inheritance_tree.png
preview-00.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").

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


Function Documentation

Evas_Object* elm_actionslider_add ( Evas_Object *  parent)

Add a new actionslider to the parent.

Parameters:
parentThe parent object
Returns:
The new actionslider object or NULL if it cannot be created
Elm_Actionslider_Pos elm_actionslider_enabled_pos_get ( const Evas_Object *  obj)

Get actionslider enabled position.

Parameters:
objThe actionslider object.
Returns:
The enabled positions.
void elm_actionslider_enabled_pos_set ( Evas_Object *  obj,
Elm_Actionslider_Pos  pos 
)

Set 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:
objThe actionslider object.
posBit mask indicating the enabled positions.
Elm_Actionslider_Pos elm_actionslider_indicator_pos_get ( const Evas_Object *  obj)

Get actionslider indicator position.

Parameters:
objThe actionslider object.
Returns:
The position of the indicator.

References ELM_WIDGET_DATA.

void elm_actionslider_indicator_pos_set ( Evas_Object *  obj,
Elm_Actionslider_Pos  pos 
)

Set actionslider indicator position.

Parameters:
objThe actionslider object.
posThe position of the indicator.

References ELM_WIDGET_DATA.

Elm_Actionslider_Pos elm_actionslider_magnet_pos_get ( const Evas_Object *  obj)

Get actionslider magnet position.

Parameters:
objThe actionslider object.
Returns:
The positions with magnet property.
void elm_actionslider_magnet_pos_set ( Evas_Object *  obj,
Elm_Actionslider_Pos  pos 
)

Set actionslider magnet position.

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

Parameters:
objThe actionslider object.
posBit mask indicating the magnet positions.
const char* elm_actionslider_selected_label_get ( const Evas_Object *  obj)

Get actionslider selected label.

Parameters:
objThe actionslider object
Returns:
The selected label