atkaction.xml

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

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-action-get-description" role="function">
<title>atk_action_get_description ()</title>
<indexterm zone="atk-action-get-description"><primary>atk_action_get_description</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_action_get_description          (<link linkend="AtkAction">AtkAction</link> *action,
                                                         <link linkend="gint">gint</link> i);</programlisting>
<para>
Returns a description of the specified action of the object.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkActionIface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>i</parameter>&nbsp;:</term>
<listitem><simpara> the action index corresponding to the action to be performed 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a description string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if <parameter>action</parameter> does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-action-get-name" role="function">
<title>atk_action_get_name ()</title>
<indexterm zone="atk-action-get-name"><primary>atk_action_get_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_action_get_name                 (<link linkend="AtkAction">AtkAction</link> *action,
                                                         <link linkend="gint">gint</link> i);</programlisting>
<para>
Returns a non-localized string naming the specified action of the 
object. This name is generally not descriptive of the end result 
of the action, but instead names the 'interaction type' which the 
object supports. By convention, the above strings should be used to 
represent the actions which correspond to the common point-and-click 
interaction techniques of the same name: i.e. 
"click", "press", "release", "drag", "drop", "popup", etc.
The "popup" action should be used to pop up a context menu for the 
object, if one exists.
</para>
<para>
For technical reasons, some toolkits cannot guarantee that the 
reported action is actually 'bound' to a nontrivial user event;
i.e. the result of some actions via <link linkend="atk-action-do-action"><function>atk_action_do_action()</function></link> may be
NIL.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkActionIface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>i</parameter>&nbsp;:</term>
<listitem><simpara> the action index corresponding to the action to be performed 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a name string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if <parameter>action</parameter> does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-action-get-localized-name" role="function">
<title>atk_action_get_localized_name ()</title>
<indexterm zone="atk-action-get-localized-name"><primary>atk_action_get_localized_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_action_get_localized_name       (<link linkend="AtkAction">AtkAction</link> *action,
                                                         <link linkend="gint">gint</link> i);</programlisting>
<para>
Returns the localized name of the specified action of the object.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkActionIface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>i</parameter>&nbsp;:</term>
<listitem><simpara> the action index corresponding to the action to be performed 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a name string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if <parameter>action</parameter> does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-action-get-keybinding" role="function">
<title>atk_action_get_keybinding ()</title>
<indexterm zone="atk-action-get-keybinding"><primary>atk_action_get_keybinding</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_action_get_keybinding           (<link linkend="AtkAction">AtkAction</link> *action,
                                                         <link linkend="gint">gint</link> i);</programlisting>
<para>
Returns a keybinding associated with this action, if one exists.
The returned string is in the format "&lt;a&gt;;&lt;b&gt;;&lt;c&gt;"
(i.e. semicolon-delimited), where &lt;a&gt; is the keybinding which
activates the object if it is presently enabled onscreen, 
&lt;b&gt; corresponds to the keybinding or sequence of keys
which invokes the action even if the relevant element is not
currently posted on screen (for instance, for a menu item it
posts the parent menus before invoking).  The last token in the
above string, if non-empty, represents a keyboard shortcut which
invokes the same action without posting the component or its
enclosing menus or dialogs.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkActionIface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>i</parameter>&nbsp;:</term>
<listitem><simpara> the action index corresponding to the action to be performed 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a string representing the available keybindings, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if there is no keybinding for this action.

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-action-set-description" role="function">
<title>atk_action_set_description ()</title>
<indexterm zone="atk-action-set-description"><primary>atk_action_set_description</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_action_set_description          (<link linkend="AtkAction">AtkAction</link> *action,
                                                         <link linkend="gint">gint</link> i,
                                                         const <link linkend="gchar">gchar</link> *desc);</programlisting>
<para>
Sets a description of the specified action of the object.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkActionIface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>i</parameter>&nbsp;:</term>
<listitem><simpara> the action index corresponding to the action to be performed 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>desc</parameter>&nbsp;:</term>
<listitem><simpara> the description to be assigned to this action
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a gboolean representing if the description was successfully set;
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>