From 333c581647770b1f647cd3c2e9cad98324ef14b6 Mon Sep 17 00:00:00 2001 From: billh Date: Wed, 17 Apr 2002 00:20:54 +0000 Subject: [PATCH] Doc fixes, and a (minor) API fix to AccessibleStreamableContent_seek. Incremented version to 0.12. git-svn-id: http://svn.gnome.org/svn/at-spi/trunk@274 e2bd861d-eb25-0410-b326-f6ed22b6b98c --- ChangeLog | 26 +++++++++++++++++++++ configure.in | 2 +- cspi/spi-roletypes.h | 2 +- cspi/spi.h | 3 ++- cspi/spi_event.c | 2 +- cspi/spi_registry.c | 6 +++++ cspi/spi_streamablecontent.c | 6 ++--- docs/reference/cspi/at-spi-cspi-sections.txt | 19 ++++++++++++++- docs/reference/cspi/tmpl/spi_accessible.sgml | 26 +++++++++++++++++++++ docs/reference/cspi/tmpl/spi_registry.sgml | 35 ++++++++++++++++++++++++++++ 10 files changed, 118 insertions(+), 9 deletions(-) diff --git a/ChangeLog b/ChangeLog index e919d5f..a16e5f3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,31 @@ 2002-04-16 Bill Haneman + * configure.in: + Revved version to 0.12 due to API change (see below). + + * cspi/spi-roletypes.h: + removed (obsolete) SPI_ROLE_FOCUS_TRAVERSABLE + definition from the inline docs, and added docs + for SPI_ROLE_LAST_DEFINED. + + * cspi/spi.h: + * cspi/spi_streamablecontent.c: + Added missing seek_type parameter to + (so far unused) method, + AccessibleStreamableContent_seek(). + [ RT approval JodyG. ] + + * cspi/spi_event.c: + Fixed docs for SPI_createAccessibleKeystrokeListener. + + * cspi/spi_registry.c: + Fixed docs for SPI_KEYSET_ALL_KEYS. + + * docs/reference/cspi/at-spi-cspi-sections.txt: + Added a number of missing APIs to SECTIONS. + +2002-04-16 Bill Haneman + * registryd/Makefile.am: * cspi/Makefile.am: * cspi/bonobo/Makefile.am: diff --git a/configure.in b/configure.in index 0236f30..d946def 100644 --- a/configure.in +++ b/configure.in @@ -1,7 +1,7 @@ AC_INIT(idl/Accessibility.idl) AT_SPI_MAJOR_VERSION=0 -AT_SPI_MINOR_VERSION=11 +AT_SPI_MINOR_VERSION=12 AT_SPI_MICRO_VERSION=0 AT_SPI_INTERFACE_AGE=0 AT_SPI_BINARY_AGE=0 diff --git a/cspi/spi-roletypes.h b/cspi/spi-roletypes.h index a281895..8cae974 100644 --- a/cspi/spi-roletypes.h +++ b/cspi/spi-roletypes.h @@ -35,7 +35,6 @@ extern "C" { * directory and lets the user select a file, browse a different * directory, or specify a filename. * @SPI_ROLE_FILLER: A object that fills up space in a user interface - * @SPI_ROLE_FOCUS_TRAVERSABLE: XXX Not sure about this. * @SPI_ROLE_FONT_CHOOSER: Allows selection of a display font * @SPI_ROLE_FRAME: A top level window with a title bar, border, menubar, etc. * @SPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all @@ -109,6 +108,7 @@ extern "C" { * @SPI_ROLE_WINDOW: A top level window with no title or border. * @SPI_ROLE_EXTENDED: This object's role is not included in the standard role list and * should be queried by name. + * @SPI_ROLE_LAST_DEFINED: Used to determine the end of the role enumeration. **/ typedef enum { diff --git a/cspi/spi.h b/cspi/spi.h index 5deb744..2c487cc 100644 --- a/cspi/spi.h +++ b/cspi/spi.h @@ -533,7 +533,8 @@ AccessibleStreamableContent_open (AccessibleStreamableContent *obj, const char *content_type); SPIBoolean AccessibleStreamableContent_seek (AccessibleStreamableContent *obj, - long int offset); + long int offset, + unsigned int seek_type); SPIBoolean AccessibleStreamableContent_read (AccessibleStreamableContent *obj, void *buff, diff --git a/cspi/spi_event.c b/cspi/spi_event.c index 469dedc..33c469a 100644 --- a/cspi/spi_event.c +++ b/cspi/spi_event.c @@ -184,7 +184,7 @@ AccessibleEventListener_removeCallback (AccessibleEventListener *listener, } /** - * createAccessibleKeystrokeListener: + * SPI_createAccessibleKeystrokeListener: * @callback : an #AccessibleKeystrokeListenerCB callback function, or NULL. * @user_data: a pointer to data which will be passed to the callback when invoked. * diff --git a/cspi/spi_registry.c b/cspi/spi_registry.c index cc0dca2..cea5cf6 100644 --- a/cspi/spi_registry.c +++ b/cspi/spi_registry.c @@ -286,6 +286,12 @@ SPI_freeDesktopList (Accessible **desktop_list) } /** + * SPI_KEYSET_ALL_KEYS: + * @SPI_KEYSET_ALL_KEYS: A special value for an AccessibleKeySet type, which tacitly + * includes all keycodes and keyvals for the specified modifier set. + **/ + +/** * SPI_registerAccessibleKeystrokeListener: * @listener: a pointer to the #AccessibleKeystrokeListener for which * keystroke events are requested. diff --git a/cspi/spi_streamablecontent.c b/cspi/spi_streamablecontent.c index 5fe36a5..9a2db99 100644 --- a/cspi/spi_streamablecontent.c +++ b/cspi/spi_streamablecontent.c @@ -54,9 +54,6 @@ AccessibleStreamableContent_getContentTypes (AccessibleStreamableContent *obj) * @obj: a pointer to the #AccessibleStreamableContent implementor on which to operate. * @content_type: a string specifying the content type to retrieve (should match one * of the return strings from #AccessibleStreamableContent_getContentTypes ()). - * @fp: a pointer to a FILE pointer into which is placed a file handle suitable for - * reading the content, if possible. Not all content types support file-handle - * interaction, so check this parameter for NULL before use. * * Open a streaming connection to an AccessibleStreamableContent implementor, * of a particular content type @@ -88,7 +85,8 @@ AccessibleStreamableContent_open (AccessibleStreamableContent *obj, **/ SPIBoolean AccessibleStreamableContent_seek (AccessibleStreamableContent *obj, - long int offset) + long int offset, + unsigned int seek_type) { /* TODO: connect this to the correct libspi implementation code */ return FALSE; diff --git a/docs/reference/cspi/at-spi-cspi-sections.txt b/docs/reference/cspi/at-spi-cspi-sections.txt index 6ce8cd5..576c03e 100644 --- a/docs/reference/cspi/at-spi-cspi-sections.txt +++ b/docs/reference/cspi/at-spi-cspi-sections.txt @@ -29,6 +29,7 @@ AccessibleKeySynthType SPI_getDesktopCount SPI_getDesktop SPI_getDesktopList +SPI_freeDesktopList AccessibleKeystrokeListenerCB AccessibleKeyEventMask @@ -36,13 +37,15 @@ AccessibleKeyMaskType AccessibleKeyEventType AccessibleKeyListenerSyncType AccessibleKeystroke +SPI_KEYSET_ALL_KEYS +SPI_createAccessibleKeySet +SPI_freeAccessibleKeySet SPI_createAccessibleKeystrokeListener SPI_registerGlobalEventListener SPI_deregisterGlobalEventListener SPI_deregisterGlobalEventListenerAll SPI_registerAccessibleKeystrokeListener SPI_deregisterAccessibleKeystrokeListener -AccessibleKeystrokeListener_ref AccessibleKeystrokeListener_unref AccessibleKeystrokeListener_removeCallback AccessibleKeystrokeListener_addCallback @@ -53,6 +56,7 @@ SPI_generateMouseEvent
spi_accessible Accessible Objects +Accessible Accessible_ref Accessible_unref Accessible_getName @@ -73,6 +77,7 @@ Accessible_isEditableText Accessible_isHypertext Accessible_isImage Accessible_isSelection +Accessible_isStreamableContent Accessible_isTable Accessible_isText Accessible_isValue @@ -83,6 +88,7 @@ Accessible_getEditableText Accessible_getHypertext Accessible_getImage Accessible_getSelection +Accessible_getStreamableContent Accessible_getTable Accessible_getText Accessible_getValue @@ -183,6 +189,17 @@ AccessibleSelection_selectAll
+spi_streamable_content +AccessibleStreamableContent Interface +AccessibleStreamableContent_ref +AccessibleStreamableContent_unref +AccessibleStreamableContent_getContentTypes +AccessibleStreamableContent_open +AccessibleStreamableContent_seek +AccessibleStreamableContent_read +
+ +
spi_table AccessibleTable Interface AccessibleTable_ref diff --git a/docs/reference/cspi/tmpl/spi_accessible.sgml b/docs/reference/cspi/tmpl/spi_accessible.sgml index 9b7b374..da975e7 100644 --- a/docs/reference/cspi/tmpl/spi_accessible.sgml +++ b/docs/reference/cspi/tmpl/spi_accessible.sgml @@ -14,6 +14,14 @@ Accessible Objects + + + + + +@objref: +@ref_count: + @@ -188,6 +196,15 @@ Accessible Objects @Returns: + + + + + +@obj: +@Returns: + + @@ -278,6 +295,15 @@ Accessible Objects @Returns: + + + + + +@obj: +@Returns: + + diff --git a/docs/reference/cspi/tmpl/spi_registry.sgml b/docs/reference/cspi/tmpl/spi_registry.sgml index 09ab7cd..23adfde 100644 --- a/docs/reference/cspi/tmpl/spi_registry.sgml +++ b/docs/reference/cspi/tmpl/spi_registry.sgml @@ -53,6 +53,14 @@ Registry queries @list: + + + + + +@desktop_list: + + @@ -99,6 +107,33 @@ Registry queries + + + + + + + + + + + + +@len: +@keysyms: +@keycodes: +@keystrings: +@Returns: + + + + + + + +@keyset: + + -- 2.7.4