doc/libatspi/html/libatspi-atspi-action.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>atspi-action</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
   7 <link rel="home" href="index.html" title="libatspi Reference Manual">
   8 <link rel="up" href="ch01.html" title="API reference">
   9 <link rel="prev" href="libatspi-atspi-collection.html" title="atspi-collection">
  10 <link rel="next" href="AtspiRelation.html" title="atspi-relation">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="libatspi-atspi-collection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">libatspi Reference Manual</th>
  21 <td><a accesskey="n" href="AtspiRelation.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#libatspi-atspi-action.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libatspi-atspi-action.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#libatspi-atspi-action.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#libatspi-atspi-action.implementations" class="shortcut">Known Implementations</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="libatspi-atspi-action"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="libatspi-atspi-action.top_of_page"></a>atspi-action</span></h2>
  38 <p>atspi-action</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="libatspi-atspi-action.synopsis"></a><h2>Synopsis</h2>
  44 <a name="AtspiAction"></a><pre class="synopsis">                    <a class="link" href="libatspi-atspi-action.html#AtspiAction-struct" title="AtspiAction">AtspiAction</a>;
  45 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <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>          (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
  46                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  47 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libatspi-atspi-action.html#atspi-action-get-description" title="atspi_action_get_description ()">atspi_action_get_description</a>        (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
  48                                                          <em class="parameter"><code><span class="type">int</span> i</code></em>,
  49                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  50 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <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>        (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
  51                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>,
  52                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  53 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libatspi-atspi-action.html#atspi-action-get-name" title="atspi_action_get_name ()">atspi_action_get_name</a>               (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
  54                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>,
  55                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  56 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libatspi-atspi-action.html#atspi-action-do-action" title="atspi_action_do_action ()">atspi_action_do_action</a>              (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
  57                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>,
  58                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="libatspi-atspi-action.object-hierarchy"></a><h2>Object Hierarchy</h2>
  63 <pre class="synopsis">
  64   GInterface
  65    +----AtspiAction
  66 </pre>
  67 </div>
  68 <div class="refsect1">
  69 <a name="libatspi-atspi-action.implementations"></a><h2>Known Implementations</h2>
  70 <p>
  71 AtspiAction is implemented by
  72  <a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
  73 </div>
  74 <div class="refsect1">
  75 <a name="libatspi-atspi-action.description"></a><h2>Description</h2>
  76 <p>
  77 </p>
  78 </div>
  79 <div class="refsect1">
  80 <a name="libatspi-atspi-action.details"></a><h2>Details</h2>
  81 <div class="refsect2">
  82 <a name="AtspiAction-struct"></a><h3>AtspiAction</h3>
  83 <pre class="programlisting">typedef struct _AtspiAction AtspiAction;</pre>
  84 <p>
  85 </p>
  86 </div>
  87 <hr>
  88 <div class="refsect2">
  89 <a name="atspi-action-get-n-actions"></a><h3>atspi_action_get_n_actions ()</h3>
  90 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                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>,
  91                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
  92 <p>
  93 Get the number of actions invokable on an <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor.
  94 </p>
  95 <div class="variablelist"><table border="0" class="variablelist">
  96 <colgroup>
  97 <col align="left" valign="top">
  98 <col>
  99 </colgroup>
 100 <tbody>
 101 <tr>
 102 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 103 <td>a pointer to the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> to query.</td>
 104 </tr>
 105 <tr>
 106 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 107 <td>an integer indicating the number of invocable actions.</td>
 108 </tr>
 109 </tbody>
 110 </table></div>
 111 </div>
 112 <hr>
 113 <div class="refsect2">
 114 <a name="atspi-action-get-description"></a><h3>atspi_action_get_description ()</h3>
 115 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             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>,
 116                                                          <em class="parameter"><code><span class="type">int</span> i</code></em>,
 117                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 118 <p>
 119 Get the description of '<em class="parameter"><code>i</code></em>-th' action invocable on an
 120      object implementing <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a>.
 121 </p>
 122 <div class="variablelist"><table border="0" class="variablelist">
 123 <colgroup>
 124 <col align="left" valign="top">
 125 <col>
 126 </colgroup>
 127 <tbody>
 128 <tr>
 129 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 130 <td>a pointer to the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor to query.</td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
 134 <td>an integer indicating which action to query.</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 138 <td>a UTF-8 string describing the '<em class="parameter"><code>i</code></em>-th' invocable action.</td>
 139 </tr>
 140 </tbody>
 141 </table></div>
 142 </div>
 143 <hr>
 144 <div class="refsect2">
 145 <a name="atspi-action-get-key-binding"></a><h3>atspi_action_get_key_binding ()</h3>
 146 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             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>,
 147                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>,
 148                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 149 <p>
 150 Get the keybindings for the <em class="parameter"><code>i</code></em>-th action invocable on an
 151      object implementing <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a>, if any are defined.
 152      The keybindings string format is as follows:
 153        there are multiple parts to a keybinding string (typically 3).
 154        They are delimited with ";".  The first is the action's
 155        keybinding which is usable if the object implementing the action
 156        is currently posted to the screen, e.g. if a menu is posted
 157        then these keybindings for the corresponding menu-items are
 158        available.  The second keybinding substring is the full key sequence
 159        necessary to post the action's widget and activate it, e.g. for
 160        a menu item such as "File-&gt;Open" it would both post the menu and
 161        activate the item.  Thus the second keybinding string is available
 162        during the lifetime of the containing toplevel window as a whole,
 163        whereas the first keybinding string only works while the object
 164        implementing AtkAction is posted.  The third (and optional)
 165        keybinding string is the "keyboard shortcut" which invokes the
 166        action without posting any menus.
 167        Meta-keys are indicated by the conventional strings
 168        "&lt;Control&gt;", "&lt;Alt&gt;", "&lt;Shift&gt;", "&lt;Mod2&gt;",
 169        etc. (we use the same string as <a href="../gtk3/gtk3-Keyboard-Accelerators.html#gtk-accelerator-name"><code class="function">gtk_accelerator_name()</code></a> in
 170        gtk+-2.X.
 171 </p>
 172 <div class="variablelist"><table border="0" class="variablelist">
 173 <colgroup>
 174 <col align="left" valign="top">
 175 <col>
 176 </colgroup>
 177 <tbody>
 178 <tr>
 179 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 180 <td>a pointer to the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor to query.</td>
 181 </tr>
 182 <tr>
 183 <td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
 184 <td>an integer indicating which action to query.</td>
 185 </tr>
 186 <tr>
 187 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 188 <td>a UTF-8 string which can be parsed to determine the <em class="parameter"><code>i</code></em>-th
 189 invocable action's keybindings.</td>
 190 </tr>
 191 </tbody>
 192 </table></div>
 193 </div>
 194 <hr>
 195 <div class="refsect2">
 196 <a name="atspi-action-get-name"></a><h3>atspi_action_get_name ()</h3>
 197 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             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>,
 198                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>,
 199                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 200 <p>
 201 Get the name of the '<em class="parameter"><code>i</code></em>-th' action invocable on an
 202      object implementing <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a>.
 203 </p>
 204 <div class="variablelist"><table border="0" class="variablelist">
 205 <colgroup>
 206 <col align="left" valign="top">
 207 <col>
 208 </colgroup>
 209 <tbody>
 210 <tr>
 211 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 212 <td>a pointer to the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor to query.</td>
 213 </tr>
 214 <tr>
 215 <td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
 216 <td>an integer indicating which action to query.</td>
 217 </tr>
 218 <tr>
 219 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 220 <td>the non-localized name of the action, as a UTF-8 string.</td>
 221 </tr>
 222 </tbody>
 223 </table></div>
 224 </div>
 225 <hr>
 226 <div class="refsect2">
 227 <a name="atspi-action-do-action"></a><h3>atspi_action_do_action ()</h3>
 228 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 229                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>,
 230                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 231 <p>
 232 Invoke the action indicated by <a class="link" href="index.html" title="libatspi Reference Manual"><span class="type">index</span></a>.
 233 </p>
 234 <div class="variablelist"><table border="0" class="variablelist">
 235 <colgroup>
 236 <col align="left" valign="top">
 237 <col>
 238 </colgroup>
 239 <tbody>
 240 <tr>
 241 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 242 <td>a pointer to the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> to query.</td>
 243 </tr>
 244 <tr>
 245 <td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
 246 <td>an integer specifying which action to invoke.</td>
 247 </tr>
 248 <tr>
 249 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 250 <td>
 251 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if the action is successfully invoked, otherwise <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>.</td>
 252 </tr>
 253 </tbody>
 254 </table></div>
 255 </div>
 256 </div>
 257 </div>
 258 <div class="footer">
 259 <hr>
 260           Generated by GTK-Doc V1.18.1</div>
 261 </body>
 262 </html>