summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPadraig O'Briain <padraig.obriain@sun.com>2004-10-28 09:49:47 +0000
committerPadraig O'Briain <padraigo@src.gnome.org>2004-10-28 09:49:47 +0000
commit8d3832dcb70ced059de392056a28329b8185a478 (patch)
treee6291feb6110503cd974c05fab89bbcb67f6310e
parent38ee6844b0a0d0f1fccd6078f63961787ca06368 (diff)
downloadatk-8d3832dcb70ced059de392056a28329b8185a478.tar.gz
Add a more descriptive title in the docs. Patch from Diego Gonzalez. (bug
2004-10-28 Padraig O'Briain <padraig.obriain@sun.com> * docs/atk-docs.sgml: Add a more descriptive title in the docs. Patch from Diego Gonzalez. (bug #156296) * atk/text.c (Clarify meaning of endd_offset for atk_text_get_text_at_offset(). Patch from Bill Haneman. (bug #156574)
-rw-r--r--ChangeLog9
-rwxr-xr-xatk/atktext.c35
-rw-r--r--docs/atk-docs.sgml2
3 files changed, 31 insertions, 15 deletions
diff --git a/ChangeLog b/ChangeLog
index d579a49..4d353d1 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2004-10-28 Padraig O'Briain <padraig.obriain@sun.com>
+
+ * docs/atk-docs.sgml: Add a more descriptive title in the docs.
+ Patch from Diego Gonzalez. (bug #156296)
+
+ * atk/text.c (Clarify meaning of endd_offset for
+ atk_text_get_text_at_offset().
+ Patch from Bill Haneman. (bug #156574)
+
2004-09-14 Abel Cheung <maddog@linuxhall.org>
* configure.in: Added "ar" to ALL_LINGUAS.
diff --git a/atk/atktext.c b/atk/atktext.c
index ccc582d..9c468bc 100755
--- a/atk/atktext.c
+++ b/atk/atktext.c
@@ -222,8 +222,9 @@ atk_text_get_character_at_offset (AtkText *text,
* @text: an #AtkText
* @offset: position
* @boundary_type: An #AtkTextBoundary
- * @start_offset: the start offset of the returned string.
- * @end_offset: the end offset of the returned string.
+ * @start_offset: the start offset of the returned string
+ * @end_offset: the offset of the first character after the
+ * returned substring
*
* Gets the specified text.
*
@@ -303,8 +304,9 @@ atk_text_get_text_after_offset (AtkText *text,
* @text: an #AtkText
* @offset: position
* @boundary_type: An #AtkTextBoundary
- * @start_offset: the start offset of the returned string.
- * @end_offset: the end offset of the returned string.
+ * @start_offset: the start offset of the returned string
+ * @end_offset: the offset of the first character after the
+ * returned substring
*
* Gets the specified text.
*
@@ -391,8 +393,9 @@ atk_text_get_text_at_offset (AtkText *text,
* @text: an #AtkText
* @offset: position
* @boundary_type: An #AtkTextBoundary
- * @start_offset: the start offset of the returned string.
- * @end_offset: the end offset of the returned string.
+ * @start_offset: the start offset of the returned string
+ * @end_offset: the offset of the first character after the
+ * returned substring
*
* Gets the specified text.
*
@@ -499,10 +502,10 @@ atk_text_get_caret_offset (AtkText *text)
* atk_text_get_character_extents:
* @text: an #AtkText
* @offset: The offset of the text character for which bounding information is required.
- * @x: Pointer for the x cordinate of the bounding box.
- * @y: Pointer for the y cordinate of the bounding box.
+ * @x: Pointer for the x cordinate of the bounding box
+ * @y: Pointer for the y cordinate of the bounding box
* @width: Pointer for the width of the bounding box
- * @height: Pointer for the height of the bounding box.
+ * @height: Pointer for the height of the bounding box
* @coords: specify whether coordinates are relative to the screen or widget window
*
* Get the bounding box containing the glyph representing the character at
@@ -570,8 +573,10 @@ atk_text_get_character_extents (AtkText *text,
*Creates an #AtkAttributeSet which consists of the attributes explicitly
*set at the position @offset in the text. @start_offset and @end_offset are
*set to the start and end of the range around @offset where the attributes are
- *invariant. See the enum AtkTextAttribute for types of text attributes that
- *can be returned. Note that other attributes may also be returned.
+ *invariant. Note that @end_offset is the offset of the first character
+ *after the range. See the enum AtkTextAttribute for types of text
+ *attributes that can be returned. Note that other attributes may also be
+ *returned.
*
*Returns: an #AtkAttributeSet which contains the attributes explicitly set
*at @offset. This #AtkAttributeSet should be freed by a call to
@@ -726,7 +731,8 @@ atk_text_get_n_selections (AtkText *text)
* of the text region is assigned the number 0, etc. Note that adding,
* moving or deleting a selected region can change the numbering.
* @start_offset: passes back the start position of the selected region
- * @end_offset: passes back the end position of the selected region
+ * @end_offset: passes back the end position of (e.g. offset immediately past)
+ * the selected region
*
* Gets the text from the specified selection.
*
@@ -768,7 +774,7 @@ atk_text_get_selection (AtkText *text,
* atk_text_add_selection:
* @text: an #AtkText
* @start_offset: the start position of the selected region
- * @end_offset: the end position of the selected region
+ * @end_offset: the offset of the first character after the selected region.
*
* Adds a selection bounded by the specified offsets.
*
@@ -829,7 +835,8 @@ atk_text_remove_selection (AtkText *text,
* of the text region is assigned the number 0, etc. Note that adding,
* moving or deleting a selected region can change the numbering.
* @start_offset: the new start position of the selection
- * @end_offset: the new end position of the selection
+ * @end_offset: the new end position of (e.g. offset immediately past)
+ * the selection
*
* Changes the start and end offset of the specified selection.
*
diff --git a/docs/atk-docs.sgml b/docs/atk-docs.sgml
index c36e234..4b332ec 100644
--- a/docs/atk-docs.sgml
+++ b/docs/atk-docs.sgml
@@ -29,7 +29,7 @@
<book>
<bookinfo>
- <title>ATK Library Reference Manual</title>
+ <title>ATK - Accessibility Toolkit</title>
<releaseinfo>for ATK &version;</releaseinfo>
</bookinfo>