Added relations DESCRIPTION_FOR and DESCRIBED_BY (from ATK).
[platform/core/uifw/at-spi2-atk.git] / cspi / spi_accessible.c
index 0633025..ab80b9e 100644 (file)
@@ -101,7 +101,18 @@ static const char *role_names [] =
   "fooler",
   "paragraph",
   "ruler",
-  "application"
+  "application",
+  "autocomplete",
+  "editbar",
+  "embedded",
+  "entry",
+  "chart",
+  "caption",
+  "document_frame",
+  "heading",
+  "page",
+  "section",
+  "form"
 };
 
 #define MAX_ROLES (sizeof (role_names) / sizeof (char *))
@@ -188,11 +199,22 @@ cspi_init_role_table (AccessibleRole *role_table)
   role_table [Accessibility_ROLE_PARAGRAPH] = SPI_ROLE_PARAGRAPH;
   role_table [Accessibility_ROLE_RULER] = SPI_ROLE_RULER;
   role_table [Accessibility_ROLE_APPLICATION] = SPI_ROLE_APPLICATION;
+  role_table [Accessibility_ROLE_AUTOCOMPLETE] = SPI_ROLE_AUTOCOMPLETE;
+  role_table [Accessibility_ROLE_EDITBAR] = SPI_ROLE_EDITBAR;
+  role_table [Accessibility_ROLE_EMBEDDED] = SPI_ROLE_EMBEDDED;
+  role_table [Accessibility_ROLE_ENTRY] = SPI_ROLE_ENTRY;
+  role_table [Accessibility_ROLE_CHART] = SPI_ROLE_CHART;
+  role_table [Accessibility_ROLE_CAPTION] = SPI_ROLE_CAPTION;
+  role_table [Accessibility_ROLE_DOCUMENT_FRAME] = SPI_ROLE_DOCUMENT_FRAME;
+  role_table [Accessibility_ROLE_HEADING] = SPI_ROLE_HEADING;
+  role_table [Accessibility_ROLE_PAGE] = SPI_ROLE_PAGE;
+  role_table [Accessibility_ROLE_SECTION] = SPI_ROLE_SECTION;
+  role_table [Accessibility_ROLE_FORM] = SPI_ROLE_FORM;
 
   return TRUE;
 }
 
-static AccessibleRole
+AccessibleRole
 cspi_role_from_spi_role (Accessibility_Role role)
 {
   /* array is sized according to IDL roles because IDL roles are the index */  
@@ -214,6 +236,21 @@ cspi_role_from_spi_role (Accessibility_Role role)
   return cspi_role; 
 }
 
+static AccessibleAttributeSet *
+cspi_attribute_set_from_sequence (const Accessibility_AttributeSet *seq)
+{
+    AccessibleAttributeSet *set = g_new0 (AccessibleAttributeSet, 1);
+    int i;
+
+    set->len = seq->_length;
+    set->attributes = g_newa (char *, set->len);
+    for (i = 0; i < set->len; ++i)
+    {
+       set->attributes[i] = g_strdup (seq->_buffer [i]);
+    }
+    return set;
+}
+
 /**
  * AccessibleRole_getName:
  * @role: an #AccessibleRole object to query.
@@ -426,6 +463,8 @@ Accessible_getRelationSet (Accessible *obj)
 
   cspi_return_val_if_fail (obj != NULL, NULL);
 
+  g_assert (!cspi_exception ());
+
   relation_set =
     Accessibility_Accessible_getRelationSet (CSPI_OBJREF (obj), cspi_ev ());
 
@@ -498,9 +537,39 @@ Accessible_getRoleName (Accessible *obj)
 }
 
 /**
+ * Accessible_getLocalizedRoleName:
+ * @obj: a pointer to the #Accessible object on which to operate.
+ *
+ * Get a UTF-8 string describing the (localized) role this object plays in the UI.
+ * This method will return useful values for roles that fall outside the
+ * enumeration used in Accessible_getRole ().
+ *
+ * @Since: AT-SPI 1.4
+ *
+ * Returns: a UTF-8 string specifying the role of this #Accessible object.
+ *
+ **/
+char *
+Accessible_getLocalizedRoleName (Accessible *obj)
+{
+  char *retval;
+
+  cspi_return_val_if_fail (obj != NULL, CORBA_string_dup ("invalid"));
+
+  retval = 
+    Accessibility_Accessible_getLocalizedRoleName (CSPI_OBJREF (obj), cspi_ev ());
+
+  cspi_return_val_if_ev ("getLocalizedRoleName", CORBA_string_dup ("invalid")); 
+
+  return retval;
+}
+
+/**
  * Accessible_getStateSet:
  * @obj: a pointer to the #Accessible object on which to operate.
  *
+ * Gets the current state of an object.
+ *
  * Returns: a pointer to an #AccessibleStateSet representing the object's current state.
  **/
 AccessibleStateSet *
@@ -516,7 +585,7 @@ Accessible_getStateSet (Accessible *obj)
          CSPI_OBJREF (obj), cspi_ev ());
   cspi_return_val_if_ev ("getState", NULL);
 
-  cspi_return_val_if_fail (corba_stateset != NULL, NULL);
+  cspi_return_val_if_fail (corba_stateset != CORBA_OBJECT_NIL, NULL);
   cspi_return_val_if_fail (cspi_ping (corba_stateset), NULL);
   corba_seq = Accessibility_StateSet_getStates (corba_stateset, cspi_ev ());
   cspi_return_val_if_ev ("getState", NULL);
@@ -529,6 +598,58 @@ Accessible_getStateSet (Accessible *obj)
   return retval;
 }
 
+/**
+ * Accessible_getAttributes:
+ * @obj: The #Accessible being queried.
+ *
+ * Get the #AttributeSet representing any assigned 
+ * name-value pair attributes or annotations for this object.
+ * For typographic, textual, or textually-semantic attributes, see
+ * AccessibleText_getAttributes instead.
+ *
+ * Returns: The name-value-pair attributes assigned to this object.
+ */
+AccessibleAttributeSet *
+Accessible_getAttributes (Accessible *obj)
+{
+    AccessibleAttributeSet *retval;
+    Accessibility_AttributeSet *corba_seq;
+
+    cspi_return_val_if_fail (obj != NULL, NULL);
+
+    corba_seq = Accessibility_Accessible_getAttributes (
+       CSPI_OBJREF (obj), cspi_ev ());
+    cspi_return_val_if_ev ("getAttributes", NULL);
+    
+    retval = cspi_attribute_set_from_sequence (corba_seq);
+    CORBA_free (corba_seq);
+
+    return NULL;
+}
+
+/**
+ * Accessible_getHostApplication:
+ * @obj: The #Accessible being queried.
+ *
+ * Get the containing #AccessibleApplication for an object.
+ *
+ * Returns: the containing AccessibleApplication instance for this object.
+ */
+AccessibleApplication *
+Accessible_getHostApplication (Accessible *obj)
+{
+    AccessibleApplication *retval;
+
+    cspi_return_val_if_fail (obj != NULL, NULL);
+
+    retval = Accessible_getApplication (cspi_object_add (
+                                           Accessibility_Accessible_getApplication (CSPI_OBJREF (obj),
+                                                                                    cspi_ev ())));
+    cspi_return_val_if_ev ("getApplication", NULL);
+
+    return retval;
+}
+
 /* Interface query methods */
 
 /**
@@ -987,7 +1108,10 @@ cspi_init_relation_type_table (AccessibleRelationType *relation_type_table)
   relation_type_table [Accessibility_RELATION_EMBEDS] = SPI_RELATION_EMBEDS;
   relation_type_table [Accessibility_RELATION_EMBEDDED_BY] = SPI_RELATION_EMBEDDED_BY;
   relation_type_table [Accessibility_RELATION_POPUP_FOR] = SPI_RELATION_POPUP_FOR;
-  relation_type_table [Accessibility_RELATION_LAST_DEFINED] = SPI_RELATION_LAST_DEFINED;
+  relation_type_table [Accessibility_RELATION_PARENT_WINDOW_OF] = SPI_RELATION_PARENT_WINDOW_OF;
+  relation_type_table [Accessibility_RELATION_DESCRIBED_BY] = SPI_RELATION_DESCRIBED_BY;
+  relation_type_table [Accessibility_RELATION_DESCRIPTION_FOR] = SPI_RELATION_DESCRIPTION_FOR;
+  return TRUE;
 }
 
 static AccessibleRelationType
@@ -1148,6 +1272,13 @@ spi_state_to_corba (AccessibleState state)
       MAP_STATE (VISIBLE);
       MAP_STATE (MANAGES_DESCENDANTS);
       MAP_STATE (INDETERMINATE);
+      MAP_STATE (TRUNCATED);
+      MAP_STATE (REQUIRED);
+      MAP_STATE (INVALID_ENTRY);
+      MAP_STATE (SUPPORTS_AUTOCOMPLETION);
+      MAP_STATE (SELECTABLE_TEXT);
+      MAP_STATE (IS_DEFAULT);
+      MAP_STATE (VISITED);
     default:
       return Accessibility_STATE_INVALID;
   }