misc: Simplify code flow in process_deferred_messages
[platform/upstream/at-spi2-core.git] / atspi / atspi-document.c
index be742b4..f95925b 100644 (file)
@@ -25,9 +25,9 @@
 
 /**
  * atspi_document_get_locale:
- * @obj: a pointer to the #Accessible object on which to operate.
+ * @obj: a pointer to the #AtspiDocument object on which to operate.
  *
- * Gets the locale associated with the document's content.
+ * Gets the locale associated with the document's content
  * e.g. the locale for LOCALE_TYPE_MESSAGES.
  *
  * Returns: a string compliant with the POSIX standard for locale description.
@@ -46,26 +46,45 @@ atspi_document_get_locale (AtspiDocument *obj, GError **error)
 
 /**
  * atspi_document_get_attribute_value:
- * @obj: a pointer to the #Accessible object on which to operate.
- * @attribute: a string indicating the name of a specific attribute 
+ * @obj: a pointer to the #AtspiDocument object on which to operate.
+ * @attribute: a string indicating the name of a specific attribute.
  *
  * Gets the value of a single attribute, if specified for the document as a whole.
  *
- * (name-value pair) being queried.
- * 
- * Returns a string corresponding to the value of the specified attribute, or
+ * Returns: a string corresponding to the value of the specified attribute, or
  * an empty string if the attribute is unspecified for the object.
+ *
+ * Deprecated: 2.10: Use atspi_document_get_document_attribute_value instead.
+ * Rename to: atspi_document_get_document_attribute_value
  **/
 gchar *
 atspi_document_get_attribute_value (AtspiDocument *obj,
                                      gchar *attribute,
                                      GError **error)
 {
+  return atspi_document_get_document_attribute_value (obj, attribute, error);
+}
+                                     
+/**
+ * atspi_document_get_document_attribute_value:
+ * @obj: a pointer to the #AtspiDocument object on which to operate.
+ * @attribute: a string indicating the name of a specific attribute.
+ *
+ * Gets the value of a single attribute, if specified for the document as a whole.
+ *
+ * Returns: a string corresponding to the value of the specified attribute, or
+ * an empty string if the attribute is unspecified for the object.
+ **/
+gchar *
+atspi_document_get_document_attribute_value (AtspiDocument *obj,
+                                            gchar *attribute,
+                                            GError **error)
+{
   gchar *retval = NULL;
 
   g_return_val_if_fail (obj != NULL, NULL);
 
-  _atspi_dbus_call (obj, atspi_interface_document, "GetAttributevaluee", error, "s=>s", attribute, &retval);
+  _atspi_dbus_call (obj, atspi_interface_document, "GetAttributeValue", error, "s=>s", attribute, &retval);
 
   if (!retval)
     retval = g_strdup ("");
@@ -76,28 +95,42 @@ atspi_document_get_attribute_value (AtspiDocument *obj,
 
 /**
  * atspi_document_get_attributes:
- * @obj: a pointer to the #Accessible object on which to operate.
+ * @obj: a pointer to the #AtspiDocument object on which to operate.
  * 
- * Gets all attributes specified for a document as a whole.  
- *
- * For attributes which change within 
- * the document content, see atspi_text_get_attribute_run instead.
+ * Gets all constant attributes for the document as a whole. For attributes
+ * that change within the document content, see @atspi_text_get_attribute_run instead.
  * 
- * Returns: (element-type gchar* gchar*) (transfer full): an ::AttributeSet
- *          containing the attributes of the document, as name-value pairs.
+ * Returns: (element-type gchar* gchar*) (transfer full): a #GHashTable
+ *          containing the constant attributes of the document, as name-value pairs.
+ *
+ * Deprecated: 2.10: Use atspi_document_get_document_attributes instead.
+ * Rename to: atspi_document_get_document_attributes
  **/
 GHashTable *
 atspi_document_get_attributes (AtspiDocument *obj, GError **error)
 {
+  return atspi_document_get_document_attributes (obj, error);
+}
+
+/**
+ * atspi_document_get_document_attributes:
+ * @obj: a pointer to the #AtspiDocument object on which to operate.
+ * 
+ * Gets all constant attributes for the document as a whole. For attributes
+ * that change within the document content, see @atspi_text_get_attribute_run instead.
+ * 
+ * Returns: (element-type gchar* gchar*) (transfer full): a #GHashTable
+ *          containing the constant attributes of the document, as name-value pairs.
+ **/
+GHashTable *
+atspi_document_get_document_attributes (AtspiDocument *obj, GError **error)
+{
   DBusMessage *message;
-  GHashTable *ret;
 
     g_return_val_if_fail (obj != NULL, NULL);
 
   message = _atspi_dbus_call_partial (obj, atspi_interface_document, "GetAttributes", error, "");
-  ret = _atspi_dbus_hash_from_message (message);
-  dbus_message_unref (message);
-  return ret;
+  return _atspi_dbus_return_hash_from_message (message);
 }
 
 static void