Enumerations | Functions
Actionslider

Enumerations

enum  Elm_Actionslider_Pos {
  ELM_ACTIONSLIDER_NONE = 0,
  ELM_ACTIONSLIDER_LEFT = 1,
  ELM_ACTIONSLIDER_CENTER = 2,
  ELM_ACTIONSLIDER_RIGHT = 4,
  ELM_ACTIONSLIDER_ALL = 7
}
 A position for indicators, magnets, and enabled items. More...
 

Functions

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

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:

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

Supported elm_object common APIs.

See an example of actionslider usage here

Enumeration Type Documentation

◆ Elm_Actionslider_Pos

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

◆ elm_actionslider_indicator_pos_set()

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.

◆ elm_actionslider_indicator_pos_get()

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.

◆ elm_actionslider_magnet_pos_set()

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.

◆ elm_actionslider_magnet_pos_get()

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.

◆ elm_actionslider_enabled_pos_set()

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.

◆ elm_actionslider_enabled_pos_get()

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.

◆ elm_actionslider_selected_label_get()

const char* elm_actionslider_selected_label_get ( const Elm_Actionslider *  obj)

Get actionslider selected label.

Parameters
[in]objThe object.
Returns
Selected label

◆ elm_actionslider_add()

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