144 lines
5.2 KiB
C
144 lines
5.2 KiB
C
/**
|
|
* @defgroup Radio Radio
|
|
*
|
|
* @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,
|
|
* 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.
|
|
*
|
|
* Signals that you can add callbacks for are:
|
|
* @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.
|
|
*
|
|
* Default text parts of the radio widget that you can use for are:
|
|
* @li "default" - Label of the radio
|
|
*
|
|
* Default content parts of the radio widget that you can use for are:
|
|
* @li "icon" - An icon of the radio
|
|
*
|
|
* Supported elm_object common APIs.
|
|
* @li elm_object_part_text_set
|
|
* @li elm_object_part_text_get
|
|
* @li elm_object_part_content_set
|
|
* @li elm_object_part_content_get
|
|
* @li elm_object_part_content_unset
|
|
* @li elm_object_disabled_set
|
|
* @li elm_object_disabled_get
|
|
*
|
|
* @ref tutorial_radio show most of this API in action.
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Add a new radio to the parent
|
|
*
|
|
* @param parent The parent object
|
|
* @return The new object or NULL if it cannot be created
|
|
*/
|
|
EAPI Evas_Object *elm_radio_add(Evas_Object *parent);
|
|
|
|
/**
|
|
* @brief Add this radio to a group of other radio objects
|
|
*
|
|
* @param obj The radio object
|
|
* @param group Any object whose group the @p 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.
|
|
*/
|
|
EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group);
|
|
|
|
/**
|
|
* @brief Set the integer value that this radio object represents
|
|
*
|
|
* @param obj The radio object
|
|
* @param value The value to use if this radio object is selected
|
|
*
|
|
* This sets the value of the radio.
|
|
*/
|
|
EAPI void elm_radio_state_value_set(Evas_Object *obj, int value);
|
|
|
|
/**
|
|
* @brief Get the integer value that this radio object represents
|
|
*
|
|
* @param obj The radio object
|
|
* @return The value used if this radio object is selected
|
|
*
|
|
* This gets the value of the radio.
|
|
*
|
|
* @see elm_radio_value_set()
|
|
*/
|
|
EAPI int elm_radio_state_value_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Set the value of the radio group.
|
|
*
|
|
* @param obj The radio object (any radio object of the group).
|
|
* @param value The 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.
|
|
*/
|
|
EAPI void elm_radio_value_set(Evas_Object *obj, int value);
|
|
|
|
/**
|
|
* @brief Get the value of the radio group
|
|
*
|
|
* @param obj The radio object (any radio object of the group).
|
|
* @return The integer state
|
|
*/
|
|
EAPI int elm_radio_value_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Set a convenience pointer to a integer to change when radio group
|
|
* value changes.
|
|
*
|
|
* @param obj The radio object (any object of a group)
|
|
* @param valuep Pointer 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 @p 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().
|
|
*/
|
|
EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep);
|
|
|
|
/**
|
|
* @brief Get the selected radio object.
|
|
*
|
|
* @param obj Any radio object (any object of a group)
|
|
* @return The selected radio object
|
|
*/
|
|
EAPI Evas_Object *elm_radio_selected_object_get(Evas_Object *obj);
|
|
|
|
/**
|
|
* @}
|
|
*/
|