From bcc7fd3a2c701c09411721dcbcd73793b32a7275 Mon Sep 17 00:00:00 2001 From: billh Date: Wed, 21 Nov 2001 17:16:57 +0000 Subject: [PATCH] Restructured docs directory, added docs/reference/idl and docs/reference/cspi. Fixed docs build problem, should build from a cold start now, including idl docs. git-svn-id: http://svn.gnome.org/svn/at-spi/trunk@107 e2bd861d-eb25-0410-b326-f6ed22b6b98c --- ChangeLog | 22 ++ configure.in | 3 + docs/Makefile.am | 161 +-------- docs/reference/Makefile.am | 3 + docs/reference/cspi/Makefile.am | 162 +++++++++ .../cspi/at-spi-cspi-docs.sgml} | 0 .../cspi/at-spi-cspi-overrides.txt} | 0 .../cspi/at-spi-cspi-sections.txt} | 0 docs/reference/cspi/tmpl/spi_accessible.sgml | 340 ++++++++++++++++++ docs/reference/cspi/tmpl/spi_action.sgml | 83 +++++ docs/reference/cspi/tmpl/spi_application.sgml | 79 ++++ docs/reference/cspi/tmpl/spi_component.sgml | 108 ++++++ .../reference/cspi/tmpl/spi_editabletext.sgml | 111 ++++++ docs/reference/cspi/tmpl/spi_event.sgml | 57 +++ docs/reference/cspi/tmpl/spi_hyperlink.sgml | 64 ++++ docs/reference/cspi/tmpl/spi_hypertext.sgml | 63 ++++ docs/reference/cspi/tmpl/spi_image.sgml | 64 ++++ docs/reference/cspi/tmpl/spi_main.sgml | 56 +++ docs/reference/cspi/tmpl/spi_registry.sgml | 186 ++++++++++ docs/reference/cspi/tmpl/spi_relation.sgml | 64 ++++ docs/reference/cspi/tmpl/spi_selection.sgml | 100 ++++++ docs/reference/cspi/tmpl/spi_stateset.sgml | 125 +++++++ docs/reference/cspi/tmpl/spi_table.sgml | 243 +++++++++++++ docs/reference/cspi/tmpl/spi_text.sgml | 218 +++++++++++ docs/reference/cspi/tmpl/spi_value.sgml | 71 ++++ docs/reference/idl/tmpl/accessible.sgml | 16 + docs/reference/idl/tmpl/action.sgml | 16 + docs/reference/idl/tmpl/application.sgml | 16 + docs/reference/idl/tmpl/registry.sgml | 16 + 29 files changed, 2287 insertions(+), 160 deletions(-) create mode 100644 docs/reference/Makefile.am create mode 100644 docs/reference/cspi/Makefile.am rename docs/{at-spi-docs.sgml => reference/cspi/at-spi-cspi-docs.sgml} (100%) rename docs/{at-spi-overrides.txt => reference/cspi/at-spi-cspi-overrides.txt} (100%) rename docs/{at-spi-sections.txt => reference/cspi/at-spi-cspi-sections.txt} (100%) create mode 100644 docs/reference/cspi/tmpl/spi_accessible.sgml create mode 100644 docs/reference/cspi/tmpl/spi_action.sgml create mode 100644 docs/reference/cspi/tmpl/spi_application.sgml create mode 100644 docs/reference/cspi/tmpl/spi_component.sgml create mode 100644 docs/reference/cspi/tmpl/spi_editabletext.sgml create mode 100644 docs/reference/cspi/tmpl/spi_event.sgml create mode 100644 docs/reference/cspi/tmpl/spi_hyperlink.sgml create mode 100644 docs/reference/cspi/tmpl/spi_hypertext.sgml create mode 100644 docs/reference/cspi/tmpl/spi_image.sgml create mode 100644 docs/reference/cspi/tmpl/spi_main.sgml create mode 100644 docs/reference/cspi/tmpl/spi_registry.sgml create mode 100644 docs/reference/cspi/tmpl/spi_relation.sgml create mode 100644 docs/reference/cspi/tmpl/spi_selection.sgml create mode 100644 docs/reference/cspi/tmpl/spi_stateset.sgml create mode 100644 docs/reference/cspi/tmpl/spi_table.sgml create mode 100644 docs/reference/cspi/tmpl/spi_text.sgml create mode 100644 docs/reference/cspi/tmpl/spi_value.sgml create mode 100644 docs/reference/idl/tmpl/accessible.sgml create mode 100644 docs/reference/idl/tmpl/action.sgml create mode 100644 docs/reference/idl/tmpl/application.sgml create mode 100644 docs/reference/idl/tmpl/registry.sgml diff --git a/ChangeLog b/ChangeLog index 31430299..f7a6f581 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,25 @@ +2001-21-11 Bill Haneman + + * configure.in: + * docs/Makefile.am: + * docs/reference: + * docs/reference:Makefile.am: + * docs/reference/cspi: + * docs/reference/cspi:Makefile.am: + * docs/reference/cspi:tmpl: + * docs/reference/cspi:tmpl:*.sgml: + * docs/reference/idl: + * docs/reference/idl:Makefile.am: + * docs/reference/idl:at-spi-idl-sections.txt: + * docs/reference/idl:at-spi-idl-docs.sgml: + * docs/reference/idl:tmpl: + * docs/reference/idl:tmpl:*.sgml: + + Restructured docs directory to allow separate 'reference' docs + section, and forked idl and cspi docs. Added the sgml template + files to CVS. Added the first sections/structural sgml for the + IDL docs. + 2001-11-21 Laszlo Peter * configure.in, libspi/Makefile.am: find libXtst. diff --git a/configure.in b/configure.in index 9a8df15c..70424f7e 100644 --- a/configure.in +++ b/configure.in @@ -148,6 +148,9 @@ Makefile at-spi-1.0.pc po/Makefile.in docs/Makefile +docs/reference/Makefile +docs/reference/idl/Makefile +docs/reference/cspi/Makefile idl/Makefile libspi/Makefile registryd/Makefile diff --git a/docs/Makefile.am b/docs/Makefile.am index 4b474bc2..e539c080 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,162 +1,3 @@ ## Process this file with automake to produce Makefile.in -EXTRA_DIST = Makefile.am at-spi-docs.sgml at-spi-sections.txt - -# Files whose declarations are to be ignored (private) -IGNORE_HFILES = spi-impl.h - -# The name of the module. -DOC_MODULE=at-spi - -# The top-level SGML file. -DOC_MAIN_SGML_FILE=at-spi-docs.sgml - -# The directory containing the source code (if it contains documentation). -DOC_SOURCE_DIR=../cspi ../idl - -INSTALLDIR=$(prefix)/share/gtk-doc - -HTML_DIR = ${datadir}/gtk-doc/html - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -# Images to copy into HTML directory -HTML_IMAGES = - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE) -content_files = - -# Other files to distribute -extra_files = - -#################################### -# Everything below here is generic # -#################################### - -# We set GPATH here; this gives us semantics for GNU make -# which are more like other make's VPATH, when it comes to -# whether a source that is a target of one rule is then -# searched for in VPATH/GPATH. -# -GPATH = $(srcdir) - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE)-sections.txt \ - $(DOC_MODULE)-overrides.txt - -DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp - -SCANOBJ_FILES = \ - $(DOC_MODULE).args \ - $(DOC_MODULE).hierarchy \ - $(DOC_MODULE).signals - -if ENABLE_GTK_DOC -all-local: html-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) - @echo '*** Scanning header files ***' - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ - else \ - cd $(srcdir) ; \ - for i in $(SCANOBJ_FILES) ; do \ - test -f $$i || touch $$i ; \ - done \ - fi - cd $(srcdir) && \ - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) - touch scan-build.stamp - -$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp - @true - -#### templates #### - -tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt - @echo '*** Rebuilding template files ***' - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -#### sgml #### - -sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml - @echo '*** Building SGML ***' - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS) - touch sgml-build.stamp - -sgml.stamp: sgml-build.stamp - @true - -#### html #### - -html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo '*** Building HTML ***' - test -d $(srcdir)/html || mkdir $(srcdir)/html - cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) - test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) - @echo '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -install-data-local: - $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) - (installfiles=`echo $(srcdir)/html/*.html`; \ - if test "$$installfiles" = '$(srcdir)/html/*.html'; \ - then echo '-- Nothing to install' ; \ - else \ - for i in $$installfiles; do \ - echo '-- Installing '$$i ; \ - $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ - done; \ - echo '-- Installing $(srcdir)/html/index.sgml' ; \ - $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ - fi) - -# -# Require gtk-doc when making dist -# -if ENABLE_GTK_DOC -dist-check-gtkdoc: -else -dist-check-gtkdoc: - @echo "*** gtk-doc must be installed and enabled in order to make dist" - @false -endif - -dist-hook: dist-check-gtkdoc dist-hook-local - mkdir $(distdir)/tmpl - mkdir $(distdir)/sgml - mkdir $(distdir)/html - -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml - cp $(srcdir)/html/index.sgml $(distdir)/html - -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html - - images=$(HTML_IMAGES) ; \ - for i in $$images ; do \ - cp $(srcdir)/$$i $(distdir)/html ; \ - done - -.PHONY : html sgml templates scan dist-hook-local +SUBDIRS = reference diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am new file mode 100644 index 00000000..5a2c0934 --- /dev/null +++ b/docs/reference/Makefile.am @@ -0,0 +1,3 @@ +## Process this file with automake to produce Makefile.in + +SUBDIRS = cspi idl diff --git a/docs/reference/cspi/Makefile.am b/docs/reference/cspi/Makefile.am new file mode 100644 index 00000000..2afa1193 --- /dev/null +++ b/docs/reference/cspi/Makefile.am @@ -0,0 +1,162 @@ +## Process this file with automake to produce Makefile.in + +EXTRA_DIST = Makefile.am at-spi-cspi-docs.sgml at-spi-cspi-sections.txt + +# Files whose declarations are to be ignored (private) +IGNORE_HFILES = spi-impl.h + +# The name of the module. +DOC_MODULE=at-spi-cspi + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=at-spi-cspi-docs.sgml + +# The directory containing the source code (if it contains documentation). +DOC_SOURCE_DIR=../../../cspi + +INSTALLDIR=$(prefix)/share/gtk-doc + +HTML_DIR = ${datadir}/gtk-doc/html + +TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) + +# Images to copy into HTML directory +HTML_IMAGES = + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE) +content_files = + +# Other files to distribute +extra_files = + +#################################### +# Everything below here is generic # +#################################### + +# We set GPATH here; this gives us semantics for GNU make +# which are more like other make's VPATH, when it comes to +# whether a source that is a target of one rule is then +# searched for in VPATH/GPATH. +# +GPATH = $(srcdir) + +TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) + +EXTRA_DIST = \ + $(content_files) \ + $(extra_files) \ + $(HTML_IMAGES) \ + $(DOC_MAIN_SGML_FILE) \ + $(DOC_MODULE)-sections.txt \ + $(DOC_MODULE)-overrides.txt + +DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp + +SCANOBJ_FILES = \ + $(DOC_MODULE).args \ + $(DOC_MODULE).hierarchy \ + $(DOC_MODULE).signals + +if ENABLE_GTK_DOC +all-local: html-build.stamp + +#### scan #### + +scan-build.stamp: $(HFILE_GLOB) + @echo '*** Scanning header files ***' + if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ + CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ + else \ + cd $(srcdir) ; \ + for i in $(SCANOBJ_FILES) ; do \ + test -f $$i || touch $$i ; \ + done \ + fi + cd $(srcdir) && \ + gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) + touch scan-build.stamp + +$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp + @true + +#### templates #### + +tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt + @echo '*** Rebuilding template files ***' + cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) + touch tmpl-build.stamp + +tmpl.stamp: tmpl-build.stamp + @true + +#### sgml #### + +sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml + @echo '*** Building SGML ***' + cd $(srcdir) && \ + gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS) + touch sgml-build.stamp + +sgml.stamp: sgml-build.stamp + @true + +#### html #### + +html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo '*** Building HTML ***' + test -d $(srcdir)/html || mkdir $(srcdir)/html + cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) + @echo '-- Fixing Crossreferences' + cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) + touch html-build.stamp +endif + +############## + +clean-local: + rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) + +maintainer-clean-local: clean + cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + +install-data-local: + $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) + (installfiles=`echo $(srcdir)/html/*.html`; \ + if test "$$installfiles" = '$(srcdir)/html/*.html'; \ + then echo '-- Nothing to install' ; \ + else \ + for i in $$installfiles; do \ + echo '-- Installing '$$i ; \ + $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ + done; \ + echo '-- Installing $(srcdir)/html/index.sgml' ; \ + $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ + fi) + +# +# Require gtk-doc when making dist +# +if ENABLE_GTK_DOC +dist-check-gtkdoc: +else +dist-check-gtkdoc: + @echo "*** gtk-doc must be installed and enabled in order to make dist" + @false +endif + +dist-hook: dist-check-gtkdoc dist-hook-local + mkdir $(distdir)/tmpl + mkdir $(distdir)/sgml + mkdir $(distdir)/html + -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl + -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml + cp $(srcdir)/html/index.sgml $(distdir)/html + -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html + + images=$(HTML_IMAGES) ; \ + for i in $$images ; do \ + cp $(srcdir)/$$i $(distdir)/html ; \ + done + +.PHONY : html sgml templates scan dist-hook-local diff --git a/docs/at-spi-docs.sgml b/docs/reference/cspi/at-spi-cspi-docs.sgml similarity index 100% rename from docs/at-spi-docs.sgml rename to docs/reference/cspi/at-spi-cspi-docs.sgml diff --git a/docs/at-spi-overrides.txt b/docs/reference/cspi/at-spi-cspi-overrides.txt similarity index 100% rename from docs/at-spi-overrides.txt rename to docs/reference/cspi/at-spi-cspi-overrides.txt diff --git a/docs/at-spi-sections.txt b/docs/reference/cspi/at-spi-cspi-sections.txt similarity index 100% rename from docs/at-spi-sections.txt rename to docs/reference/cspi/at-spi-cspi-sections.txt diff --git a/docs/reference/cspi/tmpl/spi_accessible.sgml b/docs/reference/cspi/tmpl/spi_accessible.sgml new file mode 100644 index 00000000..6f6e9542 --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_accessible.sgml @@ -0,0 +1,340 @@ + +Accessible Objects + + + + + + + + + + + + + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@childIndex: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@interface_name: +@Returns: + + + + + + + +@SPI_ROLE_INVALID: +@SPI_ROLE_ALERT: +@SPI_ROLE_CANVAS: +@SPI_ROLE_CHECK_BOX: +@SPI_ROLE_COLOR_CHOOSER: +@SPI_ROLE_COLUMN_HEADER: +@SPI_ROLE_COMBO_BOX: +@SPI_ROLE_SPI_DESKTOP_ICON: +@SPI_ROLE_SPI_DESKTOP_FRAME: +@SPI_ROLE_DIALOG: +@SPI_ROLE_DIRECTORY_PANE: +@SPI_ROLE_FILE_CHOOSER: +@SPI_ROLE_FILLER: +@SPI_ROLE_FOCUS_TRAVERSABLE: +@SPI_ROLE_FRAME: +@SPI_ROLE_GLASS_PANE: +@SPI_ROLE_HTML_CONTAINER: +@SPI_ROLE_ICON: +@SPI_ROLE_INTERNAL_FRAME: +@SPI_ROLE_LABEL: +@SPI_ROLE_LAYERED_PANE: +@SPI_ROLE_LIST: +@SPI_ROLE_LIST_ITEM: +@SPI_ROLE_MENU: +@SPI_ROLE_MENU_BAR: +@SPI_ROLE_MENU_ITEM: +@SPI_ROLE_OPTION_PANE: +@SPI_ROLE_PAGE_TAB: +@SPI_ROLE_PAGE_TAB_LIST: +@SPI_ROLE_PANEL: +@SPI_ROLE_PASSWORD_TEXT: +@SPI_ROLE_POPUP_MENU: +@SPI_ROLE_PROGRESS_BAR: +@SPI_ROLE_PUSH_BUTTON: +@SPI_ROLE_RADIO_BUTTON: +@SPI_ROLE_ROOT_PANE: +@SPI_ROLE_ROW_HEADER: +@SPI_ROLE_SCROLL_BAR: +@SPI_ROLE_SCROLL_PANE: +@SPI_ROLE_SEPARATOR: +@SPI_ROLE_SLIDER: +@SPI_ROLE_SPLIT_PANE: +@SPI_ROLE_TABLE: +@SPI_ROLE_TABLE_CELL: +@SPI_ROLE_TABLE_COLUMN_HEADER: +@SPI_ROLE_TABLE_ROW_HEADER: +@SPI_ROLE_TEXT: +@SPI_ROLE_TOGGLE_BUTTON: +@SPI_ROLE_TOOL_BAR: +@SPI_ROLE_TOOL_TIP: +@SPI_ROLE_TREE: +@SPI_ROLE_UNKNOWN: +@SPI_ROLE_VIEWPORT: +@SPI_ROLE_WINDOW: +@SPI_ROLE_LAST_DEFINED: + + + + + + +@role: +@Returns: + + diff --git a/docs/reference/cspi/tmpl/spi_action.sgml b/docs/reference/cspi/tmpl/spi_action.sgml new file mode 100644 index 00000000..d07a721d --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_action.sgml @@ -0,0 +1,83 @@ + +AccessibleAction Interface + + + + + + + + + + + + + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@i: +@Returns: + + + + + + + +@obj: +@i: +@Returns: + + + + + + + +@obj: +@i: +@Returns: + + + + + + + +@obj: +@i: +@Returns: + + diff --git a/docs/reference/cspi/tmpl/spi_application.sgml b/docs/reference/cspi/tmpl/spi_application.sgml new file mode 100644 index 00000000..fa6e50ed --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_application.sgml @@ -0,0 +1,79 @@ + +AccessibleApplication API + + + + + + + + + + + + + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + diff --git a/docs/reference/cspi/tmpl/spi_component.sgml b/docs/reference/cspi/tmpl/spi_component.sgml new file mode 100644 index 00000000..08cd3bc2 --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_component.sgml @@ -0,0 +1,108 @@ + +AccessibleComponent Interface + + + + + + + + + + + + + + + + + + + +@SPI_COORD_TYPE_SCREEN: +@SPI_COORD_TYPE_WINDOW: + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@x: +@y: +@ctype: +@Returns: + + + + + + + +@obj: +@x: +@y: +@ctype: +@Returns: + + + + + + + +@obj: +@x: +@y: +@width: +@height: +@ctype: + + + + + + + +@obj: +@x: +@y: +@ctype: + + + + + + + +@obj: +@width: +@height: + + + + + + + +@obj: + + diff --git a/docs/reference/cspi/tmpl/spi_editabletext.sgml b/docs/reference/cspi/tmpl/spi_editabletext.sgml new file mode 100644 index 00000000..3628b95f --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_editabletext.sgml @@ -0,0 +1,111 @@ + +AccessibleEditableText Interface + + + + + + + + + + + + + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@startPos: +@endPos: +@Returns: + + + + + + + +@obj: +@startPos: +@endPos: +@Returns: + + + + + + + +@obj: +@position: +@text: +@length: +@Returns: + + + + + + + +@obj: +@startPos: +@endPos: +@Returns: + + + + + + + +@obj: +@position: +@Returns: + + + + + + + +@obj: +@newContents: +@Returns: + + + + + + + +@obj: +@attributes: +@startOffset: +@endOffset: +@Returns: + + diff --git a/docs/reference/cspi/tmpl/spi_event.sgml b/docs/reference/cspi/tmpl/spi_event.sgml new file mode 100644 index 00000000..79ddbcc9 --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_event.sgml @@ -0,0 +1,57 @@ + +Event Listener Support + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@callback: +@Returns: + + + + + + + +@listener: +@callback: +@Returns: + + + + + + + +@listener: +@callback: +@Returns: + + diff --git a/docs/reference/cspi/tmpl/spi_hyperlink.sgml b/docs/reference/cspi/tmpl/spi_hyperlink.sgml new file mode 100644 index 00000000..bb2ef9f7 --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_hyperlink.sgml @@ -0,0 +1,64 @@ + +AccessibleHyperlink Interface + + + + + + + + + + + + + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@startIndex: +@endIndex: + + + + + + + +@obj: +@i: +@Returns: + + + + + + + +@obj: +@i: +@Returns: + + + + + + + +@obj: +@Returns: + + diff --git a/docs/reference/cspi/tmpl/spi_hypertext.sgml b/docs/reference/cspi/tmpl/spi_hypertext.sgml new file mode 100644 index 00000000..29ca2281 --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_hypertext.sgml @@ -0,0 +1,63 @@ + +AccessibleHypertext Interface + + + + + + + + + + + + + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@linkIndex: +@Returns: + + + + + + + +@obj: +@characterOffset: +@Returns: + + diff --git a/docs/reference/cspi/tmpl/spi_image.sgml b/docs/reference/cspi/tmpl/spi_image.sgml new file mode 100644 index 00000000..80b72a3a --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_image.sgml @@ -0,0 +1,64 @@ + +AccessibleImage Interface + + + + + + + + + + + + + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@width: +@height: + + + + + + + +@obj: +@x: +@y: +@ctype: + + diff --git a/docs/reference/cspi/tmpl/spi_main.sgml b/docs/reference/cspi/tmpl/spi_main.sgml new file mode 100644 index 00000000..e51c49c0 --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_main.sgml @@ -0,0 +1,56 @@ + +SPI main loop and initialization + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@isGNOMEApp: + + + + + + + +@Returns: + + + + + + + +@waitForEvent: +@Returns: + + + + + + + + + diff --git a/docs/reference/cspi/tmpl/spi_registry.sgml b/docs/reference/cspi/tmpl/spi_registry.sgml new file mode 100644 index 00000000..27ea2213 --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_registry.sgml @@ -0,0 +1,186 @@ + +Registry queries + + + + + + + + + + + + + + + + + + + +@SPI_KEY_PRESS: +@SPI_KEY_RELEASE: +@SPI_KEY_PRESSRELEASE: +@SPI_KEY_SYM: + + + + + + +@Returns: + + + + + + + +@i: +@Returns: + + + + + + + +@list: +@Returns: + + + + + + + + + + + + + + + + + + + + + + + + + +@SPI_KEY_PRESSED: +@SPI_KEY_RELEASED: + + + + + + +@SPI_KEYLISTENER_NOSYNC: +@SPI_KEYLISTENER_SYNCHRONOUS: +@SPI_KEYLISTENER_CANCONSUME: +@SPI_KEYLISTENER_ALL_WINDOWS: + + + + + + +@callback: +@Returns: + + + + + + + +@listener: +@eventType: +@Returns: + + + + + + + +@listener: +@eventType: +@Returns: + + + + + + + +@listener: +@Returns: + + + + + + + +@listener: +@keys: +@modmask: +@eventmask: +@sync_type: + + + + + + + +@listener: +@modmask: + + + + + + + +@listener: +@callback: +@Returns: + + + + + + + +@listener: +@callback: +@Returns: + + + + + + + +@keyval: +@synth_type: + + + + + + + +@x: +@y: +@name: + + diff --git a/docs/reference/cspi/tmpl/spi_relation.sgml b/docs/reference/cspi/tmpl/spi_relation.sgml new file mode 100644 index 00000000..7cee90b0 --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_relation.sgml @@ -0,0 +1,64 @@ + +AccessibleRelations and RelationSets + + + + + + + + + + + + + + + + + + + +@SPI_RELATION_LABEL_FOR: +@SPI_RELATION_LABELED_BY: +@SPI_RELATION_CONTROLLER_FOR: +@SPI_RELATION_CONTROLLED_BY: +@SPI_RELATION_MEMBER_OF: + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@i: +@Returns: + + + + + + + +@obj: +@Returns: + + diff --git a/docs/reference/cspi/tmpl/spi_selection.sgml b/docs/reference/cspi/tmpl/spi_selection.sgml new file mode 100644 index 00000000..ea007849 --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_selection.sgml @@ -0,0 +1,100 @@ + +AccessibleSelection Interface + + + + + + + + + + + + + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@selectedChildIndex: +@Returns: + + + + + + + +@obj: +@childIndex: +@Returns: + + + + + + + +@obj: +@childIndex: +@Returns: + + + + + + + +@obj: +@selectedChildIndex: +@Returns: + + + + + + + +@obj: + + + + + + + +@obj: +@Returns: + + diff --git a/docs/reference/cspi/tmpl/spi_stateset.sgml b/docs/reference/cspi/tmpl/spi_stateset.sgml new file mode 100644 index 00000000..6558f533 --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_stateset.sgml @@ -0,0 +1,125 @@ + +State and StateSets + + + + + + + + + + + + + + + + + + + +@SPI_STATE_INVALID: +@SPI_STATE_ACTIVE: +@SPI_STATE_ARMED: +@SPI_STATE_BUSY: +@SPI_STATE_CHECKED: +@SPI_STATE_COLLAPSED: +@SPI_STATE_EDITABLE: +@SPI_STATE_EXPANDABLE: +@SPI_STATE_EXPANDED: +@SPI_STATE_FOCUSABLE: +@SPI_STATE_FOCUSED: +@SPI_STATE_HORIZONTAL: +@SPI_STATE_ICONIFIED: +@SPI_STATE_MODAL: +@SPI_STATE_MULTI_LINE: +@SPI_STATE_MULTISELECSPI_TABLE: +@SPI_STATE_OPAQUE: +@SPI_STATE_PRESSED: +@SPI_STATE_RESIZABLE: +@SPI_STATE_SELECSPI_TABLE: +@SPI_STATE_SELECTED: +@SPI_STATE_SENSITIVE: +@SPI_STATE_SHOWING: +@SPI_STATE_SINGLE_LINE: +@SPI_STATE_TRANSIENT: +@SPI_STATE_VERTICAL: +@SPI_STATE_VISIBLE: +@SPI_STATE_LAST_DEFINED: + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@state: + + + + + + + +@obj: +@obj2: +@differenceSet: + + + + + + + +@obj: +@state: +@Returns: + + + + + + + +@obj: +@obj2: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@state: + + diff --git a/docs/reference/cspi/tmpl/spi_table.sgml b/docs/reference/cspi/tmpl/spi_table.sgml new file mode 100644 index 00000000..5b41e554 --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_table.sgml @@ -0,0 +1,243 @@ + +AccessibleTable Interface + + + + + + + + + + + + + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@row: +@column: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@index: +@Returns: + + + + + + + +@obj: +@column: +@Returns: + + + + + + + +@obj: +@row: +@column: +@Returns: + + + + + + + +@obj: +@column: +@Returns: + + + + + + + +@obj: +@row: +@column: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@index: +@Returns: + + + + + + + +@obj: +@row: +@Returns: + + + + + + + +@obj: +@row: +@column: +@Returns: + + + + + + + +@obj: +@row: +@Returns: + + + + + + + +@obj: +@selectedRows: +@Returns: + + + + + + + +@obj: +@selectedColumns: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@column: +@Returns: + + + + + + + +@obj: +@row: +@Returns: + + + + + + + +@obj: +@row: +@column: +@Returns: + + diff --git a/docs/reference/cspi/tmpl/spi_text.sgml b/docs/reference/cspi/tmpl/spi_text.sgml new file mode 100644 index 00000000..7f4bee0d --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_text.sgml @@ -0,0 +1,218 @@ + +AccessibleText Interface + + + + + + + + + + + + + + + + + + + +@SPI_TEXT_BOUNDARY_CHAR: +@SPI_TEXT_BOUNDARY_CURSOR_POS: +@SPI_TEXT_BOUNDARY_WORD_START: +@SPI_TEXT_BOUNDARY_WORD_END: +@SPI_TEXT_BOUNDARY_SENTENCE_START: +@SPI_TEXT_BOUNDARY_SENTENCE_END: +@SPI_TEXT_BOUNDARY_LINE_START: +@SPI_TEXT_BOUNDARY_LINE_END: +@SPI_TEXT_BOUNDARY_ATTRIBUTE_RANGE: + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@startOffset: +@endOffset: +@Returns: + + + + + + + +@obj: +@offset: +@startOffset: +@endOffset: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@offset: +@x: +@y: +@width: +@height: +@type: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@x: +@y: +@type: +@Returns: + + + + + + + +@obj: +@selectionNum: +@startOffset: +@endOffset: + + + + + + + +@obj: +@startOffset: +@endOffset: +@Returns: + + + + + + + +@obj: +@offset: +@type: +@startOffset: +@endOffset: +@Returns: + + + + + + + +@obj: +@offset: +@type: +@startOffset: +@endOffset: +@Returns: + + + + + + + +@obj: +@offset: +@type: +@startOffset: +@endOffset: +@Returns: + + + + + + + +@obj: +@selectionNum: +@Returns: + + + + + + + +@obj: +@newOffset: +@Returns: + + + + + + + +@obj: +@selectionNum: +@startOffset: +@endOffset: +@Returns: + + diff --git a/docs/reference/cspi/tmpl/spi_value.sgml b/docs/reference/cspi/tmpl/spi_value.sgml new file mode 100644 index 00000000..4c786e5b --- /dev/null +++ b/docs/reference/cspi/tmpl/spi_value.sgml @@ -0,0 +1,71 @@ + +AccessibleValue Interface + + + + + + + + + + + + + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@Returns: + + + + + + + +@obj: +@newValue: +@Returns: + + diff --git a/docs/reference/idl/tmpl/accessible.sgml b/docs/reference/idl/tmpl/accessible.sgml new file mode 100644 index 00000000..ec183770 --- /dev/null +++ b/docs/reference/idl/tmpl/accessible.sgml @@ -0,0 +1,16 @@ + +Basic Accessibility Interface, Accessible + + + + + + + + + + + + + + diff --git a/docs/reference/idl/tmpl/action.sgml b/docs/reference/idl/tmpl/action.sgml new file mode 100644 index 00000000..2f1cddf8 --- /dev/null +++ b/docs/reference/idl/tmpl/action.sgml @@ -0,0 +1,16 @@ + +Action Interface + + + + + + + + + + + + + + diff --git a/docs/reference/idl/tmpl/application.sgml b/docs/reference/idl/tmpl/application.sgml new file mode 100644 index 00000000..bb6f2415 --- /dev/null +++ b/docs/reference/idl/tmpl/application.sgml @@ -0,0 +1,16 @@ + +Applications and Desktops + + + + + + + + + + + + + + diff --git a/docs/reference/idl/tmpl/registry.sgml b/docs/reference/idl/tmpl/registry.sgml new file mode 100644 index 00000000..36357534 --- /dev/null +++ b/docs/reference/idl/tmpl/registry.sgml @@ -0,0 +1,16 @@ + +The Accessibility Registry + + + + + + + + + + + + + + -- 2.34.1