Home | History | Annotate | Download | only in man3
      1 <!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
      2 <!--ArborText, Inc., 1988-1999, v.4002-->
      3 <!--ARC : LSARC 2001/650 GNOME Accessibility-->
      4 <!ENTITY cmd "libcspi">
      5 <!ENTITY % commonents SYSTEM "smancommon.ent">
      6 %commonents;
      7 <!ENTITY % booktitles SYSTEM "booktitles.ent">
      8 %booktitles;
      9 <!ENTITY suncopy "Copyright (c) 2003,2004,2006 Sun Microsystems, Inc. All Rights Reserved.">
     10 ]>
     11 <?Pub UDT _bookmark _target>
     12 <?Pub Inc>
     13 <refentry id="libcspi-3">
     14 <!-- %Z%%M% %I% %E% SMI; -->
     15 <refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>3</manvolnum>
     16 <refmiscinfo class="date">31 Aug 2004</refmiscinfo>
     17 <refmiscinfo class="sectdesc">&man3;</refmiscinfo>
     18 <refmiscinfo class="software">&release;</refmiscinfo>
     19 <refmiscinfo class="arch">generic</refmiscinfo>
     20 <refmiscinfo class="copyright">&suncopy;</refmiscinfo>
     21 </refmeta>
     22 <indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>AT-SPI
     23 C Bindings</primary></indexterm><indexterm><primary>at-spi</primary></indexterm>
     24 <indexterm><primary>Assistive Technology Service Provider Interface</primary>
     25 </indexterm>
     26 <refnamediv id="libcspi-3-name"><refname>at-spi</refname>
     27 <refname>&cmd;</refname>
     28 <refname>libspi</refname>
     29 <refpurpose>Assistive Technology Service Provider Interface, and AT-SPI C
     30 Bindings</refpurpose></refnamediv>
     31 <refsect1 id="libcspi-3-desc"><title>&desc-tt;</title>
     32 <para><filename>at-spi</filename> is the Assistive Technology Service Provider
     33 Interface, which provides a set of client-side APIs for use by assistive technologies.
     34 Assistive Technologies are augmentative or adaptive technologies that make
     35 the desktop user interface accessible to persons with disabilities.</para>
     36 <para>These APIs for assistive technology developers are available in two
     37 forms.</para>
     38 <para><filename>at-spi</filename> is defined by CORBA IDL in the following
     39 files:</para>
     40 
     41 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility.idl</filename></para>
     42 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Accessible.idl</filename></para>
     43 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Action.idl</filename></para>
     44 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Application.idl</filename></para>
     45 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Collection.idl</filename></para>
     46 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Component.idl</filename></para>
     47 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Desktop.idl</filename></para>
     48 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Document.idl</filename></para>
     49 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_EditableText.idl</filename></para>
     50 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Event.idl</filename></para>
     51 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Hyperlink.idl</filename></para>
     52 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Hypertext.idl</filename></para>
     53 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Image.idl</filename></para>
     54 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_LoginHelper.idl</filename></para>
     55 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Registry.idl</filename></para>
     56 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Relation.idl</filename></para>
     57 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Role.idl</filename></para>
     58 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Selection.idl</filename></para>
     59 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_State.idl</filename></para>
     60 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_StreamableContent.idl</filename></para>
     61 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Table.idl</filename></para>
     62 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Text.idl</filename></para>
     63 <para><filename>/usr/share/idl/at-spi-1.0/Accessibility_Value.idl</filename></para>
     64 
     65 <para>An AT-SPI client can use any programming language for which general
     66 CORBA language bindings are available (for example, Java, C, C++) and may
     67 use any CORBA 2.2-compliant ORB. The client bindings are generated from the
     68 above IDL by a language-specific IDL compiler which is usually bundled with
     69 ORBs. The GNOME 2 environment includes an efficient ORB with C bindings (ORBit2). 
     70 </para>
     71 <para><filename>&cmd;</filename> AT-SPI clients may also use the C language
     72 bindings that are defined in <filename>&cmd;</filename> and documented in
     73 the developer documentation.</para>
     74 <para>To access the developer documentation, you must install the developer
     75 version of the package.</para>
     76 <para>Such clients may also link to <filename>&cmd;</filename>, which provides
     77 CORBA server-side implementations of the Accessibility::EventLister interfaces
     78 which are used for AT-SPI event notification support.</para>
     79 <para>Python bindings are also provided in pyatspi. It Wraps the Gnome Assistive 
     80 Technology Service Provider Interface for use in Python.</para>
     81 </refsect1>
     82 <refsect1 id="libcspi-3-file"><title>&file-tt;</title>
     83 <para>The following files are used by this application:</para>
     84 <variablelist termlength="wholeline">
     85 <varlistentry><term><filename>/usr/lib/libspi.so</filename> </term><listitem>
     86 <para>AT-SPI shared library</para>
     87 </listitem></varlistentry>
     88 <varlistentry><term><filename>/usr/lib/&cmd;.so</filename> </term><listitem>
     89 <para>AT-SPI C Binding shared library</para>
     90 </listitem></varlistentry>
     91 <varlistentry><term><filename>/usr/share/gtk-doc/html/at-spi-cspi</filename> </term><listitem>
     92 <para>Location of developer documentation</para>
     93 </listitem></varlistentry>
     94 </variablelist></refsect1>
     95 <refsect1 id="libcspi-3-attr"><title>&attr-tt;</title>
     96 <para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
     97 <refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
     98 for descriptions of the following attributes:</para>
     99 <informaltable frame="all">
    100 <tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
    101 <colspec colname="COLSPEC1" colwidth="1*">
    102 <thead>
    103 <row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
    104 valign="middle">ATTRIBUTE VALUE</entry></row>
    105 </thead>
    106 <tbody>
    107 <row><entry><para>Availability</para></entry><entry><para>SUNWgnome-a11y-libs
    108 </para></entry></row>
    109 <row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
    110 colname="COLSPEC1"><para>Committed</para></entry></row>
    111 <row><entry colname="COLSPEC0"><para>/usr/include/at-spi-1.0/libspi/Accessibility.h</para></entry><entry
    112 colname="COLSPEC1"><para>Volatile</para></entry></row>
    113 <row><entry colname="COLSPEC0"><para>/usr/lib/python2.4/site-packages/pyatspi/*</para></entry><entry
    114 colname="COLSPEC1"><para>Volatile</para></entry></row>
    115 </tbody>
    116 </tgroup>
    117 </informaltable>
    118 </refsect1>
    119 <refsect1 id="libcspi-3-also"><title>&also-tt;</title>
    120 <!--Reference to another man page-->
    121 <!--Reference to a Help manual-->
    122 <!--Reference to a book.-->
    123 <para>
    124 <citerefentry><refentrytitle>at-spi-registryd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
    125 <citerefentry><refentrytitle>magnifier</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
    126 <citerefentry><refentrytitle>libatk-1.0</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
    127 <citerefentry><refentrytitle>libgnome-mag</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
    128 <citerefentry><refentrytitle>libgnomespeech</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
    129 <citerefentry><refentrytitle>libloginhelper</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
    130 <citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
    131 <citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>
    132 </para>
    133 </refsect1>
    134 <refsect1 id="libcspi-3-note"><title>&note-tt;</title>
    135 <para>Written by Brian Cameron, Sun Microsystems Inc., 2003, 2004, 2006.</para>
    136 </refsect1>
    137 </refentry>
    138