diff options
author | billh <billh@e2bd861d-eb25-0410-b326-f6ed22b6b98c> | 2006-08-17 16:44:33 +0000 |
---|---|---|
committer | billh <billh@e2bd861d-eb25-0410-b326-f6ed22b6b98c> | 2006-08-17 16:44:33 +0000 |
commit | 1f3843d72458da51ffc10aa55cfb004c0b8d8f6a (patch) | |
tree | caf708eccfe00e53576982f755f1b37b0907a558 /docs/reference | |
parent | 09766b0dd76cdb8165ffe6c0ef1bca847da9e5be (diff) | |
download | at-spi2-core-1f3843d72458da51ffc10aa55cfb004c0b8d8f6a.tar.gz |
Documentation fixed for bug #351657.
Fixed the cspi return value demarshalling for AccessibleDocument_getAttributes.
git-svn-id: http://svn.gnome.org/svn/at-spi/trunk@850 e2bd861d-eb25-0410-b326-f6ed22b6b98c
Diffstat (limited to 'docs/reference')
-rw-r--r-- | docs/reference/cspi/at-spi-cspi-docs.sgml | 4 | ||||
-rw-r--r-- | docs/reference/cspi/at-spi-cspi-sections.txt | 24 | ||||
-rw-r--r-- | docs/reference/cspi/tmpl/spi_accessible.sgml | 18 | ||||
-rw-r--r-- | docs/reference/cspi/tmpl/spi_event.sgml | 2 | ||||
-rw-r--r-- | docs/reference/cspi/tmpl/spi_main.sgml | 14 | ||||
-rw-r--r-- | docs/reference/cspi/tmpl/spi_registry.sgml | 2 | ||||
-rw-r--r-- | docs/reference/cspi/tmpl/spi_selection.sgml | 10 | ||||
-rw-r--r-- | docs/reference/cspi/tmpl/spi_table.sgml | 15 | ||||
-rw-r--r-- | docs/reference/cspi/tmpl/spi_text.sgml | 22 | ||||
-rw-r--r-- | docs/reference/cspi/tmpl/spi_value.sgml | 9 |
10 files changed, 112 insertions, 8 deletions
diff --git a/docs/reference/cspi/at-spi-cspi-docs.sgml b/docs/reference/cspi/at-spi-cspi-docs.sgml index fb96e1f8..377e49b9 100644 --- a/docs/reference/cspi/at-spi-cspi-docs.sgml +++ b/docs/reference/cspi/at-spi-cspi-docs.sgml @@ -8,10 +8,12 @@ <!ENTITY at-spi-spi-accessible SYSTEM "xml/spi_accessible.xml"> <!ENTITY at-spi-spi-action SYSTEM "xml/spi_action.xml"> <!ENTITY at-spi-spi-component SYSTEM "xml/spi_component.xml"> +<!ENTITY at-spi-spi-document SYSTEM "xml/spi_document.xml"> <!ENTITY at-spi-spi-editabletext SYSTEM "xml/spi_editabletext.xml"> <!ENTITY at-spi-spi-hypertext SYSTEM "xml/spi_hypertext.xml"> <!ENTITY at-spi-spi-image SYSTEM "xml/spi_image.xml"> <!ENTITY at-spi-spi-selection SYSTEM "xml/spi_selection.xml"> +<!ENTITY at-spi-spi-streamable-content SYSTEM "xml/spi_streamable_content.xml"> <!ENTITY at-spi-spi-table SYSTEM "xml/spi_table.xml"> <!ENTITY at-spi-spi-text SYSTEM "xml/spi_text.xml"> <!ENTITY at-spi-spi-value SYSTEM "xml/spi_value.xml"> @@ -44,10 +46,12 @@ <title>Subinterface Methods</title> &at-spi-spi-action; &at-spi-spi-component; + &at-spi-spi-document; &at-spi-spi-editabletext; &at-spi-spi-hypertext; &at-spi-spi-image; &at-spi-spi-selection; + &at-spi-spi-streamable-content; &at-spi-spi-table; &at-spi-spi-text; &at-spi-spi-value; diff --git a/docs/reference/cspi/at-spi-cspi-sections.txt b/docs/reference/cspi/at-spi-cspi-sections.txt index 6e599504..4987a7f8 100644 --- a/docs/reference/cspi/at-spi-cspi-sections.txt +++ b/docs/reference/cspi/at-spi-cspi-sections.txt @@ -16,6 +16,7 @@ SPIException_getSourceType SPIException SPIExceptionCode SPIExceptionType +SPIExceptionHandler SPIBoolean SPIRect SPI_freeRect @@ -122,6 +123,7 @@ Accessible_getLocalizedRoleName Accessible_isAction Accessible_isApplication Accessible_isComponent +Accessible_isDocument Accessible_isEditableText Accessible_isHypertext Accessible_isImage @@ -133,6 +135,7 @@ Accessible_isValue Accessible_getAction Accessible_getApplication Accessible_getComponent +Accessible_getDocument Accessible_getEditableText Accessible_getHypertext Accessible_getImage @@ -164,13 +167,17 @@ cspi_return_val_if_fail cspi_return_if_ev cspi_return_val_if_ev cspi_check_ev +cspi_peek_ev cspi_dup_ref cspi_release_unref cspi_exception_get_text +cspi_exception_throw cspi_init cspi_ping cspi_main cspi_main_quit +cspi_role_from_spi_role +cspi_streams_close_all cspi_event_listener_get_type cspi_event_listener_new cspi_event_listener_get_corba @@ -247,6 +254,16 @@ AccessibleComponent_getAlpha </SECTION> <SECTION> +<FILE>spi_document</FILE> +<TITLE>AccessibleDocument Interface</TITLE> +AccessibleDocument_ref +AccessibleDocument_unref +AccessibleDocument_getAttributeValue +AccessibleDocument_getAttributes +AccessibleDocument_getLocale +</SECTION> + +<SECTION> <FILE>spi_editabletext</FILE> <TITLE>AccessibleEditableText Interface</TITLE> AccessibleEditableText_ref @@ -292,6 +309,7 @@ AccessibleSelection_getSelectedChild AccessibleSelection_selectChild AccessibleSelection_isChildSelected AccessibleSelection_deselectSelectedChild +AccessibleSelection_deselectChild AccessibleSelection_clearSelection AccessibleSelection_selectAll </SECTION> @@ -299,6 +317,8 @@ AccessibleSelection_selectAll <SECTION> <FILE>spi_streamable_content</FILE> <TITLE>AccessibleStreamableContent Interface</TITLE> +AccessibleStreamableContentSeekType +AccessibleStreamableContent_freeContentTypesList AccessibleStreamableContent_ref AccessibleStreamableContent_unref AccessibleStreamableContent_getContentTypes @@ -325,6 +345,7 @@ AccessibleTable_getNColumns AccessibleTable_getNRows AccessibleTable_getNSelectedColumns AccessibleTable_getNSelectedRows +AccessibleTable_getRowColumnExtentsAtIndex AccessibleTable_getRowAtIndex AccessibleTable_getRowDescription AccessibleTable_getRowExtentAt @@ -367,6 +388,8 @@ AccessibleText_setCaretOffset AccessibleText_setSelection AccessibleText_getCharacterAtOffset AccessibleText_getDefaultAttributes +AccessibleText_getAttributeRun +AccessibleText_getDefaultAttributeSet AccessibleTextRange_freeRanges </SECTION> @@ -379,6 +402,7 @@ AccessibleValue_getCurrentValue AccessibleValue_getMaximumValue AccessibleValue_getMinimumValue AccessibleValue_setCurrentValue +AccessibleValue_getMinimumIncrement </SECTION> <SECTION> diff --git a/docs/reference/cspi/tmpl/spi_accessible.sgml b/docs/reference/cspi/tmpl/spi_accessible.sgml index 454d8e13..5de46734 100644 --- a/docs/reference/cspi/tmpl/spi_accessible.sgml +++ b/docs/reference/cspi/tmpl/spi_accessible.sgml @@ -196,6 +196,15 @@ object corresponding to an user interface element. @Returns: +<!-- ##### FUNCTION Accessible_isDocument ##### --> +<para> + +</para> + +@obj: +@Returns: + + <!-- ##### FUNCTION Accessible_isEditableText ##### --> <para> @@ -295,6 +304,15 @@ object corresponding to an user interface element. @Returns: +<!-- ##### FUNCTION Accessible_getDocument ##### --> +<para> + +</para> + +@obj: +@Returns: + + <!-- ##### FUNCTION Accessible_getEditableText ##### --> <para> diff --git a/docs/reference/cspi/tmpl/spi_event.sgml b/docs/reference/cspi/tmpl/spi_event.sgml index 8ba9078d..ae70925d 100644 --- a/docs/reference/cspi/tmpl/spi_event.sgml +++ b/docs/reference/cspi/tmpl/spi_event.sgml @@ -24,8 +24,6 @@ AccessibleEvent is a struct used to encapsulate event information. @type: @source: -@detail1: -@detail2: <!-- ##### USER_FUNCTION AccessibleEventListenerCB ##### --> <para> diff --git a/docs/reference/cspi/tmpl/spi_main.sgml b/docs/reference/cspi/tmpl/spi_main.sgml index 3b1b4532..5683a091 100644 --- a/docs/reference/cspi/tmpl/spi_main.sgml +++ b/docs/reference/cspi/tmpl/spi_main.sgml @@ -140,15 +140,21 @@ SPI main loop and initialization @SPI_EXCEPTION_SOURCE_REGISTRY: @SPI_EXCEPTION_SOURCE_DEVICE: +<!-- ##### USER_FUNCTION SPIExceptionHandler ##### --> +<para> + +</para> + +@err: +@is_fatal: +@Returns: + + <!-- ##### STRUCT SPIRect ##### --> <para> </para> -@x: -@y: -@width: -@height: <!-- ##### FUNCTION SPI_freeRect ##### --> <para> diff --git a/docs/reference/cspi/tmpl/spi_registry.sgml b/docs/reference/cspi/tmpl/spi_registry.sgml index 63fd0aca..458a9617 100644 --- a/docs/reference/cspi/tmpl/spi_registry.sgml +++ b/docs/reference/cspi/tmpl/spi_registry.sgml @@ -259,9 +259,7 @@ This is a synonym for AccessibleDeviceEvent. AccessibleDeviceEvent is a struct which encapsulates a device event. </para> -@keyID: @keystring: -@timestamp: @type: @is_text: diff --git a/docs/reference/cspi/tmpl/spi_selection.sgml b/docs/reference/cspi/tmpl/spi_selection.sgml index f19caaa8..39822f56 100644 --- a/docs/reference/cspi/tmpl/spi_selection.sgml +++ b/docs/reference/cspi/tmpl/spi_selection.sgml @@ -82,6 +82,16 @@ AccessibleSelection Interface @Returns: +<!-- ##### FUNCTION AccessibleSelection_deselectChild ##### --> +<para> + +</para> + +@obj: +@childIndex: +@Returns: + + <!-- ##### FUNCTION AccessibleSelection_clearSelection ##### --> <para> diff --git a/docs/reference/cspi/tmpl/spi_table.sgml b/docs/reference/cspi/tmpl/spi_table.sgml index b3f5ecfe..cafd3ddb 100644 --- a/docs/reference/cspi/tmpl/spi_table.sgml +++ b/docs/reference/cspi/tmpl/spi_table.sgml @@ -141,6 +141,21 @@ AccessibleTable Interface @Returns: +<!-- ##### FUNCTION AccessibleTable_getRowColumnExtentsAtIndex ##### --> +<para> + +</para> + +@obj: +@index: +@row: +@col: +@row_extents: +@col_extents: +@is_selected: +@Returns: + + <!-- ##### FUNCTION AccessibleTable_getRowAtIndex ##### --> <para> diff --git a/docs/reference/cspi/tmpl/spi_text.sgml b/docs/reference/cspi/tmpl/spi_text.sgml index a4fa387d..9e151cff 100644 --- a/docs/reference/cspi/tmpl/spi_text.sgml +++ b/docs/reference/cspi/tmpl/spi_text.sgml @@ -277,6 +277,28 @@ AccessibleText Interface @Returns: +<!-- ##### FUNCTION AccessibleText_getAttributeRun ##### --> +<para> + +</para> + +@obj: +@offset: +@startOffset: +@endOffset: +@includeDefaults: +@Returns: + + +<!-- ##### FUNCTION AccessibleText_getDefaultAttributeSet ##### --> +<para> + +</para> + +@obj: +@Returns: + + <!-- ##### FUNCTION AccessibleTextRange_freeRanges ##### --> <para> diff --git a/docs/reference/cspi/tmpl/spi_value.sgml b/docs/reference/cspi/tmpl/spi_value.sgml index 6be0fb6e..4c0a4ae6 100644 --- a/docs/reference/cspi/tmpl/spi_value.sgml +++ b/docs/reference/cspi/tmpl/spi_value.sgml @@ -77,3 +77,12 @@ be programmatically set, if the implementor's state does not include READONLY. @Returns: +<!-- ##### FUNCTION AccessibleValue_getMinimumIncrement ##### --> +<para> + +</para> + +@obj: +@Returns: + + |