summaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorbillh <billh@e2bd861d-eb25-0410-b326-f6ed22b6b98c>2002-02-12 14:11:46 +0000
committerbillh <billh@e2bd861d-eb25-0410-b326-f6ed22b6b98c>2002-02-12 14:11:46 +0000
commit5206d4b3a6014336c1e89632100fce6b300fd694 (patch)
treeb885b6407d750ececb6310e1dcb1455a6af90ad7 /docs/reference
parent4f87999cc1ab8e8e72848d52fa9a48fbfa6cb1d9 (diff)
downloadat-spi2-core-5206d4b3a6014336c1e89632100fce6b300fd694.tar.gz
Magnification utility enhancements.
git-svn-id: http://svn.gnome.org/svn/at-spi/trunk@236 e2bd861d-eb25-0410-b326-f6ed22b6b98c
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/cspi/tmpl/spi_accessible.sgml3
-rw-r--r--docs/reference/cspi/tmpl/spi_action.sgml12
-rw-r--r--docs/reference/cspi/tmpl/spi_component.sgml9
-rw-r--r--docs/reference/cspi/tmpl/spi_editabletext.sgml18
-rw-r--r--docs/reference/cspi/tmpl/spi_hyperlink.sgml7
-rw-r--r--docs/reference/cspi/tmpl/spi_hypertext.sgml6
-rw-r--r--docs/reference/cspi/tmpl/spi_image.sgml3
-rw-r--r--docs/reference/cspi/tmpl/spi_registry.sgml6
-rw-r--r--docs/reference/cspi/tmpl/spi_selection.sgml12
-rw-r--r--docs/reference/cspi/tmpl/spi_table.sgml45
-rw-r--r--docs/reference/cspi/tmpl/spi_text.sgml32
11 files changed, 48 insertions, 105 deletions
diff --git a/docs/reference/cspi/tmpl/spi_accessible.sgml b/docs/reference/cspi/tmpl/spi_accessible.sgml
index 449ffe5a..f1778050 100644
--- a/docs/reference/cspi/tmpl/spi_accessible.sgml
+++ b/docs/reference/cspi/tmpl/spi_accessible.sgml
@@ -76,9 +76,8 @@ Accessible Objects
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@childIndex:
+@Returns:
<!-- ##### FUNCTION Accessible_getIndexInParent ##### -->
diff --git a/docs/reference/cspi/tmpl/spi_action.sgml b/docs/reference/cspi/tmpl/spi_action.sgml
index e9b21426..4674885b 100644
--- a/docs/reference/cspi/tmpl/spi_action.sgml
+++ b/docs/reference/cspi/tmpl/spi_action.sgml
@@ -49,9 +49,8 @@ AccessibleAction Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@i:
+@Returns:
<!-- ##### FUNCTION AccessibleAction_getKeyBinding ##### -->
@@ -60,9 +59,8 @@ AccessibleAction Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@i:
+@Returns:
<!-- ##### FUNCTION AccessibleAction_getName ##### -->
@@ -71,9 +69,8 @@ AccessibleAction Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@i:
+@Returns:
<!-- ##### FUNCTION AccessibleAction_getDescription ##### -->
@@ -82,8 +79,7 @@ AccessibleAction Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@i:
+@Returns:
diff --git a/docs/reference/cspi/tmpl/spi_component.sgml b/docs/reference/cspi/tmpl/spi_component.sgml
index bba2e1d6..b6a1372d 100644
--- a/docs/reference/cspi/tmpl/spi_component.sgml
+++ b/docs/reference/cspi/tmpl/spi_component.sgml
@@ -62,11 +62,10 @@ AccessibleComponent Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@x:
@y:
@ctype:
+@Returns:
<!-- ##### FUNCTION AccessibleComponent_getAccessibleAtPoint ##### -->
@@ -75,11 +74,10 @@ AccessibleComponent Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@x:
@y:
@ctype:
+@Returns:
<!-- ##### FUNCTION AccessibleComponent_getExtents ##### -->
@@ -88,7 +86,6 @@ AccessibleComponent Interface
</para>
@obj:
-<!-- # Unused Parameters # -->
@x:
@y:
@width:
@@ -102,7 +99,6 @@ AccessibleComponent Interface
</para>
@obj:
-<!-- # Unused Parameters # -->
@x:
@y:
@ctype:
@@ -114,7 +110,6 @@ AccessibleComponent Interface
</para>
@obj:
-<!-- # Unused Parameters # -->
@width:
@height:
diff --git a/docs/reference/cspi/tmpl/spi_editabletext.sgml b/docs/reference/cspi/tmpl/spi_editabletext.sgml
index 8fa6fddc..730d515e 100644
--- a/docs/reference/cspi/tmpl/spi_editabletext.sgml
+++ b/docs/reference/cspi/tmpl/spi_editabletext.sgml
@@ -40,10 +40,9 @@ AccessibleEditableText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@startPos:
@endPos:
+@Returns:
<!-- ##### FUNCTION AccessibleEditableText_deleteText ##### -->
@@ -52,10 +51,9 @@ AccessibleEditableText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@startPos:
@endPos:
+@Returns:
<!-- ##### FUNCTION AccessibleEditableText_insertText ##### -->
@@ -64,11 +62,10 @@ AccessibleEditableText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@position:
@text:
@length:
+@Returns:
<!-- ##### FUNCTION AccessibleEditableText_cutText ##### -->
@@ -77,10 +74,9 @@ AccessibleEditableText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@startPos:
@endPos:
+@Returns:
<!-- ##### FUNCTION AccessibleEditableText_pasteText ##### -->
@@ -89,9 +85,8 @@ AccessibleEditableText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@position:
+@Returns:
<!-- ##### FUNCTION AccessibleEditableText_setTextContents ##### -->
@@ -111,9 +106,8 @@ AccessibleEditableText Interface
@obj:
@attributes:
-@Returns:
-<!-- # Unused Parameters # -->
@startOffset:
@endOffset:
+@Returns:
diff --git a/docs/reference/cspi/tmpl/spi_hyperlink.sgml b/docs/reference/cspi/tmpl/spi_hyperlink.sgml
index 2f923b09..8d03b55f 100644
--- a/docs/reference/cspi/tmpl/spi_hyperlink.sgml
+++ b/docs/reference/cspi/tmpl/spi_hyperlink.sgml
@@ -45,7 +45,6 @@ AccessibleHyperlink Interface
</para>
@obj:
-<!-- # Unused Parameters # -->
@startIndex:
@endIndex:
@@ -56,9 +55,8 @@ AccessibleHyperlink Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@i:
+@Returns:
<!-- ##### FUNCTION AccessibleHyperlink_getURI ##### -->
@@ -67,9 +65,8 @@ AccessibleHyperlink Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@i:
+@Returns:
<!-- ##### FUNCTION AccessibleHyperlink_isValid ##### -->
diff --git a/docs/reference/cspi/tmpl/spi_hypertext.sgml b/docs/reference/cspi/tmpl/spi_hypertext.sgml
index 30d313a1..5a7f2c08 100644
--- a/docs/reference/cspi/tmpl/spi_hypertext.sgml
+++ b/docs/reference/cspi/tmpl/spi_hypertext.sgml
@@ -49,9 +49,8 @@ AccessibleHypertext Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@linkIndex:
+@Returns:
<!-- ##### FUNCTION AccessibleHypertext_getLinkIndex ##### -->
@@ -60,8 +59,7 @@ AccessibleHypertext Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@characterOffset:
+@Returns:
diff --git a/docs/reference/cspi/tmpl/spi_image.sgml b/docs/reference/cspi/tmpl/spi_image.sgml
index f666d78a..32f036ed 100644
--- a/docs/reference/cspi/tmpl/spi_image.sgml
+++ b/docs/reference/cspi/tmpl/spi_image.sgml
@@ -49,7 +49,6 @@ AccessibleImage Interface
</para>
@obj:
-<!-- # Unused Parameters # -->
@width:
@height:
@@ -60,7 +59,6 @@ AccessibleImage Interface
</para>
@obj:
-<!-- # Unused Parameters # -->
@x:
@y:
@ctype:
@@ -72,7 +70,6 @@ AccessibleImage Interface
</para>
@obj:
-<!-- # Unused Parameters # -->
@x:
@y:
@width:
diff --git a/docs/reference/cspi/tmpl/spi_registry.sgml b/docs/reference/cspi/tmpl/spi_registry.sgml
index fb553493..09ab7cd6 100644
--- a/docs/reference/cspi/tmpl/spi_registry.sgml
+++ b/docs/reference/cspi/tmpl/spi_registry.sgml
@@ -195,11 +195,10 @@ Registry queries
</para>
-@Returns:
-<!-- # Unused Parameters # -->
@keyval:
@keystring:
@synth_type:
+@Returns:
<!-- ##### FUNCTION SPI_generateMouseEvent ##### -->
@@ -207,10 +206,9 @@ Registry queries
</para>
-@Returns:
-<!-- # Unused Parameters # -->
@x:
@y:
@name:
+@Returns:
diff --git a/docs/reference/cspi/tmpl/spi_selection.sgml b/docs/reference/cspi/tmpl/spi_selection.sgml
index 2668a505..d46f4aef 100644
--- a/docs/reference/cspi/tmpl/spi_selection.sgml
+++ b/docs/reference/cspi/tmpl/spi_selection.sgml
@@ -49,9 +49,8 @@ AccessibleSelection Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@selectedChildIndex:
+@Returns:
<!-- ##### FUNCTION AccessibleSelection_selectChild ##### -->
@@ -60,9 +59,8 @@ AccessibleSelection Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@childIndex:
+@Returns:
<!-- ##### FUNCTION AccessibleSelection_isChildSelected ##### -->
@@ -71,9 +69,8 @@ AccessibleSelection Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@childIndex:
+@Returns:
<!-- ##### FUNCTION AccessibleSelection_deselectSelectedChild ##### -->
@@ -82,9 +79,8 @@ AccessibleSelection Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@selectedChildIndex:
+@Returns:
<!-- ##### FUNCTION AccessibleSelection_clearSelection ##### -->
diff --git a/docs/reference/cspi/tmpl/spi_table.sgml b/docs/reference/cspi/tmpl/spi_table.sgml
index 38d142af..331c16af 100644
--- a/docs/reference/cspi/tmpl/spi_table.sgml
+++ b/docs/reference/cspi/tmpl/spi_table.sgml
@@ -40,10 +40,9 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@row:
@column:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_getCaption ##### -->
@@ -61,9 +60,8 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@index:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_getColumnDescription ##### -->
@@ -72,9 +70,8 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@column:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_getColumnExtentAt ##### -->
@@ -83,10 +80,9 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@row:
@column:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_getColumnHeader ##### -->
@@ -95,9 +91,8 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@column:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_getIndexAt ##### -->
@@ -106,10 +101,9 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@row:
@column:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_getNColumns ##### -->
@@ -154,9 +148,8 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@index:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_getRowDescription ##### -->
@@ -165,9 +158,8 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@row:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_getRowExtentAt ##### -->
@@ -176,10 +168,9 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@row:
@column:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_getRowHeader ##### -->
@@ -188,9 +179,8 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@row:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_getSelectedRows ##### -->
@@ -199,9 +189,8 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@selectedRows:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_getSelectedColumns ##### -->
@@ -210,9 +199,8 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@selectedColumns:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_getSummary ##### -->
@@ -230,9 +218,8 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@column:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_isRowSelected ##### -->
@@ -241,9 +228,8 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@row:
+@Returns:
<!-- ##### FUNCTION AccessibleTable_isSelected ##### -->
@@ -252,9 +238,8 @@ AccessibleTable Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@row:
@column:
+@Returns:
diff --git a/docs/reference/cspi/tmpl/spi_text.sgml b/docs/reference/cspi/tmpl/spi_text.sgml
index b3bc9dd3..c4e6c774 100644
--- a/docs/reference/cspi/tmpl/spi_text.sgml
+++ b/docs/reference/cspi/tmpl/spi_text.sgml
@@ -55,10 +55,9 @@ AccessibleText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@startOffset:
@endOffset:
+@Returns:
<!-- ##### FUNCTION AccessibleText_getAttributes ##### -->
@@ -67,11 +66,10 @@ AccessibleText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@offset:
@startOffset:
@endOffset:
+@Returns:
<!-- ##### FUNCTION AccessibleText_getCaretOffset ##### -->
@@ -98,7 +96,6 @@ AccessibleText Interface
</para>
@obj:
-<!-- # Unused Parameters # -->
@offset:
@x:
@y:
@@ -122,11 +119,10 @@ AccessibleText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@x:
@y:
@type:
+@Returns:
<!-- ##### FUNCTION AccessibleText_getSelection ##### -->
@@ -135,7 +131,6 @@ AccessibleText Interface
</para>
@obj:
-<!-- # Unused Parameters # -->
@selectionNum:
@startOffset:
@endOffset:
@@ -147,10 +142,9 @@ AccessibleText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@startOffset:
@endOffset:
+@Returns:
<!-- ##### FUNCTION AccessibleText_getTextBeforeOffset ##### -->
@@ -159,12 +153,11 @@ AccessibleText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@offset:
@type:
@startOffset:
@endOffset:
+@Returns:
<!-- ##### FUNCTION AccessibleText_getTextAfterOffset ##### -->
@@ -173,12 +166,11 @@ AccessibleText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@offset:
@type:
@startOffset:
@endOffset:
+@Returns:
<!-- ##### FUNCTION AccessibleText_getTextAtOffset ##### -->
@@ -187,12 +179,11 @@ AccessibleText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@offset:
@type:
@startOffset:
@endOffset:
+@Returns:
<!-- ##### FUNCTION AccessibleText_removeSelection ##### -->
@@ -201,9 +192,8 @@ AccessibleText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@selectionNum:
+@Returns:
<!-- ##### FUNCTION AccessibleText_setCaretOffset ##### -->
@@ -212,9 +202,8 @@ AccessibleText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@newOffset:
+@Returns:
<!-- ##### FUNCTION AccessibleText_setSelection ##### -->
@@ -223,10 +212,9 @@ AccessibleText Interface
</para>
@obj:
-@Returns:
-<!-- # Unused Parameters # -->
@selectionNum:
@startOffset:
@endOffset:
+@Returns: