[genlist] apply r71140 with local enhancement
[framework/uifw/elementary.git] / src / lib / elm_radio.c
index 4f98add..0f6c0f6 100644 (file)
@@ -1,35 +1,6 @@
 #include <Elementary.h>
 #include "elm_priv.h"
 
-/**
- * @defgroup Radio Radio
- *
- * The radio button allows for 1 or more selectors to be created to select 1
- * of a set of options.
- *
- * Signals that you can add callbacks for are:
- *
- * 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.
- *
- * A radio object contains an indicator, an optional Label and an optional
- * icon object. They work normally in groups of 2 or more. When you create a
- * radio (if it is not the first member of the group), simply add it to the
- * group by adding it to any other member of the group that already exists
- * (or the first member) with elm_radio_group_add() with the second parameter
- * being the existing group member. 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 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.
- */
-
 typedef struct _Widget_Data Widget_Data;
 typedef struct _Group Group;
 
@@ -108,13 +79,13 @@ _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
    if (!wd) return;
    if (elm_widget_focus_get(obj))
      {
-       edje_object_signal_emit(wd->radio, "elm,action,focus", "elm");
-       evas_object_focus_set(wd->radio, EINA_TRUE);
+        edje_object_signal_emit(wd->radio, "elm,action,focus", "elm");
+        evas_object_focus_set(wd->radio, EINA_TRUE);
      }
    else
      {
-       edje_object_signal_emit(wd->radio, "elm,action,unfocus", "elm");
-       evas_object_focus_set(wd->radio, EINA_FALSE);
+        edje_object_signal_emit(wd->radio, "elm,action,unfocus", "elm");
+        evas_object_focus_set(wd->radio, EINA_FALSE);
      }
 }
 
@@ -146,7 +117,7 @@ _theme_hook(Evas_Object *obj)
      edje_object_signal_emit(wd->radio, "elm,state,text,visible", "elm");
    else
      edje_object_signal_emit(wd->radio, "elm,state,text,hidden", "elm");
-   edje_object_part_text_set(wd->radio, "elm.text", wd->label);
+   edje_object_part_text_escaped_set(wd->radio, "elm.text", wd->label);
    if (elm_widget_disabled_get(obj))
      {
         edje_object_signal_emit(wd->radio, "elm,state,disabled", "elm");
@@ -201,11 +172,11 @@ _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
    if (!wd) return;
    if (sub == wd->icon)
      {
-       edje_object_signal_emit(wd->radio, "elm,state,icon,hidden", "elm");
-       evas_object_event_callback_del_full
-         (sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
-       wd->icon = NULL;
-       _sizing_eval(obj);
+        edje_object_signal_emit(wd->radio, "elm,state,icon,hidden", "elm");
+        evas_object_event_callback_del_full
+           (sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
+        wd->icon = NULL;
+        _sizing_eval(obj);
      }
 }
 
@@ -216,11 +187,11 @@ _state_set(Evas_Object *obj, Eina_Bool state)
    if (!wd) return;
    if ((state != wd->state) && (!elm_widget_disabled_get(obj)))
      {
-       wd->state = state;
-       if (wd->state)
-         edje_object_signal_emit(wd->radio, "elm,state,radio,on", "elm");
-       else
-         edje_object_signal_emit(wd->radio, "elm,state,radio,off", "elm");
+        wd->state = state;
+        if (wd->state)
+          edje_object_signal_emit(wd->radio, "elm,state,radio,on", "elm");
+        else
+          edje_object_signal_emit(wd->radio, "elm,state,radio,off", "elm");
      }
 }
 
@@ -232,14 +203,14 @@ _state_set_all(Widget_Data *wd)
    Eina_Bool disabled = EINA_FALSE;
    EINA_LIST_FOREACH(wd->group->radios, l, child)
      {
-       Widget_Data *wd2 = elm_widget_data_get(child);
+        Widget_Data *wd2 = elm_widget_data_get(child);
         if (wd2->state) selected = child;
-       if (wd2->value == wd->group->value)
+        if (wd2->value == wd->group->value)
           {
              _state_set(child, 1);
              if (!wd2->state) disabled = EINA_TRUE;
           }
-       else _state_set(child, 0);
+        else _state_set(child, 0);
      }
    if ((disabled) && (selected)) _state_set(selected, 1);
 }
@@ -250,10 +221,16 @@ _activate(Evas_Object *obj)
    Widget_Data *wd = elm_widget_data_get(obj);
    if (!wd) return;
    if (wd->group->value == wd->value) return;
-   wd->group->value = wd->value;
-   if (wd->group->valuep) *(wd->group->valuep) = wd->group->value;
-   _state_set_all(wd);
-   evas_object_smart_callback_call(obj, SIG_CHANGED, NULL);
+   if ((_elm_config->access_mode == ELM_ACCESS_MODE_OFF) ||
+       (_elm_access_2nd_click_timeout(obj)))
+     {
+        wd->group->value = wd->value;
+        if (wd->group->valuep) *(wd->group->valuep) = wd->group->value;
+        _state_set_all(wd);
+        if (_elm_config->access_mode != ELM_ACCESS_MODE_OFF)
+          _elm_access_say(E_("State: On"));
+        evas_object_smart_callback_call(obj, SIG_CHANGED, NULL);
+     }
 }
 
 static void
@@ -268,189 +245,171 @@ _signal_radio_on(void *data, Evas_Object *obj __UNUSED__, const char *emission _
    _activate(data);
 }
 
-/**
-  * Add a new radio to the parent
-  *
-  * @param parent The parent object
-  * @return The new object or NULL if it cannot be created
-  *
-  * @ingroup Radio
-  */
-EAPI Evas_Object *
-elm_radio_add(Evas_Object *parent)
-{
-   Evas_Object *obj;
-   Evas *e;
-   Widget_Data *wd;
-
-   ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
-   
-   ELM_SET_WIDTYPE(widtype, "radio");
-   elm_widget_type_set(obj, "radio");
-   elm_widget_sub_object_add(parent, obj);
-   elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
-   elm_widget_data_set(obj, wd);
-   elm_widget_del_hook_set(obj, _del_hook);
-   elm_widget_theme_hook_set(obj, _theme_hook);
-   elm_widget_disable_hook_set(obj, _disable_hook);
-   elm_widget_can_focus_set(obj, EINA_TRUE);
-   elm_widget_activate_hook_set(obj, _activate_hook);
-   elm_widget_event_hook_set(obj, _event_hook);
-
-   wd->radio = edje_object_add(e);
-   _elm_theme_object_set(obj, wd->radio, "radio", "base", "default");
-   edje_object_signal_callback_add(wd->radio, "elm,action,radio,on", "", _signal_radio_on, obj);
-   edje_object_signal_callback_add(wd->radio, "elm,action,radio,toggle", "", _signal_radio_on, obj);
-   elm_widget_resize_object_set(obj, wd->radio);
-
-   evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
-
-   wd->group = calloc(1, sizeof(Group));
-   wd->group->radios = eina_list_append(wd->group->radios, obj);
-   wd->state = 0;
-
-   _mirrored_set(obj, elm_widget_mirrored_get(obj));
-   _sizing_eval(obj);
-
-   // TODO: convert Elementary to subclassing of Evas_Smart_Class
-   // TODO: and save some bytes, making descriptions per-class and not instance!
-   evas_object_smart_callbacks_descriptions_set(obj, _signals);
-   return obj;
-}
-
-/**
- * Set the text label of the radio object
- *
- * @param obj The radio object
- * @param label The text label string in UTF-8
- *
- * @ingroup Radio
- */
-EAPI void
-elm_radio_label_set(Evas_Object *obj, const char *label)
+static void
+_elm_radio_label_set(Evas_Object *obj, const char *item, const char *label)
 {
    ELM_CHECK_WIDTYPE(obj, widtype);
    Widget_Data *wd = elm_widget_data_get(obj);
+   if (item && strcmp(item, "default")) return;
    if (!wd) return;
    eina_stringshare_replace(&wd->label, label);
    if (label)
      {
-       edje_object_signal_emit(wd->radio, "elm,state,text,visible", "elm");
-       edje_object_message_signal_process(wd->radio);
+        edje_object_signal_emit(wd->radio, "elm,state,text,visible", "elm");
+        edje_object_message_signal_process(wd->radio);
      }
    else
      {
-       edje_object_signal_emit(wd->radio, "elm,state,text,hidden", "elm");
-       edje_object_message_signal_process(wd->radio);
+        edje_object_signal_emit(wd->radio, "elm,state,text,hidden", "elm");
+        edje_object_message_signal_process(wd->radio);
      }
-   edje_object_part_text_set(wd->radio, "elm.text", label);
+   edje_object_part_text_escaped_set(wd->radio, "elm.text", label);
    _sizing_eval(obj);
 }
 
-/**
- * Get the text label of the radio object
- *
- * @param obj The radio object
- * @return The text label string in UTF-8
- *
- * @ingroup Radio
- */
-EAPI const char *
-elm_radio_label_get(const Evas_Object *obj)
+static const char *
+_elm_radio_label_get(const Evas_Object *obj, const char *item)
 {
    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
    Widget_Data *wd = elm_widget_data_get(obj);
+   if (item && strcmp(item, "default")) return NULL;
    if (!wd) return NULL;
    return wd->label;
 }
 
-/**
- * Set the icon object of the radio object
- *
- * Once the icon object is set, a previously set one will be deleted.
- * If you want to keep that old content object, use the
- * elm_radio_icon_unset() function.
- *
- * @param obj The radio object
- * @param icon The icon object
- *
- * @ingroup Radio
- */
-EAPI void
-elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon)
+static char *
+_access_info_cb(void *data __UNUSED__, Evas_Object *obj, Elm_Widget_Item *item __UNUSED__)
+{
+   const char *txt = elm_widget_access_info_get(obj);
+   if (!txt) txt = _elm_radio_label_get(obj, NULL);
+   if (txt) return strdup(txt);
+   return NULL;
+}
+
+static char *
+_access_state_cb(void *data __UNUSED__, Evas_Object *obj, Elm_Widget_Item *item __UNUSED__)
 {
-   ELM_CHECK_WIDTYPE(obj, widtype);
    Widget_Data *wd = elm_widget_data_get(obj);
+   if (!wd) return NULL;
+   if (elm_widget_disabled_get(obj))
+     return strdup(E_("State: Disabled"));
+   if (wd->state)
+     return strdup(E_("State: On"));
+   return strdup(E_("State: Off"));
+}
+
+static void
+_content_set_hook(Evas_Object *obj, const char *part, Evas_Object *content)
+{
+   ELM_CHECK_WIDTYPE(obj, widtype);
+   Widget_Data *wd;
+
+   if (part && strcmp(part, "icon")) return;
+   wd = elm_widget_data_get(obj);
    if (!wd) return;
-   if (wd->icon == icon) return;
+   if (wd->icon == content) return;
    if (wd->icon) evas_object_del(wd->icon);
-   wd->icon = icon;
-   if (icon)
+   wd->icon = content;
+   if (content)
      {
-       elm_widget_sub_object_add(obj, icon);
-       evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
-                                      _changed_size_hints, obj);
-       edje_object_part_swallow(wd->radio, "elm.swallow.content", icon);
-       edje_object_signal_emit(wd->radio, "elm,state,icon,visible", "elm");
-       edje_object_message_signal_process(wd->radio);
+        elm_widget_sub_object_add(obj, content);
+        evas_object_event_callback_add(content,
+                                       EVAS_CALLBACK_CHANGED_SIZE_HINTS,
+                                       _changed_size_hints, obj);
+        edje_object_part_swallow(wd->radio, "elm.swallow.content", content);
+        edje_object_signal_emit(wd->radio, "elm,state,icon,visible", "elm");
+        edje_object_message_signal_process(wd->radio);
      }
    _sizing_eval(obj);
 }
 
-/**
- * Get the icon object of the radio object
- *
- * @param obj The radio object
- * @return The icon object
- *
- * @ingroup Radio
- */
-EAPI Evas_Object *
-elm_radio_icon_get(const Evas_Object *obj)
+static Evas_Object *
+_content_get_hook(const Evas_Object *obj, const char *part)
 {
    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
-   Widget_Data *wd = elm_widget_data_get(obj);
+   Widget_Data *wd;
+
+   if (part && strcmp(part, "icon")) return NULL;
+   wd = elm_widget_data_get(obj);
    if (!wd) return NULL;
    return wd->icon;
 }
 
-/**
- * Unset the icon used for the radio object
- *
- * Unparent and return the icon object which was set for this widget.
- *
- * @param obj The radio object
- * @return The icon object that was being used
- *
- * @ingroup Radio
- */
-EAPI Evas_Object *
-elm_radio_icon_unset(Evas_Object *obj)
+static Evas_Object *
+_content_unset_hook(Evas_Object *obj, const char *part)
 {
    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
-   Widget_Data *wd = elm_widget_data_get(obj);
+   Widget_Data *wd;
+   Evas_Object *icon;
+   if (part && strcmp(part, "icon")) return NULL;
+   wd = elm_widget_data_get(obj);
    if (!wd) return NULL;
    if (!wd->icon) return NULL;
-   Evas_Object *icon = wd->icon;
+   icon = wd->icon;
    elm_widget_sub_object_del(obj, wd->icon);
+   evas_object_event_callback_del_full(wd->icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
+                                       _changed_size_hints, obj);
    edje_object_part_unswallow(wd->radio, wd->icon);
    wd->icon = NULL;
    return icon;
 }
 
-/**
- * Add this radio to a group of other radio objects
- *
- * Radio objects work in groups. Each member should have a different integer
- * value assigned. In order ro have them work as a group, they need to know
- * about eacthother. This adds the given radio object to the group of which
- * the group object indicated is a member.
- *
- * @param obj The radio object
- * @param group The object whose group the object is to join
- *
- * @ingroup Radio
- */
+EAPI Evas_Object *
+elm_radio_add(Evas_Object *parent)
+{
+   Evas_Object *obj;
+   Evas *e;
+   Widget_Data *wd;
+
+   ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
+
+   ELM_SET_WIDTYPE(widtype, "radio");
+   elm_widget_type_set(obj, "radio");
+   elm_widget_sub_object_add(parent, obj);
+   elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
+   elm_widget_data_set(obj, wd);
+   elm_widget_del_hook_set(obj, _del_hook);
+   elm_widget_theme_hook_set(obj, _theme_hook);
+   elm_widget_disable_hook_set(obj, _disable_hook);
+   elm_widget_can_focus_set(obj, EINA_TRUE);
+   elm_widget_activate_hook_set(obj, _activate_hook);
+   elm_widget_event_hook_set(obj, _event_hook);
+   elm_widget_text_set_hook_set(obj, _elm_radio_label_set);
+   elm_widget_text_get_hook_set(obj, _elm_radio_label_get);
+   elm_widget_content_set_hook_set(obj, _content_set_hook);
+   elm_widget_content_get_hook_set(obj, _content_get_hook);
+   elm_widget_content_unset_hook_set(obj, _content_unset_hook);
+
+   wd->radio = edje_object_add(e);
+   _elm_theme_object_set(obj, wd->radio, "radio", "base", "default");
+   edje_object_signal_callback_add(wd->radio, "elm,action,radio,on", "", _signal_radio_on, obj);
+   edje_object_signal_callback_add(wd->radio, "elm,action,radio,toggle", "", _signal_radio_on, obj);
+   elm_widget_resize_object_set(obj, wd->radio);
+
+   evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
+
+   wd->group = calloc(1, sizeof(Group));
+   wd->group->radios = eina_list_append(wd->group->radios, obj);
+   wd->state = 0;
+
+   _mirrored_set(obj, elm_widget_mirrored_get(obj));
+   _sizing_eval(obj);
+
+   // TODO: convert Elementary to subclassing of Evas_Smart_Class
+   // TODO: and save some bytes, making descriptions per-class and not instance!
+   evas_object_smart_callbacks_descriptions_set(obj, _signals);
+
+   _elm_access_object_register(obj, wd->radio);
+   _elm_access_text_set(_elm_access_object_get(obj),
+                        ELM_ACCESS_TYPE, E_("Radio"));
+   _elm_access_callback_set(_elm_access_object_get(obj),
+                            ELM_ACCESS_INFO, _access_info_cb, obj);
+   _elm_access_callback_set(_elm_access_object_get(obj),
+                            ELM_ACCESS_STATE, _access_state_cb, obj);
+
+   return obj;
+}
+
 EAPI void
 elm_radio_group_add(Evas_Object *obj, Evas_Object *group)
 {
@@ -460,34 +419,24 @@ elm_radio_group_add(Evas_Object *obj, Evas_Object *group)
    if (!wd) return;
    if (!wd2)
      {
-       if (eina_list_count(wd->group->radios) == 1)
-         return;
-       wd->group->radios = eina_list_remove(wd->group->radios, obj);
-       wd->group = calloc(1, sizeof(Group));
-       wd->group->radios = eina_list_append(wd->group->radios, obj);
+        if (eina_list_count(wd->group->radios) == 1)
+          return;
+        wd->group->radios = eina_list_remove(wd->group->radios, obj);
+        wd->group = calloc(1, sizeof(Group));
+        wd->group->radios = eina_list_append(wd->group->radios, obj);
      }
    else if (wd->group == wd2->group) return;
    else
      {
-       wd->group->radios = eina_list_remove(wd->group->radios, obj);
-       if (!wd->group->radios) free(wd->group);
-       wd->group = wd2->group;
-       wd->group->radios = eina_list_append(wd->group->radios, obj);
+        wd->group->radios = eina_list_remove(wd->group->radios, obj);
+        if (!wd->group->radios) free(wd->group);
+        wd->group = wd2->group;
+        wd->group->radios = eina_list_append(wd->group->radios, obj);
      }
    if (wd->value == wd->group->value) _state_set(obj, 1);
    else _state_set(obj, 0);
 }
 
-/**
- * Set the integer value that this radio object represents
- *
- * This sets the value of the radio.
- *
- * @param obj The radio object
- * @param value The value to use if this radio object is selected
- *
- * @ingroup Radio
- */
 EAPI void
 elm_radio_state_value_set(Evas_Object *obj, int value)
 {
@@ -499,16 +448,6 @@ elm_radio_state_value_set(Evas_Object *obj, int value)
    else _state_set(obj, 0);
 }
 
-/**
- * Get the integer value that this radio object represents
- *
- * This gets the value of the radio.
- *
- * @param obj The radio object
- * @return The value used if this radio object is selected
- *
- * @ingroup Radio
- */
 EAPI int
 elm_radio_state_value_get(const Evas_Object *obj)
 {
@@ -518,17 +457,6 @@ elm_radio_state_value_get(const Evas_Object *obj)
    return wd->value;
 }
 
-/**
- * Set the value of the radio.
- *
- * 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.
- *
- * @param obj The radio object
- * @param value The value to use for the group
- *
- * @ingroup Radio
- */
 EAPI void
 elm_radio_value_set(Evas_Object *obj, int value)
 {
@@ -541,14 +469,6 @@ elm_radio_value_set(Evas_Object *obj, int value)
    _state_set_all(wd);
 }
 
-/**
- * Get the state of the radio object
- *
- * @param obj The radio object
- * @return The integer state
- *
- * @ingroup Radio
- */
 EAPI int
 elm_radio_value_get(const Evas_Object *obj)
 {
@@ -558,21 +478,6 @@ elm_radio_value_get(const Evas_Object *obj)
    return wd->group->value;
 }
 
-/**
- * Set a convenience pointer to a integer to change
- *
- * 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 parameter. 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().
- *
- * @param obj The radio object
- * @param valuep Pointer to the integer to modify
- *
- * @ingroup Radio
- */
 EAPI void
 elm_radio_value_pointer_set(Evas_Object *obj, int *valuep)
 {
@@ -581,15 +486,35 @@ elm_radio_value_pointer_set(Evas_Object *obj, int *valuep)
    if (!wd) return;
    if (valuep)
      {
-       wd->group->valuep = valuep;
-       if (*(wd->group->valuep) != wd->group->value)
-         {
-            wd->group->value = *(wd->group->valuep);
-            _state_set_all(wd);
-         }
+        wd->group->valuep = valuep;
+        if (*(wd->group->valuep) != wd->group->value)
+          {
+             wd->group->value = *(wd->group->valuep);
+             _state_set_all(wd);
+          }
      }
    else
      {
-       wd->group->valuep = NULL;
+        wd->group->valuep = NULL;
+     }
+}
+
+EAPI Evas_Object *
+elm_radio_selected_object_get(Evas_Object *obj)
+{
+   Eina_List *l;
+   Evas_Object *child;
+   Widget_Data *wd2;
+
+   ELM_CHECK_WIDTYPE(obj, widtype) NULL;
+   Widget_Data *wd = elm_widget_data_get(obj);
+   if (!wd) return NULL;
+
+   EINA_LIST_FOREACH(wd->group->radios, l, child)
+     {
+        wd2  = elm_widget_data_get(child);
+        if (wd2->value == wd->group->value)
+           return child;
      }
+   return NULL;
 }