libcspi.3 revision 13741
10139N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
10139N/A<!--ArborText, Inc., 1988-1999, v.4002-->
13634N/A<!--ARC : LSARC 2001/650 GNOME Accessibility-->
10139N/A<!ENTITY cmd "libcspi">
10139N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
10139N/A%commonents;
10139N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
10139N/A%booktitles;
10139N/A<!ENTITY suncopy "Copyright (c) 2003,2004,2006 Sun Microsystems, Inc. All Rights Reserved.">
10139N/A]>
10139N/A<?Pub UDT _bookmark _target>
10139N/A<?Pub Inc>
10139N/A<refentry id="libcspi-3">
10139N/A<!-- %Z%%M% %I% %E% SMI; -->
13741N/A<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>3</manvolnum>
10139N/A<refmiscinfo class="date">31 Aug 2004</refmiscinfo>
10139N/A<refmiscinfo class="sectdesc">&man3;</refmiscinfo>
10139N/A<refmiscinfo class="software">&release;</refmiscinfo>
10139N/A<refmiscinfo class="arch">generic</refmiscinfo>
10139N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
10139N/A</refmeta>
13741N/A<indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>AT-SPI
10139N/AC Bindings</primary></indexterm><indexterm><primary>at-spi</primary></indexterm>
10139N/A<indexterm><primary>Assistive Technology Service Provider Interface</primary>
10139N/A</indexterm>
13741N/A<refnamediv id="libcspi-3-name"><refname>at-spi</refname>
13741N/A<refname>&cmd;</refname>
13741N/A<refname>libspi</refname>
13741N/A<refpurpose>Assistive Technology Service Provider Interface, and AT-SPI C
13741N/ABindings</refpurpose></refnamediv>
10139N/A<refsect1 id="libcspi-3-desc"><title>&desc-tt;</title>
10139N/A<para><filename>at-spi</filename> is the Assistive Technology Service Provider
10139N/AInterface, which provides a set of client-side APIs for use by assistive technologies.
10139N/AAssistive Technologies are augmentative or adaptive technologies that make
10139N/Athe desktop user interface accessible to persons with disabilities.</para>
10139N/A<para>These APIs for assistive technology developers are available in two
10139N/Aforms.</para>
10139N/A<para><filename>at-spi</filename> is defined by CORBA IDL in the following
10139N/Afiles:</para>
11153N/A
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Accessible.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Action.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Application.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Collection.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Component.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Desktop.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Document.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_EditableText.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Event.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Hyperlink.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Hypertext.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Image.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_LoginHelper.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Registry.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Relation.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Role.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Selection.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_State.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_StreamableContent.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Table.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Text.idl</filename></para>
11153N/A<para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Value.idl</filename></para>
11153N/A
10139N/A<para>An AT-SPI client can use any programming language for which general
10139N/ACORBA language bindings are available (for example, Java, C, C++) and may
10139N/Ause any CORBA 2.2-compliant ORB. The client bindings are generated from the
10139N/Aabove IDL by a language-specific IDL compiler which is usually bundled with
10139N/AORBs. The GNOME 2 environment includes an efficient ORB with C bindings (ORBit2).
10139N/A</para>
10139N/A<para><filename>&cmd;</filename> AT-SPI clients may also use the C language
10139N/Abindings that are defined in <filename>&cmd;</filename> and documented in
10139N/Athe developer documentation.</para>
10139N/A<para>To access the developer documentation, you must install the developer
10139N/Aversion of the package.</para>
10139N/A<para>Such clients may also link to <filename>&cmd;</filename>, which provides
10139N/ACORBA server-side implementations of the Accessibility::EventLister interfaces
10139N/Awhich are used for AT-SPI event notification support.</para>
11221N/A<para>Python bindings are also provided in pyatspi. It Wraps the Gnome Assistive
11221N/ATechnology Service Provider Interface for use in Python.</para>
10139N/A</refsect1>
10139N/A<refsect1 id="libcspi-3-file"><title>&file-tt;</title>
10139N/A<para>The following files are used by this application:</para>
10139N/A<variablelist termlength="wholeline">
10139N/A<varlistentry><term><filename>/usr/lib/libspi.so</filename> </term><listitem>
10139N/A<para>AT-SPI shared library</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/lib/&cmd;.so</filename> </term><listitem>
10139N/A<para>AT-SPI C Binding shared library</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/share/gtk-doc/html/at-spi-cspi</filename> </term><listitem>
10139N/A<para>Location of developer documentation</para>
11904N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="libcspi-3-attr"><title>&attr-tt;</title>
10139N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
10139N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
10139N/Afor descriptions of the following attributes:</para>
10139N/A<informaltable frame="all">
10139N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
10139N/A<colspec colname="COLSPEC1" colwidth="1*">
10139N/A<thead>
10139N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
10139N/Avalign="middle">ATTRIBUTE VALUE</entry></row>
10139N/A</thead>
10139N/A<tbody>
10139N/A<row><entry><para>Availability</para></entry><entry><para>SUNWgnome-a11y-libs
10139N/A</para></entry></row>
10139N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
10139N/Acolname="COLSPEC1"><para>Committed</para></entry></row>
11146N/A<row><entry colname="COLSPEC0"><para>/usr/include/at-spi-1.0/libspi/Accessibility.h</para></entry><entry
10139N/Acolname="COLSPEC1"><para>Volatile</para></entry></row>
11221N/A<row><entry colname="COLSPEC0"><para>/usr/lib/python2.4/site-packages/pyatspi/*</para></entry><entry
11221N/Acolname="COLSPEC1"><para>Volatile</para></entry></row>
10139N/A</tbody>
10139N/A</tgroup>
10139N/A</informaltable>
10139N/A</refsect1>
10139N/A<refsect1 id="libcspi-3-also"><title>&also-tt;</title>
10139N/A<!--Reference to another man page-->
10139N/A<!--Reference to a Help manual-->
10139N/A<!--Reference to a book.-->
11904N/A<para>
11904N/A<citerefentry><refentrytitle>libatk-1.0</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
11904N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
11904N/A<citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>
11904N/A</para>
10139N/A</refsect1>
10139N/A<refsect1 id="libcspi-3-note"><title>&note-tt;</title>
10139N/A<para>Written by Brian Cameron, Sun Microsystems Inc., 2003, 2004, 2006.</para>
10139N/A</refsect1>
10139N/A</refentry>