<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!--ARC : LSARC 2006/202  GNOME 2.14-Vermillion-->
<!ENTITY cmd "libloginhelper">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY suncopy "Copyright (c) 2008 Sun Microsystems, Inc. All Rights Reserved.">
]>
<refentry id="libloginhelper-3">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>3</manvolnum>
<refmiscinfo class="date">7 Aug 2008</refmiscinfo>
<refmiscinfo class="sectdesc">&man3;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<indexterm><primary>&cmd;</primary></indexterm>
<indexterm><primary>Accessibility Toolkit API</primary></indexterm>
<refnamediv id="libloginhelper-3-name"><refname>&cmd;</refname>
<refpurpose>Login-Helper library for assistive technologies</refpurpose>
</refnamediv>

<refsect1 id="libloginhelper-3-desc"><title>DESCRIPTION</title>

<para>
An interface for use by assistive technologies by which they can access system
information and services on a 'need to know' basis while the screen is locked,
during user authentication, or during other sensitive operations.
</para>

<para>
This interface is intended for use by assistive technologies and related
user-enabling services, and by applications and utilities which may wish to
restrict access to certain system devices and services during
security-sensitive states, e.g. when the screen is locked or during
authentication into some secure service.
</para>

<para>
Such 'applications' (for instance, screen lock dialogs and security-enabled web
browsers) use the LoginHelper client interfaces, and the bonobo-activation
query service, to query for assistive technologies which advertise the
LoginHelper service. The client then queries these assistive technologies for
their device I/O requirements, via the getDeviceReqs call. The client may then
issue the advisory request setSafe (TRUE), which requests that the
LoginHelper-implementing service make a best-effort attempt to make itself more
secure (for instance, an onscreen keyboard might turn off word prediction, and
a screenreader may turn off keyboard echo via speech). The return value of
setSafe is an advisory indication of whether this attempt was successful (no
specific guarantees are implied). Once the 'security sensitive' state is
exited, the client should call setSafe (FALSE).
</para>

<para>
The return values from getDeviceReqs inform the client of which services the
LoginHelper service (e. g. assistive technology) needs in order to do its job.
The client may use this information to loosen any restrictions on access which
it may currently have in place (for instance, keyboard grabs, etc.). If it does
not do so, the likely outcome is that the end-user will experience loss of
access to the system.
</para>

<para>
Additional  information  is  also  available  from  the following site:
</para>

<para>
<literal>http://www.gnome.org/~billh/at-spi-idl/html/classAccessibility_1_1LoginHelper.html</literal>
</para>
</refsect1>

<refsect1 id="libloginhelper-3-file"><title>FILES</title>
<para>
The following files are used by this library:
</para>
<variablelist termlength="wholeline">
<varlistentry>
<term><filename>/usr/lib/&cmd;.so</filename></term>
<listitem><para>
Login-Helper library for assistive technologies
</para></listitem></varlistentry>
</variablelist></refsect1>

<refsect1 id="libloginhelper-3-attr"><title>ATTRIBUTES</title>
<para>
See
<olink targetdocent="REFMAN5" localinfo="attributes-5">
<citerefentry><refentrytitle>attributes</refentrytitle>
<manvolnum>5</manvolnum></citerefentry></olink>
for descriptions of the following attributes:
</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="1*">
<colspec colname="COLSPEC1" colwidth="1*">
<thead>
<row>
<entry align="center" valign="middle">ATTRIBUTE TYPE</entry>
<entry align="center" valign="middle">ATTRIBUTE VALUE</entry></row>
</thead>
<tbody>
<row>
<entry><para>Availability</para></entry>
<entry><para>gnome/accessibility/gnome-a11y-libs</para></entry></row>
<row>
<entry colname="COLSPEC0"><para>Interface stability</para></entry>
<entry colname="COLSPEC1"><para>Volatile</para></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 id="libloginhelper-3-also"><title>SEE ALSO</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
<citerefentry><refentrytitle>libatk-1.0</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libcspi</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>

<refsect1 id="libloginhelper-3-note"><title>NOTES</title>
<para>
login-helper module is in at-spi package.
</para>
</refsect1>
</refentry>
