Radio

Radio is a widget that allows for 1 or more options to be displayed and have the user choose only 1 of them. More...

Functions

Evas_Object * elm_radio_add (Evas_Object *parent)
 Add a new radio to the parent.
void elm_radio_group_add (Evas_Object *obj, Evas_Object *group)
 Add this radio to a group of other radio objects.
void elm_radio_state_value_set (Evas_Object *obj, int value)
 Set the integer value that this radio object represents.
int elm_radio_state_value_get (const Evas_Object *obj)
 Get the integer value that this radio object represents.
void elm_radio_value_set (Evas_Object *obj, int value)
 Set the value of the radio group.
int elm_radio_value_get (const Evas_Object *obj)
 Get the value of the radio group.
void elm_radio_value_pointer_set (Evas_Object *obj, int *valuep)
 Set a convenience pointer to a integer to change when radio group value changes.
Evas_Object * elm_radio_selected_object_get (Evas_Object *obj)
 Get the selected radio object.

Detailed Description

Radio is a widget that allows for 1 or more options to be displayed and have the user choose only 1 of them.

radio_inheritance_tree.png
preview-00.png

A radio object contains an indicator, an optional Label and an optional icon object. While it's possible to have a group of only one radio they, are normally used in groups of 2 or more.

elm_radio objects are grouped in a slightly different, compared to other UI toolkits. There is no seperate group name/id to remember or manage. The members represent the group, there are the group. To make a group, use elm_radio_group_add() and pass existing radio object and the new radio object.

The radio object(s) will select from one of a set of integer values, so any value they are configuring needs to be mapped to a set of integers. To configure what value that radio object represents, use elm_radio_state_value_set() to set the integer it represents. To set the value the whole group(which one is currently selected) is to indicate use elm_radio_value_set() on any group member, and to get the groups value use elm_radio_value_get(). For convenience the radio objects are also able to directly set an integer(int) to the value that is selected. To specify the pointer to this integer to modify, use elm_radio_value_pointer_set(). The radio objects will modify this directly. That implies the pointer must point to valid memory for as long as the radio objects exist.

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

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

  • changed - This is called whenever the user changes the state of one of the radio objects within the group of radio objects that work together.

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

  • "default" - Label of the radio

Default content parts of the radio widget that you can use for are:

  • "icon" - An icon of the radio

Supported elm_object common APIs.

Radio example show most of this API in action.


Function Documentation

Evas_Object* elm_radio_add ( Evas_Object *  parent)

Add a new radio to the parent.

Parameters:
parentThe parent object
Returns:
The new object or NULL if it cannot be created
void elm_radio_group_add ( Evas_Object *  obj,
Evas_Object *  group 
)

Add this radio to a group of other radio objects.

Parameters:
objThe radio object
groupAny object whose group the obj is to join.

Radio objects work in groups. Each member should have a different integer value assigned. In order to have them work as a group, they need to know about each other. This adds the given radio object to the group of which the group object indicated is a member.

Evas_Object* elm_radio_selected_object_get ( Evas_Object *  obj)

Get the selected radio object.

Parameters:
objAny radio object (any object of a group)
Returns:
The selected radio object
int elm_radio_state_value_get ( const Evas_Object *  obj)

Get the integer value that this radio object represents.

Parameters:
objThe radio object
Returns:
The value used if this radio object is selected

This gets the value of the radio.

See also:
elm_radio_value_set()
void elm_radio_state_value_set ( Evas_Object *  obj,
int  value 
)

Set the integer value that this radio object represents.

Parameters:
objThe radio object
valueThe value to use if this radio object is selected

This sets the value of the radio.

int elm_radio_value_get ( const Evas_Object *  obj)

Get the value of the radio group.

Parameters:
objThe radio object (any radio object of the group).
Returns:
The integer state
void elm_radio_value_pointer_set ( Evas_Object *  obj,
int *  valuep 
)

Set a convenience pointer to a integer to change when radio group value changes.

Parameters:
objThe radio object (any object of a group)
valuepPointer to the integer to modify

This sets a pointer to a integer, that, in addition to the radio objects state will also be modified directly. To stop setting the object pointed to simply use NULL as the valuep argument. If valuep is not NULL, then when this is called, the radio objects state will also be modified to reflect the value of the integer valuep points to, just like calling elm_radio_value_set().

void elm_radio_value_set ( Evas_Object *  obj,
int  value 
)

Set the value of the radio group.

Parameters:
objThe radio object (any radio object of the group).
valueThe value to use for the group

This sets the value of the radio group and will also set the value if pointed to, to the value supplied, but will not call any callbacks.