Add new function atk_text_get_default_attributes Rename

* atk/atktext.[c|h]:
* docs/atk-sections.txt, docs/tmpl/atktext.sgml:
Add new function atk_text_get_default_attributes
Rename atk_text_ref_run_attributes to atk_text_get_run_attributes

diff --git a/ChangeLog b/ChangeLog
index fdaf9050bc9276fb7ba391f997c2c5f4fd16b43f..3328e46b386cef81d98dadbd73988804cd6d1b41 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,8 +1,18 @@
+2001-10-10  Padraig O'Briain  <padraig.obriain@sun.com>
+
+       * atk/atktext.[c|h]:
+        * docs/atk-sections.txt, docs/tmpl/atktext.sgml:
+       Add new function atk_text_get_default_attributes
+       Rename atk_text_ref_run_attributes to atk_text_get_run_attributes
+
 2001-10-09  Padraig O'Briain  <padraig.obriain@sun.com>
 
        * atk/atktext.c (atk_attribute_set_free):
        Avoid leaking of AtkAttributeSet data structure; speed up code.
 
+       * docs/tmpl.atk*.sgml
+       Updated to reflect current APIs.
+
 2001-10-01  jacob berkman  <jacob@ximian.com>
 
        * docs/Makefile.am (dist-hook-local): depend on all-local so that

diff --git a/atk/atktext.c b/atk/atktext.c
index f54501f18857eedf9c502da3e7bd565b69c83f0d..a43d53287c1c023cbff3c5c61cfb19ca155c31d9 100755 (executable)
--- a/atk/atktext.c
+++ b/atk/atktext.c
@@ -376,7 +376,7 @@ atk_text_get_character_extents (AtkText *text,
 }
 
 /**
- *atk_text_ref_run_attributes:
+ *atk_text_get_run_attributes:
  *@text: an #AtkText
  *@offset: the offset at which to get the attributes
  *@start_offset: the address to put the start offset of the range
@@ -390,12 +390,14 @@ atk_text_get_character_extents (AtkText *text,
  *attributes that do not have corresponding macros may also be returned.
  *
  *Returns: an #AtkAttributeSet which contains the attributes explicitly set
- *at @offset
+ *at @offset. This #AtkAttributeSet should be freed by a call to
+ *atk_attribute_set_free().
  **/
-AtkAttributeSet* atk_text_ref_run_attributes              (AtkText          *text,
-                                                           gint             offset,
-                                                           gint             *start_offset,
-                                                           gint             *end_offset)
+AtkAttributeSet* 
+atk_text_get_run_attributes (AtkText          *text,
+                             gint             offset,
+                             gint             *start_offset,
+                             gint             *end_offset)
 {
   AtkTextIface *iface;
   gint local_start_offset, local_end_offset;
@@ -414,8 +416,35 @@ AtkAttributeSet* atk_text_ref_run_attributes              (AtkText          *tex
 
   iface = ATK_TEXT_GET_IFACE (text);
 
-  if (iface->ref_run_attributes)
-    return (*(iface->ref_run_attributes)) (text, offset, real_start_offset, real_end_offset);
+  if (iface->get_run_attributes)
+    return (*(iface->get_run_attributes)) (text, offset, real_start_offset, real_end_offset);
+  else
+    return NULL;
+}
+
+/**
+ *atk_text_get_default_attributes:
+ *@text: an #AtkText
+ *
+ *Creates an #AtkAttributeSet which consists of the default values of
+ *attributes for the text. See the ATK_ATTRIBUTE macros, such as 
+ *#ATK_ATTRIBUTE_LEFT_MARGIN for types of text attributes that can be 
+ *returned. Note that other attributes that do not have corresponding macros 
+ *may also be returned.
+ *
+ *Returns: an #AtkAttributeSet which contains the default values of attributes.
+ *at @offset. This #AtkAttributeSet should be freed by a call to
+ *atk_attribute_set_free().
+ */
+AtkAttributeSet* 
+atk_text_get_default_attributes (AtkText          *text)
+{
+  AtkTextIface *iface;
+
+  g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
+
+  if (iface->get_default_attributes)
+    return (*(iface->get_default_attributes)) (text);
   else
     return NULL;
 }

diff --git a/atk/atktext.h b/atk/atktext.h
index ca3ddabf2cdef48ba9cb68c9e4d3b0eac9f69f74..8ce97a3fbce0561ad53bb9bacf90b024e492c9eb 100755 (executable)
--- a/atk/atktext.h
+++ b/atk/atktext.h
@@ -33,7 +33,8 @@ extern "C" {
  * AtkAttributeSet:
  *
  * This is a singly-linked list (a #GSList) of #AtkAttribute. It is
- * used by atk_text_ref_run_attributes() and atk_editable_text_set_run_attributes()
+ * used by atk_text_get_run_attributes(), atk_text_get_default_attributes()
+ * and atk_editable_text_set_run_attributes()
  **/
 typedef GSList AtkAttributeSet;
 
@@ -325,10 +326,11 @@ struct _AtkTextIface
                                                   gint             *start_offset,
                                                   gint             *end_offset);
   gint           (* get_caret_offset)             (AtkText          *text);
-  AtkAttributeSet* (* ref_run_attributes)         (AtkText         *text,
+  AtkAttributeSet* (* get_run_attributes)         (AtkText         *text,
                                                   gint             offset,
                                                   gint             *start_offset,
                                                   gint             *end_offset);
+  AtkAttributeSet* (* get_default_attributes)     (AtkText         *text);
   void           (* get_character_extents)        (AtkText          *text,
                                                    gint             offset,
                                                    gint             *x,
@@ -404,10 +406,11 @@ void          atk_text_get_character_extents              (AtkText          *tex
                                                            gint             *width,
                                                            gint             *height,
                                                            AtkCoordType            coords);
-AtkAttributeSet* atk_text_ref_run_attributes              (AtkText         *text,
+AtkAttributeSet* atk_text_get_run_attributes              (AtkText         *text,
                                                           gint             offset,
                                                           gint             *start_offset,
                                                           gint             *end_offset);
+AtkAttributeSet* atk_text_get_default_attributes          (AtkText         *text);
 gint          atk_text_get_character_count                (AtkText          *text);
 gint          atk_text_get_offset_at_point                (AtkText          *text,
                                                            gint             x,

diff --git a/docs/atk-sections.txt b/docs/atk-sections.txt
index 232dfc6b50f3c0514fde8b6760cbc7e38f440cf5..1697908bd0bfef3bb851a8d78aef9b9756613379 100644 (file)
--- a/docs/atk-sections.txt
+++ b/docs/atk-sections.txt
@@ -350,7 +350,8 @@ atk_text_get_text_at_offset
 atk_text_get_text_before_offset
 atk_text_get_caret_offset
 atk_text_get_character_extents
-atk_text_ref_run_attributes
+atk_text_get_run_attributes
+atk_text_get_default_attributes
 atk_text_get_character_count
 atk_text_get_offset_at_point
 atk_text_get_n_selections

diff --git a/docs/tmpl/atktext.sgml b/docs/tmpl/atktext.sgml
index 8b23ecc2edcaa56c92e9a89daec28f6428f0fb3b..61f3c4b80f855fdcbde078674fc7f94399f60f2f 100644 (file)
--- a/docs/tmpl/atktext.sgml
+++ b/docs/tmpl/atktext.sgml
@@ -32,7 +32,8 @@ AtkText
 @get_character_at_offset: 
 @get_text_before_offset: 
 @get_caret_offset: 
-@ref_run_attributes: 
+@get_run_attributes: 
+@get_default_attributes: 
 @get_character_extents: 
 @get_character_count: 
 @get_offset_at_point: 
@@ -166,7 +167,7 @@ AtkText
 @length: 
 
 
-<!-- ##### FUNCTION atk_text_ref_run_attributes ##### -->
+<!-- ##### FUNCTION atk_text_get_run_attributes ##### -->
 <para>
 
 </para>
@@ -178,6 +179,15 @@ AtkText
 @Returns: 
 
 
+<!-- ##### FUNCTION atk_text_get_default_attributes ##### -->
+<para>
+
+</para>
+
+@text: 
+@Returns: 
+
+
 <!-- ##### FUNCTION atk_text_get_character_count ##### -->
 <para>