|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/21585/root/usr/share/gtk-doc/html/atk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>AtkAction</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atk.html" title="ATK Library">
<link rel="prev" href="atk.html" title="ATK Library">
<link rel="next" href="AtkComponent.html" title="AtkComponent">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="atk.html" title="ATK Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in ATK 1.3">
<link rel="index" href="ix04.html" title="Index of new symbols in ATK 1.4">
<link rel="index" href="ix05.html" title="Index of new symbols in ATK 1.6">
<link rel="index" href="ix06.html" title="Index of new symbols in ATK 1.9">
<link rel="index" href="ix07.html" title="Index of new symbols in ATK 1.12">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="atk.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="atk.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
<td><a accesskey="n" href="AtkComponent.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2491527" class="shortcut">Top</a>
 | 
<a href="#id2531235" class="shortcut">Description</a>
 | 
<a href="#id2487068" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2531203" class="shortcut">Known Implementations</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="AtkAction"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2491527"></a><span class="refentrytitle">AtkAction</span>
</h2>
<p>AtkAction — The ATK interface provided by UI components which the user can
activate/interact with,</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="AtkAction.html#AtkAction-struct">AtkAction</a>;
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="AtkAction.html#atk-action-do-action">atk_action_do_action</a> (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="AtkAction.html#atk-action-get-n-actions">atk_action_get_n_actions</a> (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkAction.html#atk-action-get-description">atk_action_get_description</a> (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkAction.html#atk-action-get-name">atk_action_get_name</a> (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkAction.html#atk-action-get-localized-name">atk_action_get_localized_name</a> (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkAction.html#atk-action-get-keybinding">atk_action_get_keybinding</a> (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="AtkAction.html#atk-action-set-description">atk_action_set_description</a> (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *desc);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2487068"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----AtkAction
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2531203"></a><h2>Known Implementations</h2>
<p>
AtkAction is implemented by
<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> and <a href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2531235"></a><h2>Description</h2>
<p>
<a href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> should be implemented by instances of <a href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> classes with
which the user can interact directly, i.e. buttons, checkboxes,
scrollbars, e.g. components which are not "passive"
providers of UI information.
</p>
<p>
Exceptions: when the user interaction is already covered by
another appropriate interface such as <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> (insert/delete
test, etc.) or <a href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> (set value) then these actions should not be
exposed by <a href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> as well.
</p>
<p>
Also note that the <a href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> API is limited in that parameters may not
be passed to the object being activated; thus the action must be
self-contained and specifiable via only a single "verb". Concrete
examples include "press", "release", "click" for buttons, "drag"
(meaning initiate drag) and "drop" for drag sources and drop targets,
etc.
</p>
<p>
Though most UI interactions on components should be invocable via
keyboard as well as mouse, there will generally be a close mapping
between "mouse actions" that are possible on a component and the
AtkActions. Where mouse and keyboard actions are redundant in effect,
<a href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> should expose only one action rather than exposing redundant
actions if possible. By convention we have been using "mouse centric"
terminology for <a href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> names.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2531349"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2531359"></a><h3>
<a name="AtkAction-struct"></a>AtkAction</h3>
<a class="indexterm" name="id2531372"></a><pre class="programlisting">typedef struct _AtkAction AtkAction;</pre>
<p>
The AtkAction structure does not contain any fields.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2531388"></a><h3>
<a name="atk-action-do-action"></a>atk_action_do_action ()</h3>
<a class="indexterm" name="id2531401"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> atk_action_do_action (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);</pre>
<p>
Perform the specified action on the object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkActionIface
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
<td> the action index corresponding to the action to be performed
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if success, <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2531518"></a><h3>
<a name="atk-action-get-n-actions"></a>atk_action_get_n_actions ()</h3>
<a class="indexterm" name="id2531530"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> atk_action_get_n_actions (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action);</pre>
<p>
Gets the number of accessible actions available on the object.
If there are more than one, the first one is considered the
"default" action of the object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkActionIface
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a the number of actions, or 0 if <em class="parameter"><code>action</code></em> does not
implement this interface.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2531606"></a><h3>
<a name="atk-action-get-description"></a>atk_action_get_description ()</h3>
<a class="indexterm" name="id2531619"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_action_get_description (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);</pre>
<p>
Returns a description of the specified action of the object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkActionIface
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
<td> the action index corresponding to the action to be performed
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a description string, or <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
if <em class="parameter"><code>action</code></em> does not implement this interface.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2531730"></a><h3>
<a name="atk-action-get-name"></a>atk_action_get_name ()</h3>
<a class="indexterm" name="id2531743"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_action_get_name (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);</pre>
<p>
Returns the name of the specified action of the object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkActionIface
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
<td> the action index corresponding to the action to be performed
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a name string, or <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
if <em class="parameter"><code>action</code></em> does not implement this interface.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2531852"></a><h3>
<a name="atk-action-get-localized-name"></a>atk_action_get_localized_name ()</h3>
<a class="indexterm" name="id2531865"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_action_get_localized_name (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);</pre>
<p>
Returns the localized name of the specified action of the object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkActionIface
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
<td> the action index corresponding to the action to be performed
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a name string, or <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
if <em class="parameter"><code>action</code></em> does not implement this interface.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2531975"></a><h3>
<a name="atk-action-get-keybinding"></a>atk_action_get_keybinding ()</h3>
<a class="indexterm" name="id2531988"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_action_get_keybinding (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);</pre>
<p>
Returns a keybinding associated with this action, if one exists.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkActionIface
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
<td> the action index corresponding to the action to be performed
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a string representing the keybinding, or <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
if there is no keybinding for this action.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2532092"></a><h3>
<a name="atk-action-set-description"></a>atk_action_set_description ()</h3>
<a class="indexterm" name="id2532105"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> atk_action_set_description (<a href="AtkAction.html" title="AtkAction">AtkAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *desc);</pre>
<p>
Sets a description of the specified action of the object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkActionIface
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
<td> the action index corresponding to the action to be performed
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>desc</code></em> :</span></td>
<td> the description to be assigned to this action
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a gboolean representing if the description was successfully set;
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>