← Back to branch summary

~ubuntu-branches/ubuntu/precise/atk1.0/precise

« back to all changes in this revision

Viewing changes to docs/html/AtkAction.html

  • Committer: Package Import Robot
  • Author(s): Luke Yelavich
  • Date: 2012-03-07 09:14:51 UTC
  • mfrom: (1.2.41)
  • Revision ID: package-import@ubuntu.com-20120307091451-lvrxjpc5wy2okfyt
Tags: 2.3.91-0ubuntu1
* New upstream release
  - Bug 665549: add sanity-check of atk_text_get_text
  - Bug 668441: atk_action_get_keybinding docs are confusing and need
    updating
  - Using abstract atk_object_get_name to check accessible-name
    notification
  - Updated Belarusian, Estonian, Hungarian, Turkish, Norwegian,
    Ukranian and Uyghur translations

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/AtkAction.html
8
8
<link rel="up" href="atk.html" title="ATK Library">
9
9
<link rel="prev" href="atk.html" title="ATK Library">
10
10
<link rel="next" href="AtkComponent.html" title="AtkComponent">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
43
43
<div class="refsynopsisdiv">
44
44
<a name="AtkAction.synopsis"></a><h2>Synopsis</h2>
45
45
<pre class="synopsis">                    <a class="link" href="AtkAction.html#AtkAction-struct" title="AtkAction">AtkAction</a>;
46
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="AtkAction.html#atk-action-do-action" title="atk_action_do_action ()">atk_action_do_action</a>                (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
47
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);
48
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="AtkAction.html#atk-action-get-n-actions" title="atk_action_get_n_actions ()">atk_action_get_n_actions</a>            (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>);
49
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="AtkAction.html#atk-action-get-description" title="atk_action_get_description ()">atk_action_get_description</a>          (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
50
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);
51
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="AtkAction.html#atk-action-get-name" title="atk_action_get_name ()">atk_action_get_name</a>                 (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
52
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);
53
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="AtkAction.html#atk-action-get-localized-name" title="atk_action_get_localized_name ()">atk_action_get_localized_name</a>       (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
54
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);
55
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="AtkAction.html#atk-action-get-keybinding" title="atk_action_get_keybinding ()">atk_action_get_keybinding</a>           (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
56
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);
57
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="AtkAction.html#atk-action-set-description" title="atk_action_set_description ()">atk_action_set_description</a>          (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
58
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>,
59
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *desc</code></em>);
 
46
<span class="returnvalue">gboolean</span>            <a class="link" href="AtkAction.html#atk-action-do-action" title="atk_action_do_action ()">atk_action_do_action</a>                (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
 
47
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>);
 
48
<span class="returnvalue">gint</span>                <a class="link" href="AtkAction.html#atk-action-get-n-actions" title="atk_action_get_n_actions ()">atk_action_get_n_actions</a>            (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>);
 
49
const <span class="returnvalue">gchar</span> *       <a class="link" href="AtkAction.html#atk-action-get-description" title="atk_action_get_description ()">atk_action_get_description</a>          (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
 
50
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>);
 
51
const <span class="returnvalue">gchar</span> *       <a class="link" href="AtkAction.html#atk-action-get-name" title="atk_action_get_name ()">atk_action_get_name</a>                 (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
 
52
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>);
 
53
const <span class="returnvalue">gchar</span> *       <a class="link" href="AtkAction.html#atk-action-get-localized-name" title="atk_action_get_localized_name ()">atk_action_get_localized_name</a>       (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
 
54
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>);
 
55
const <span class="returnvalue">gchar</span> *       <a class="link" href="AtkAction.html#atk-action-get-keybinding" title="atk_action_get_keybinding ()">atk_action_get_keybinding</a>           (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
 
56
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>);
 
57
<span class="returnvalue">gboolean</span>            <a class="link" href="AtkAction.html#atk-action-set-description" title="atk_action_set_description ()">atk_action_set_description</a>          (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
 
58
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>,
 
59
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *desc</code></em>);
60
60
</pre>
61
61
</div>
62
62
<div class="refsect1">
116
116
<hr>
117
117
<div class="refsect2">
118
118
<a name="atk-action-do-action"></a><h3>atk_action_do_action ()</h3>
119
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atk_action_do_action                (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
120
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
 
119
<pre class="programlisting"><span class="returnvalue">gboolean</span>            atk_action_do_action                (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
 
120
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
121
121
<p>
122
122
Perform the specified action on the object.
123
123
</p>
126
126
<tbody>
127
127
<tr>
128
128
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
129
 
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkActionIface</td>
 
129
<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td>
130
130
</tr>
131
131
<tr>
132
132
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
135
135
<tr>
136
136
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
137
137
<td>
138
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
 
138
<code class="literal">TRUE</code> if success, <code class="literal">FALSE</code> otherwise</td>
139
139
</tr>
140
140
</tbody>
141
141
</table></div>
143
143
<hr>
144
144
<div class="refsect2">
145
145
<a name="atk-action-get-n-actions"></a><h3>atk_action_get_n_actions ()</h3>
146
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                atk_action_get_n_actions            (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>);</pre>
 
146
<pre class="programlisting"><span class="returnvalue">gint</span>                atk_action_get_n_actions            (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>);</pre>
147
147
<p>
148
148
Gets the number of accessible actions available on the object.
149
149
If there are more than one, the first one is considered the
154
154
<tbody>
155
155
<tr>
156
156
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
157
 
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkActionIface</td>
 
157
<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td>
158
158
</tr>
159
159
<tr>
160
160
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
167
167
<hr>
168
168
<div class="refsect2">
169
169
<a name="atk-action-get-description"></a><h3>atk_action_get_description ()</h3>
170
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       atk_action_get_description          (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
171
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
172
 
<p>
173
 
Returns a description of the specified action of the object.
174
 
</p>
 
170
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       atk_action_get_description          (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
 
171
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
175
172
<div class="variablelist"><table border="0">
176
173
<col align="left" valign="top">
177
174
<tbody>
178
175
<tr>
179
176
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
180
 
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkActionIface</td>
 
177
<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td>
181
178
</tr>
182
179
<tr>
183
180
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
185
182
</tr>
186
183
<tr>
187
184
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
188
 
<td>a description string, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
185
<td>a description string, or <a href="/opt/gnome3/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
189
186
if <em class="parameter"><code>action</code></em> does not implement this interface.</td>
190
187
</tr>
191
188
</tbody>
194
191
<hr>
195
192
<div class="refsect2">
196
193
<a name="atk-action-get-name"></a><h3>atk_action_get_name ()</h3>
197
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       atk_action_get_name                 (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
198
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
199
 
<p>
200
 
Returns a non-localized string naming the specified action of the 
201
 
object. This name is generally not descriptive of the end result 
202
 
of the action, but instead names the 'interaction type' which the 
203
 
object supports. By convention, the above strings should be used to 
204
 
represent the actions which correspond to the common point-and-click 
205
 
interaction techniques of the same name: i.e. 
206
 
"click", "press", "release", "drag", "drop", "popup", etc.
207
 
The "popup" action should be used to pop up a context menu for the 
208
 
object, if one exists.
209
 
</p>
210
 
<p>
211
 
For technical reasons, some toolkits cannot guarantee that the 
212
 
reported action is actually 'bound' to a nontrivial user event;
213
 
i.e. the result of some actions via <a class="link" href="AtkAction.html#atk-action-do-action" title="atk_action_do_action ()"><code class="function">atk_action_do_action()</code></a> may be
214
 
NIL.
215
 
</p>
 
194
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       atk_action_get_name                 (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
 
195
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
216
196
<div class="variablelist"><table border="0">
217
197
<col align="left" valign="top">
218
198
<tbody>
219
199
<tr>
220
200
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
221
 
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkActionIface</td>
 
201
<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td>
222
202
</tr>
223
203
<tr>
224
204
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
226
206
</tr>
227
207
<tr>
228
208
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
229
 
<td>a name string, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
209
<td>a name string, or <a href="/opt/gnome3/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
230
210
if <em class="parameter"><code>action</code></em> does not implement this interface.</td>
231
211
</tr>
232
212
</tbody>
235
215
<hr>
236
216
<div class="refsect2">
237
217
<a name="atk-action-get-localized-name"></a><h3>atk_action_get_localized_name ()</h3>
238
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       atk_action_get_localized_name       (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
239
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
240
 
<p>
241
 
Returns the localized name of the specified action of the object.
242
 
</p>
 
218
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       atk_action_get_localized_name       (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
 
219
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
243
220
<div class="variablelist"><table border="0">
244
221
<col align="left" valign="top">
245
222
<tbody>
246
223
<tr>
247
224
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
248
 
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkActionIface</td>
 
225
<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td>
249
226
</tr>
250
227
<tr>
251
228
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
253
230
</tr>
254
231
<tr>
255
232
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
256
 
<td>a name string, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
233
<td>a name string, or <a href="/opt/gnome3/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
257
234
if <em class="parameter"><code>action</code></em> does not implement this interface.</td>
258
235
</tr>
259
236
</tbody>
262
239
<hr>
263
240
<div class="refsect2">
264
241
<a name="atk-action-get-keybinding"></a><h3>atk_action_get_keybinding ()</h3>
265
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       atk_action_get_keybinding           (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
266
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
267
 
<p>
268
 
Returns a keybinding associated with this action, if one exists.
269
 
The returned string is in the format "&lt;a&gt;;&lt;b&gt;;&lt;c&gt;"
270
 
(i.e. semicolon-delimited), where &lt;a&gt; is the keybinding which
271
 
activates the object if it is presently enabled onscreen, 
272
 
&lt;b&gt; corresponds to the keybinding or sequence of keys
273
 
which invokes the action even if the relevant element is not
274
 
currently posted on screen (for instance, for a menu item it
275
 
posts the parent menus before invoking).  The last token in the
276
 
above string, if non-empty, represents a keyboard shortcut which
277
 
invokes the same action without posting the component or its
278
 
enclosing menus or dialogs.
 
242
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       atk_action_get_keybinding           (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
 
243
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
 
244
<p>
 
245
Gets the keybinding which can be used to activate this action, if one
 
246
exists. The string returned should contain localized, human-readable,
 
247
key sequences as they would appear when displayed on screen. It must
 
248
be in the format "mnemonic;sequence;shortcut".
 
249
</p>
 
250
<p>
 
251
</p>
 
252
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
 
253
<li class="listitem"><p>The mnemonic key activates the object if it is presently enabled onscreen.
 
254
  This typically corresponds to the underlined letter within the widget.
 
255
  Example: "n" in a traditional "New..." menu item or the "a" in "Apply" for
 
256
  a button.</p></li>
 
257
<li class="listitem"><p>The sequence is the full list of keys which invoke the action even if the
 
258
  relevant element is not currently shown on screen. For instance, for a menu
 
259
  item the sequence is the keybindings used to open the parent menus before
 
260
  invoking. The sequence string is colon-delimited. Example: "Alt+F:N" in a
 
261
  traditional "New..." menu item.</p></li>
 
262
<li class="listitem"><p>The shortcut, if it exists, will invoke the same action without showing
 
263
  the component or its enclosing menus or dialogs. Example: "Ctrl+N" in a
 
264
  traditional "New..." menu item.</p></li>
 
265
</ul></div>
 
266
<p>
 
267
</p>
 
268
<p>
 
269
Example: For a traditional "New..." menu item, the expected return value
 
270
would be: "N;Alt+F:N;Ctrl+N" for the English locale and "N;Alt+D:N;Strg+N"
 
271
for the German locale. If, hypothetically, this menu item lacked a mnemonic,
 
272
it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively.
279
273
</p>
280
274
<div class="variablelist"><table border="0">
281
275
<col align="left" valign="top">
282
276
<tbody>
283
277
<tr>
284
278
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
285
 
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkActionIface</td>
 
279
<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td>
286
280
</tr>
287
281
<tr>
288
282
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
290
284
</tr>
291
285
<tr>
292
286
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
293
 
<td>a string representing the available keybindings, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
287
<td>the keybinding which can be used to activate this action, or <a href="/opt/gnome3/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
294
288
if there is no keybinding for this action.</td>
295
289
</tr>
296
290
</tbody>
299
293
<hr>
300
294
<div class="refsect2">
301
295
<a name="atk-action-set-description"></a><h3>atk_action_set_description ()</h3>
302
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atk_action_set_description          (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
303
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>,
304
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *desc</code></em>);</pre>
 
296
<pre class="programlisting"><span class="returnvalue">gboolean</span>            atk_action_set_description          (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>,
 
297
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>,
 
298
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *desc</code></em>);</pre>
305
299
<p>
306
300
Sets a description of the specified action of the object.
307
301
</p>
310
304
<tbody>
311
305
<tr>
312
306
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
313
 
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkActionIface</td>
 
307
<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td>
314
308
</tr>
315
309
<tr>
316
310
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
331
325
</div>
332
326
<div class="footer">
333
327
<hr>
334
 
          Generated by GTK-Doc V1.18</div>
 
328
          Generated by GTK-Doc V1.18.1</div>
335
329
</body>
336
330
</html>
 
 
b'\\ No newline at end of file'