atkutil.xml

The ATK library provides a set of interfaces for accessibility.By supporting the ATK interfaces, an

Removes the specified event listener</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>listener_id</parameter>&nbsp;:</term>
<listitem><simpara> the id of the event listener to remove
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="AtkKeyEventStruct" role="struct">
<title>AtkKeyEventStruct</title>
<indexterm zone="AtkKeyEventStruct"><primary>AtkKeyEventStruct</primary></indexterm><programlisting>typedef struct {
  gint type;
  guint state;
  guint keyval;
  gint length;
  gchar *string;
  guint16 keycode;
  guint32 timestamp;	
} AtkKeyEventStruct;
</programlisting>
<para>
Encapsulates information about a key event.</para>
<para>

</para><variablelist role="struct">
<varlistentry>
<term><link linkend="gint">gint</link>&nbsp;<structfield>type</structfield>;</term>
<listitem><simpara> An AtkKeyEventType, generally one of ATK_KEY_EVENT_PRESS or ATK_KEY_EVENT_RELEASE
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="guint">guint</link>&nbsp;<structfield>state</structfield>;</term>
<listitem><simpara> A bitmask representing the state of the modifier keys immediately after the event takes place.   
The meaning of the bits is currently defined to match the bitmask used by GDK in
GdkEventType.state, see 
http://developer.gnome.org/doc/API/2.0/gdk/gdk-Event-Structures.html<link linkend="GdkEventKey"><type>GdkEventKey</type></link>
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="guint">guint</link>&nbsp;<structfield>keyval</structfield>;</term>
<listitem><simpara> A guint representing a keysym value corresponding to those used by GDK and X11: see
/usr/X11/include/keysymdef.h.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&nbsp;<structfield>length</structfield>;</term>
<listitem><simpara> The length of member <link linkend="string"><type>string</type></link>.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>string</structfield>;</term>
<listitem><simpara> A string containing one of the following: either a string approximating the text that would 
result from this keypress, if the key is a control or graphic character, or a symbolic name for this keypress.
Alphanumeric and printable keys will have the symbolic key name in this string member, for instance "A". "0", 
"semicolon", "aacute".  Keypad keys have the prefix "KP".
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="guint16">guint16</link>&nbsp;<structfield>keycode</structfield>;</term>
<listitem><simpara> The raw hardware code that generated the key event.  This field is raraly useful.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="guint32">guint32</link>&nbsp;<structfield>timestamp</structfield>;</term>
<listitem><simpara> A timestamp in milliseconds indicating when the event occurred.  
These timestamps are relative to a starting point which should be considered arbitrary, 
and only used to compare the dispatch times of events to one another.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="AtkKeyEventType" role="enum">
<title>enum AtkKeyEventType</title>
<indexterm zone="AtkKeyEventType"><primary>AtkKeyEventType</primary></indexterm><programlisting>typedef enum
{
  ATK_KEY_EVENT_PRESS,
  ATK_KEY_EVENT_RELEASE,
  ATK_KEY_EVENT_LAST_DEFINED
} AtkKeyEventType;
</programlisting>
<para>
Specifies the type of a keyboard evemt.</para>
<para>

</para><variablelist role="enum">
<varlistentry id="ATK-KEY-EVENT-PRESS:CAPS" role="constant">
<term><literal>ATK_KEY_EVENT_PRESS</literal></term>
<listitem><simpara> specifies a key press event
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-KEY-EVENT-RELEASE:CAPS" role="constant">
<term><literal>ATK_KEY_EVENT_RELEASE</literal></term>
<listitem><simpara> specifies a key release event
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-KEY-EVENT-LAST-DEFINED:CAPS" role="constant">
<term><literal>ATK_KEY_EVENT_LAST_DEFINED</literal></term>
<listitem><simpara> Not a valid value; specifies end of enumeration
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="AtkKeySnoopFunc" role="function">
<title>AtkKeySnoopFunc ()</title>
<indexterm zone="AtkKeySnoopFunc"><primary>AtkKeySnoopFunc</primary></indexterm><programlisting><link linkend="gint">gint</link>                (*AtkKeySnoopFunc)                  (<link linkend="AtkKeyEventStruct">AtkKeyEventStruct</link> *event,
                                                         <link linkend="gpointer">gpointer</link> func_data);</programlisting>
<para>
An <link linkend="AtkKeySnoopFunc"><type>AtkKeySnoopFunc</type></link> is a type of callback which is called whenever a key event occurs, 
if registered via atk_add_key_event_listener.  It allows for pre-emptive 
interception of key events via the return code as described below.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>event</parameter>&nbsp;:</term>
<listitem><simpara> an AtkKeyEventStruct containing information about the key event for which
notification is being given.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>func_data</parameter>&nbsp;:</term>
<listitem><simpara> a block of data which will be passed to the event listener, on notification.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE (nonzero) if the event emission should be stopped and the event 
discarded without being passed to the normal GUI recipient; FALSE (zero) if the 
event dispatch to the client application should proceed as normal.

<parameter>see</parameter>: atk_add_key_event_listener.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-add-key-event-listener" role="function">
<title>atk_add_key_event_listener ()</title>
<indexterm zone="atk-add-key-event-listener"><primary>atk_add_key_event_listener</primary></indexterm><programlisting><link linkend="guint">guint</link>               atk_add_key_event_listener          (<link linkend="AtkKeySnoopFunc">AtkKeySnoopFunc</link> listener,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Adds the specified function to the list of functions to be called
       when a key event occurs.  The <parameter>data</parameter> element will be passed to the
       <link linkend="AtkKeySnoopFunc"><type>AtkKeySnoopFunc</type></link> (<parameter>listener</parameter>) as the <parameter>func_data</parameter> param, on notification.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>listener</parameter>&nbsp;:</term>
<listitem><simpara> the listener to notify
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="gpointer"><type>gpointer</type></link> that points to a block of data that should be sent to the registered listeners,
       along with the event notification, when it occurs.  
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> added event listener id, or 0 on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-remove-key-event-listener" role="function">
<title>atk_remove_key_event_listener ()</title>
<indexterm zone="atk-remove-key-event-listener"><primary>atk_remove_key_event_listener</primary></indexterm><programlisting><link linkend="void">void</link>                atk_remove_key_event_listener       (<link linkend="guint">guint</link> listener_id);</programlisting>
<para>
Removes the specified event listener</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>listener_id</parameter>&nbsp;:</term>
<listitem><simpara> the id of the event listener to remove
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-get-root" role="function">
<title>atk_get_root ()</title>
<indexterm zone="atk-get-root"><primary>atk_get_root</primary></indexterm><programlisting><link linkend="AtkObject">AtkObject</link>*          atk_get_root                        (void);</programlisting>
<para>
Gets the root accessible container for the current application.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the root accessible container for the current application
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-get-focus-object" role="function" condition="since:ATK 1.6">
<title>atk_get_focus_object ()</title>
<indexterm zone="atk-get-focus-object" role="ATK 1.6"><primary>atk_get_focus_object</primary></indexterm><programlisting><link linkend="AtkObject">AtkObject</link>*          atk_get_focus_object                (void);</programlisting>
<para>
Gets the currently focused object.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the currently focused object for the current application
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  ATK 1.6

</para></refsect2>
<refsect2 id="atk-get-toolkit-name" role="function">
<title>atk_get_toolkit_name ()</title>
<indexterm zone="atk-get-toolkit-name"><primary>atk_get_toolkit_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_get_toolkit_name                (void);</programlisting>
<para>
Gets name string for the GUI toolkit implementing ATK for this application.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> name string for the GUI toolkit implementing ATK for this application
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-get-toolkit-version" role="function">
<title>atk_get_toolkit_version ()</title>
<indexterm zone="atk-get-toolkit-version"><primary>atk_get_toolkit_version</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_get_toolkit_version             (void);</programlisting>
<para>
Gets version string for the GUI toolkit implementing ATK for this application.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> version string for the GUI toolkit implementing ATK for this application
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>