atkutil.xml

linux下图形库开发包atk-1.4.0.tar.gz

<indexterm><primary>AtkEventListenerInit</primary></indexterm><programlisting><link linkend="void">void</link>        (*AtkEventListenerInit)         (void);</programlisting>
<para>
An AtkEventListenerInit is an initialization function in an implementation 
of the ATK interface used to perform implementation-specific initialization
when enabling focus tracking.

</para></refsect2>
<refsect2>
<title><anchor id="atk-add-global-event-listener"/>atk_add_global_event_listener ()</title>
<indexterm><primary>atk_add_global_event_listener</primary></indexterm><programlisting><link linkend="guint">guint</link>       atk_add_global_event_listener   (<link linkend="GSignalEmissionHook">GSignalEmissionHook</link> listener,
                                             const <link linkend="gchar">gchar</link> *event_type);</programlisting>
<para>
Adds the specified function to the list of functions to be called
when an event of type event_type occurs.</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>event_type</parameter>&nbsp;:</term>
<listitem><simpara> the type of event for which notification is requested
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> added event listener id, or 0 on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-remove-global-event-listener"/>atk_remove_global_event_listener ()</title>
<indexterm><primary>atk_remove_global_event_listener</primary></indexterm><programlisting><link linkend="void">void</link>        atk_remove_global_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>
<title><anchor id="AtkKeyEventStruct"/>struct AtkKeyEventStruct</title>
<indexterm><primary>AtkKeyEventStruct</primary></indexterm><programlisting>struct AtkKeyEventStruct {

  gint type;
  guint state;
  guint keyval;
  gint length;
  gchar *string;
  guint16 keycode;
  guint32 timestamp;	
};
</programlisting>
<para>
The AtkKeyEventStruct describes a keyboard event.
</para></refsect2>
<refsect2>
<title><anchor id="AtkKeyEventType"/>enum AtkKeyEventType</title>
<indexterm><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>
<term><literal>ATK_KEY_EVENT_PRESS</literal></term>
<listitem><simpara> specifies a key press event
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_KEY_EVENT_RELEASE</literal></term>
<listitem><simpara> specifies a key release event
</simpara></listitem>
</varlistentry>
<varlistentry>
<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>
<title><anchor id="AtkKeySnoopFunc"/>AtkKeySnoopFunc ()</title>
<indexterm><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 AtkKeySnoopFunc is a function which is called when a keyboard event occurs.
</para><variablelist role="params">
<varlistentry><term><parameter>event</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>func_data</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-add-key-event-listener"/>atk_add_key_event_listener ()</title>
<indexterm><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> :</term><listitem><simpara> added event listener id, or 0 on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-remove-key-event-listener"/>atk_remove_key_event_listener ()</title>
<indexterm><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>
<title><anchor id="atk-get-root"/>atk_get_root ()</title>
<indexterm><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> :</term><listitem><simpara> the root accessible container for the current application
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-get-toolkit-name"/>atk_get_toolkit_name ()</title>
<indexterm><primary>atk_get_toolkit_name</primary></indexterm><programlisting>G_CONST_RETURN <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> :</term><listitem><simpara> name string for the GUI toolkit implementing ATK for this application
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-get-toolkit-version"/>atk_get_toolkit_version ()</title>
<indexterm><primary>atk_get_toolkit_version</primary></indexterm><programlisting>G_CONST_RETURN <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> :</term><listitem><simpara> version string for the GUI toolkit implementing ATK for this application
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>