From: Alejandro Piñeiro <apinheiro@igalia.com>
Date: Tue, 12 Nov 2013 17:00:43 +0000 (+0100)
Subject: atkdocument: deprecation of some methods
X-Git-Tag: ATK_2_11_2~6
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=a1f4f39736a611339e795eeeac147b7889cfd30e;p=platform%2Fupstream%2Fatk.git

atkdocument: deprecation of some methods

atk_document_get_document, atk_document_get_document_type and their
equivalent virtuals were deprecated. Documentation properly updated.

At least atk_document_get_document_type seems to be announced as
deprecated since a long time ago. At least firefox code (in form
of comments) mention that. The case of atk_document_get_document
seems worse, as it doesn't makes too much sense. None of them
are used at at-spi at all.
---

diff --git a/atk/atkdocument.c b/atk/atkdocument.c
index 35d7bfe..f1515bb 100755
--- a/atk/atkdocument.c
+++ b/atk/atkdocument.c
@@ -165,6 +165,9 @@ atk_document_base_init (AtkDocumentIface *class)
  *
  * Gets a string indicating the document type.
  *
+ * Deprecated: Since 2.12. Please use atk_document_get_attributes() to
+ * ask for the document type if it applies.
+ *
  * Returns: a string indicating the document type
  **/
 const gchar*
@@ -194,6 +197,10 @@ atk_document_get_document_type (AtkDocument *document)
  * up to the caller to check atk_document_get_type to determine
  * how to cast this pointer.
  *
+ * Deprecated: Since 2.12. @document is already a representation of
+ * the document. Use it directly, or one of his children, as an
+ * instance of the DOM.
+ *
  * Returns: (transfer none): a %gpointer that points to an instance of the DOM.
  **/
 gpointer 
diff --git a/atk/atkdocument.h b/atk/atkdocument.h
index 874e89d..9ad537d 100755
--- a/atk/atkdocument.h
+++ b/atk/atkdocument.h
@@ -48,8 +48,20 @@ typedef struct _AtkDocumentIface AtkDocumentIface;
 
 /**
  * AtkDocumentIface:
+ * @get_document_type: gets a string indicating the document
+ *   type. This virtual function is deprecated since 2.12 and it
+ *   should not be overriden.
+ * @get_document: a #GObject instance that implements
+ *   AtkDocumentIface. This virtual method is deprecated since 2.12
+ *   and it should not be overriden.
  * @get_document_locale: gets locale. This virtual function is
- * deprecated since 2.7.90 and it should not be overriden.
+ *   deprecated since 2.7.90 and it should not be overriden.
+ * @get_document_attributes: gets an AtkAttributeSet which describes
+ *   document-wide attributes as name-value pairs.
+ * @get_document_attribute_value: returns a string value assocciated
+ *   with the named attribute for this document, or NULL
+ * @set_document_attribute: sets the value of an attribute. Returns
+ *   TRUE on success, FALSE otherwise
  */
 struct _AtkDocumentIface
 {
@@ -68,7 +80,10 @@ struct _AtkDocumentIface
 
 GType  atk_document_get_type             (void);
 
+G_DEPRECATED
 const gchar*          atk_document_get_document_type (AtkDocument   *document);
+
+G_DEPRECATED
 gpointer atk_document_get_document (AtkDocument   *document);
 
 G_DEPRECATED