| Current File : //kunden/usr/share/gtk-doc/html/libatspi/libatspi-atspi-action.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>atspi-action: libatspi Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="libatspi-atspi-collection.html" title="atspi-collection">
<link rel="next" href="AtspiRelation.html" title="AtspiRelation">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libatspi-atspi-action.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#libatspi-atspi-action.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#libatspi-atspi-action.implementations" class="shortcut">Known Implementations</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libatspi-atspi-collection.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="AtspiRelation.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libatspi-atspi-action"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-action.top_of_page"></a>atspi-action</span></h2>
<p>atspi-action</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libatspi-atspi-action.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-action.html#atspi-action-get-n-actions" title="atspi_action_get_n_actions ()">atspi_action_get_n_actions</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-action.html#atspi-action-get-description" title="atspi_action_get_description ()">atspi_action_get_description</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-action.html#atspi-action-get-key-binding" title="atspi_action_get_key_binding ()">atspi_action_get_key_binding</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-action.html#atspi-action-get-action-description" title="atspi_action_get_action_description ()">atspi_action_get_action_description</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-action.html#atspi-action-get-action-name" title="atspi_action_get_action_name ()">atspi_action_get_action_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-action.html#atspi-action-get-localized-name" title="atspi_action_get_localized_name ()">atspi_action_get_localized_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-action.html#atspi-action-get-name" title="atspi_action_get_name ()">atspi_action_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-action.html#atspi-action-do-action" title="atspi_action_do_action ()">atspi_action_do_action</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="AtspiAction"></a><div class="refsect1">
<a name="libatspi-atspi-action.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libatspi-atspi-action.html#AtspiAction-struct" title="AtspiAction">AtspiAction</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libatspi-atspi-action.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> AtspiAction
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-action.implementations"></a><h2>Known Implementations</h2>
<p>
AtspiAction is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-action.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libatspi-atspi-action.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="atspi-action-get-n-actions"></a><h3>atspi_action_get_n_actions ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
atspi_action_get_n_actions (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Get the number of actions invokable on an <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor.</p>
<div class="refsect3">
<a name="atspi-action-get-n-actions.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> to query.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-action-get-n-actions.returns"></a><h4>Returns</h4>
<p> an integer indicating the number of invocable actions.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-action-get-description"></a><h3>atspi_action_get_description ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
atspi_action_get_description (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> i</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">atspi_action_get_description</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
<p>Use atspi_action_get_action_description instead.</p>
</div>
<p>Get the description of '<em class="parameter"><code>i</code></em>
-th' action invocable on an
object implementing <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a>.</p>
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_action_get_action_description]</span></p>
<div class="refsect3">
<a name="atspi-action-get-description.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>an integer indicating which action to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-action-get-description.returns"></a><h4>Returns</h4>
<p> a UTF-8 string describing the '<em class="parameter"><code>i</code></em>
-th' invocable action.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-action-get-key-binding"></a><h3>atspi_action_get_key_binding ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
atspi_action_get_key_binding (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> i</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Get the keybindings for the <em class="parameter"><code>i</code></em>
-th action invocable on an
object implementing <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a>, if any are defined.
The keybindings string format is as follows:
there are multiple parts to a keybinding string (typically 3).
They are delimited with ";". The first is the action's
keybinding which is usable if the object implementing the action
is currently posted to the screen, e.g. if a menu is posted
then these keybindings for the corresponding menu-items are
available. The second keybinding substring is the full key sequence
necessary to post the action's widget and activate it, e.g. for
a menu item such as "File->Open" it would both post the menu and
activate the item. Thus the second keybinding string is available
during the lifetime of the containing toplevel window as a whole,
whereas the first keybinding string only works while the object
implementing AtkAction is posted. The third (and optional)
keybinding string is the "keyboard shortcut" which invokes the
action without posting any menus.
Meta-keys are indicated by the conventional strings
"<Control>", "<Alt>", "<Shift>", "<Mod2>",
etc. (we use the same string as <code class="function">gtk_accelerator_name()</code> in
gtk+-2.X.</p>
<div class="refsect3">
<a name="atspi-action-get-key-binding.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>an integer indicating which action to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-action-get-key-binding.returns"></a><h4>Returns</h4>
<p> a UTF-8 string which can be parsed to determine the <em class="parameter"><code>i</code></em>
-th
invocable action's keybindings.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-action-get-action-description"></a><h3>atspi_action_get_action_description ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
atspi_action_get_action_description (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">int</span> i</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Get the description of '<em class="parameter"><code>i</code></em>
-th' action invocable on an
object implementing <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a>.</p>
<div class="refsect3">
<a name="atspi-action-get-action-description.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>an integer indicating which action to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-action-get-action-description.returns"></a><h4>Returns</h4>
<p> a UTF-8 string describing the '<em class="parameter"><code>i</code></em>
-th' invocable action.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-action-get-action-name"></a><h3>atspi_action_get_action_name ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
atspi_action_get_action_name (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> i</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Get the name of the '<em class="parameter"><code>i</code></em>
-th' action invocable on an
object implementing <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a>.</p>
<div class="refsect3">
<a name="atspi-action-get-action-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>an integer indicating which action to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-action-get-action-name.returns"></a><h4>Returns</h4>
<p> the non-localized name of the action, as a UTF-8 string.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-action-get-localized-name"></a><h3>atspi_action_get_localized_name ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
atspi_action_get_localized_name (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> i</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Get the name of the '<em class="parameter"><code>i</code></em>
-th' action invocable on an
object implementing <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a>.</p>
<div class="refsect3">
<a name="atspi-action-get-localized-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>an integer indicating which action to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-action-get-localized-name.returns"></a><h4>Returns</h4>
<p> the name of the action, as a UTF-8 string.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-action-get-name"></a><h3>atspi_action_get_name ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
atspi_action_get_name (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> i</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">atspi_action_get_name</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
<p>Use atspi_action_get_action_name instead.</p>
</div>
<p>Get the name of the '<em class="parameter"><code>i</code></em>
-th' action invocable on an
object implementing <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a>.</p>
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_action_get_action_name]</span></p>
<div class="refsect3">
<a name="atspi-action-get-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>an integer indicating which action to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-action-get-name.returns"></a><h4>Returns</h4>
<p> the non-localized name of the action, as a UTF-8 string.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-action-do-action"></a><h3>atspi_action_do_action ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_action_do_action (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> i</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Invoke the action indicated by <a class="link" href="index.html" title="libatspi Reference Manual"><span class="type">index</span></a>.</p>
<div class="refsect3">
<a name="atspi-action-do-action.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>an integer specifying which action to invoke.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-action-do-action.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if the action is successfully invoked, otherwise <span class="type">FALSE</span>.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libatspi-atspi-action.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AtspiAction-struct"></a><h3>AtspiAction</h3>
<pre class="programlisting">typedef struct _AtspiAction AtspiAction;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>