13760N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
13760N/A<!--ArborText, Inc., 1988-1999, v.4002-->
13760N/A<!--ARC : LSARC 2006/202 GNOME 2.14-Vermillion-->
13802N/A<!ENTITY cmd "libloginhelper">
13760N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
13760N/A%commonents;
13760N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
13760N/A%booktitles;
13805N/A<!ENTITY suncopy "Copyright (c) 2008 Sun Microsystems, Inc. All Rights Reserved.">
13760N/A]>
13760N/A<refentry id="libloginhelper-3">
13760N/A<!-- %Z%%M% %I% %E% SMI; -->
13805N/A<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>3</manvolnum>
13805N/A<refmiscinfo class="date">7 Aug 2008</refmiscinfo>
13760N/A<refmiscinfo class="sectdesc">&man3;</refmiscinfo>
13760N/A<refmiscinfo class="software">&release;</refmiscinfo>
13760N/A<refmiscinfo class="arch">generic</refmiscinfo>
13760N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
13760N/A</refmeta>
17593N/A<indexterm><primary>&cmd;</primary></indexterm>
17593N/A<indexterm><primary>Accessibility Toolkit API</primary></indexterm>
17593N/A<refnamediv id="libloginhelper-3-name"><refname>&cmd;</refname>
17593N/A<refpurpose>Login-Helper library for assistive technologies</refpurpose>
17593N/A</refnamediv>
13760N/A
13760N/A<refsect1 id="libloginhelper-3-desc"><title>DESCRIPTION</title>
13760N/A
17593N/A<para>
17593N/AAn interface for use by assistive technologies by which they can access system
17593N/Ainformation and services on a 'need to know' basis while the screen is locked,
17593N/Aduring user authentication, or during other sensitive operations.
17593N/A</para>
17593N/A
17593N/A<para>
17593N/AThis interface is intended for use by assistive technologies and related
17593N/Auser-enabling services, and by applications and utilities which may wish to
17593N/Arestrict access to certain system devices and services during
17593N/Asecurity-sensitive states, e.g. when the screen is locked or during
17593N/Aauthentication into some secure service.
13802N/A</para>
13802N/A
17593N/A<para>
17593N/ASuch 'applications' (for instance, screen lock dialogs and security-enabled web
17593N/Abrowsers) use the LoginHelper client interfaces, and the bonobo-activation
17593N/Aquery service, to query for assistive technologies which advertise the
17593N/ALoginHelper service. The client then queries these assistive technologies for
17593N/Atheir device I/O requirements, via the getDeviceReqs call. The client may then
17593N/Aissue the advisory request setSafe (TRUE), which requests that the
17593N/ALoginHelper-implementing service make a best-effort attempt to make itself more
17593N/Asecure (for instance, an onscreen keyboard might turn off word prediction, and
17593N/Aa screenreader may turn off keyboard echo via speech). The return value of
17593N/AsetSafe is an advisory indication of whether this attempt was successful (no
17593N/Aspecific guarantees are implied). Once the 'security sensitive' state is
17593N/Aexited, the client should call setSafe (FALSE).
13802N/A</para>
13802N/A
17593N/A<para>
17593N/AThe return values from getDeviceReqs inform the client of which services the
17593N/ALoginHelper service (e. g. assistive technology) needs in order to do its job.
17593N/AThe client may use this information to loosen any restrictions on access which
17593N/Ait may currently have in place (for instance, keyboard grabs, etc.). If it does
17593N/Anot do so, the likely outcome is that the end-user will experience loss of
17593N/Aaccess to the system.
13802N/A</para>
13802N/A
13802N/A<para>
13802N/AAdditional information is also available from the following site:
13802N/A</para>
13802N/A
17593N/A<para>
17593N/A<literal>http://www.gnome.org/~billh/at-spi-idl/html/classAccessibility_1_1LoginHelper.html</literal>
17593N/A</para>
13760N/A</refsect1>
13760N/A
13760N/A<refsect1 id="libloginhelper-3-file"><title>FILES</title>
17593N/A<para>
17593N/AThe following files are used by this library:
17593N/A</para>
17593N/A<variablelist termlength="wholeline">
17593N/A<varlistentry>
17593N/A<term><filename>/usr/lib/&cmd;.so</filename></term>
17593N/A<listitem><para>
17593N/ALogin-Helper library for assistive technologies
17593N/A</para></listitem></varlistentry>
13760N/A</variablelist></refsect1>
13760N/A
13760N/A<refsect1 id="libloginhelper-3-attr"><title>ATTRIBUTES</title>
17593N/A<para>
17593N/ASee
17593N/A<olink targetdocent="REFMAN5" localinfo="attributes-5">
17593N/A<citerefentry><refentrytitle>attributes</refentrytitle>
17593N/A<manvolnum>5</manvolnum></citerefentry></olink>
17593N/Afor descriptions of the following attributes:
17593N/A</para>
13760N/A<informaltable frame="all">
17593N/A<tgroup cols="2" colsep="1" rowsep="1">
17593N/A<colspec colname="COLSPEC0" colwidth="1*">
13760N/A<colspec colname="COLSPEC1" colwidth="1*">
13760N/A<thead>
13760N/A<row>
13760N/A<entry align="center" valign="middle">ATTRIBUTE TYPE</entry>
13760N/A<entry align="center" valign="middle">ATTRIBUTE VALUE</entry></row>
13760N/A</thead>
13760N/A<tbody>
17593N/A<row>
17593N/A<entry><para>Availability</para></entry>
18745N/A<entry><para>gnome/accessibility/gnome-a11y-libs</para></entry></row>
17593N/A<row>
17593N/A<entry colname="COLSPEC0"><para>Interface stability</para></entry>
17593N/A<entry colname="COLSPEC1"><para>Volatile</para></entry></row>
13760N/A</tbody>
13760N/A</tgroup>
13760N/A</informaltable>
13760N/A</refsect1>
13760N/A
13760N/A<refsect1 id="libloginhelper-3-also"><title>SEE ALSO</title>
13760N/A<!--Reference to another man page-->
13760N/A<!--Reference to a Help manual-->
13760N/A<!--Reference to a book.-->
13760N/A<para>
13802N/A<citerefentry><refentrytitle>libatk-1.0</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
13802N/A<citerefentry><refentrytitle>libcspi</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
13802N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
13802N/A<citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>
13760N/A</para>
13760N/A</refsect1>
13760N/A
13760N/A<refsect1 id="libloginhelper-3-note"><title>NOTES</title>
17593N/A<para>
17593N/Alogin-helper module is in at-spi package.
13760N/A</para>
13760N/A</refsect1>
13760N/A</refentry>