2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @defgroup Radio Radio
|
2012-04-16 18:35:46 -07:00
|
|
|
* @ingroup Elementary
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-06-05 15:41:21 -07:00
|
|
|
* @image html radio_inheritance_tree.png
|
|
|
|
* @image latex radio_inheritance_tree.eps
|
|
|
|
*
|
2011-12-29 23:20:48 -08:00
|
|
|
* @image html img/widget/radio/preview-00.png
|
|
|
|
* @image latex img/widget/radio/preview-00.eps
|
|
|
|
*
|
|
|
|
* @brief Radio is a widget that allows for 1 or more options to be displayed
|
|
|
|
* and have the user choose only 1 of them.
|
|
|
|
*
|
|
|
|
* 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,
|
2012-03-28 02:02:22 -07:00
|
|
|
* are normally used in groups of 2 or more.
|
2012-02-16 00:28:36 -08:00
|
|
|
*
|
|
|
|
* 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,
|
2012-03-28 02:02:22 -07:00
|
|
|
* use elm_radio_group_add() and pass existing radio object and the new radio
|
|
|
|
* object.
|
2012-02-16 00:28:36 -08:00
|
|
|
*
|
|
|
|
* The radio object(s) will select from one of a set
|
2011-12-29 23:20:48 -08:00
|
|
|
* 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.
|
|
|
|
*
|
2012-05-03 15:43:31 -07:00
|
|
|
* This widget inherits from the @ref 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
|
|
|
|
* @ref Layout:
|
2011-12-29 23:20:48 -08:00
|
|
|
* @li 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.
|
elm: added more "focused" and "unfocused" documentations.
genlist, hover, index, list, map, photocam, progressbar, radio, scroller, slider, slideshow, spinner, toolbar, win.
2013-06-09 22:12:51 -07:00
|
|
|
* @li @c "focused" - When the radio has received focus. (since 1.8)
|
|
|
|
* @li @c "unfocused" - When the radio has lost focus. (since 1.8)
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-01-08 22:55:51 -08:00
|
|
|
* Default text parts of the radio widget that you can use for are:
|
|
|
|
* @li "default" - Label of the radio
|
|
|
|
*
|
2012-02-27 18:39:31 -08:00
|
|
|
* Default content parts of the radio widget that you can use for are:
|
2011-12-29 23:20:48 -08:00
|
|
|
* @li "icon" - An icon of the radio
|
|
|
|
*
|
2012-01-08 22:55:51 -08:00
|
|
|
* Supported elm_object common APIs.
|
2012-04-17 13:33:59 -07:00
|
|
|
* @li @ref elm_object_part_text_set
|
|
|
|
* @li @ref elm_object_part_text_get
|
|
|
|
* @li @ref elm_object_part_content_set
|
|
|
|
* @li @ref elm_object_part_content_get
|
|
|
|
* @li @ref elm_object_part_content_unset
|
|
|
|
* @li @ref elm_object_disabled_set
|
|
|
|
* @li @ref elm_object_disabled_get
|
2012-01-08 22:55:51 -08:00
|
|
|
*
|
2011-12-29 23:20:48 -08:00
|
|
|
* @ref tutorial_radio show most of this API in action.
|
|
|
|
* @{
|
|
|
|
*/
|
2011-12-29 22:49:28 -08:00
|
|
|
|
Elementary: Split headers for Map, Menu, Panel, Panes, Photocam, Plug,
Prefs, ProgressBar, Radio. Route, Segment Control, Separator, Slider,
Slideshow, Spinner, Systray, Table, Thumb, Video, Web.
2013-04-28 02:58:28 -07:00
|
|
|
#ifdef EFL_EO_API_SUPPORT
|
|
|
|
#include "elm_radio_eo.h"
|
|
|
|
#endif
|
|
|
|
#ifndef EFL_NOLEGACY_API_SUPPORT
|
|
|
|
#include "elm_radio_legacy.h"
|
|
|
|
#endif
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @}
|
|
|
|
*/
|