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.1 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
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">
17
<td><a accesskey="p" href="atk.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="atk.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">ATK - Accessibility Toolkit</th>
21
<td><a accesskey="n" href="AtkComponent.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#AtkAction.synopsis" class="shortcut">Top</a>
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
16
<td width="100%" align="left">
17
<a href="#" class="shortcut">Top</a>
26
19
<a href="#AtkAction.description" class="shortcut">Description</a>
28
21
<a href="#AtkAction.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
23
<a href="#AtkAction.implementations" class="shortcut">Known Implementations</a>
25
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
26
<td><a accesskey="u" href="atk.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
27
<td><a accesskey="p" href="atk.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
28
<td><a accesskey="n" href="AtkComponent.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
33
30
<div class="refentry">
34
31
<a name="AtkAction"></a><div class="titlepage"></div>
35
32
<div class="refnamediv"><table width="100%"><tr>
37
34
<h2><span class="refentrytitle"><a name="AtkAction.top_of_page"></a>AtkAction</span></h2>
38
<p>AtkAction — The ATK interface provided by UI components which the user can
39
activate/interact with,</p>
35
<p>AtkAction — The ATK interface provided by UI components
36
which the user can activate/interact with.</p>
41
38
<td valign="top" align="right"></td>
42
39
</tr></table></div>
43
40
<div class="refsynopsisdiv">
44
41
<a name="AtkAction.synopsis"></a><h2>Synopsis</h2>
45
42
<pre class="synopsis"> <a class="link" href="AtkAction.html#AtkAction-struct" title="AtkAction">AtkAction</a>;
43
struct <a class="link" href="AtkAction.html#AtkActionIface" title="struct AtkActionIface">AtkActionIface</a>;
46
44
<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
45
<em class="parameter"><code><span class="type">gint</span> i</code></em>);
48
46
<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>);
75
73
<div class="refsect1">
76
74
<a name="AtkAction.description"></a><h2>Description</h2>
78
<a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> should be implemented by instances of <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> classes with
79
which the user can interact directly, i.e. buttons, checkboxes,
80
scrollbars, e.g. components which are not "passive"
76
<a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> should be implemented by instances of <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> classes
77
with which the user can interact directly, i.e. buttons,
78
checkboxes, scrollbars, e.g. components which are not "passive"
81
79
providers of UI information.
84
Exceptions: when the user interaction is already covered by
85
another appropriate interface such as <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> (insert/delete
86
text, etc.) or <a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> (set value) then these actions should not be
82
Exceptions: when the user interaction is already covered by another
83
appropriate interface such as <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> (insert/delete text,
84
etc.) or <a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> (set value) then these actions should not be
87
85
exposed by <a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> as well.
90
Also note that the <a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> API is limited in that parameters may not
91
be passed to the object being activated; thus the action must be
92
self-contained and specifiable via only a single "verb". Concrete
93
examples include "press", "release", "click" for buttons, "drag"
94
(meaning initiate drag) and "drop" for drag sources and drop targets,
98
88
Though most UI interactions on components should be invocable via
99
89
keyboard as well as mouse, there will generally be a close mapping
100
90
between "mouse actions" that are possible on a component and the
101
AtkActions. Where mouse and keyboard actions are redundant in effect,
102
<a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> should expose only one action rather than exposing redundant
103
actions if possible. By convention we have been using "mouse centric"
104
terminology for <a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> names.
91
AtkActions. Where mouse and keyboard actions are redundant in
92
effect, <a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> should expose only one action rather than
93
exposing redundant actions if possible. By convention we have been
94
using "mouse centric" terminology for <a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> names.
107
97
<div class="refsect1">
110
100
<a name="AtkAction-struct"></a><h3>AtkAction</h3>
111
101
<pre class="programlisting">typedef struct _AtkAction AtkAction;</pre>
113
The AtkAction structure does not contain any fields.
106
<div class="refsect2">
107
<a name="AtkActionIface"></a><h3>struct AtkActionIface</h3>
108
<pre class="programlisting">struct AtkActionIface {
109
GTypeInterface parent;
111
gboolean (*do_action) (AtkAction *action,
113
gint (*get_n_actions) (AtkAction *action);
114
const gchar* (*get_description) (AtkAction *action,
116
const gchar* (*get_name) (AtkAction *action,
118
const gchar* (*get_keybinding) (AtkAction *action,
120
gboolean (*set_description) (AtkAction *action,
123
const gchar* (*get_localized_name)(AtkAction *action,
169
183
<a name="atk-action-get-description"></a><h3>atk_action_get_description ()</h3>
170
184
<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
185
<em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
187
Returns a description of the specified action of the object.
172
189
<div class="variablelist"><table border="0">
173
190
<col align="left" valign="top">
184
201
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
185
<td>a description string, or <code class="literal">NULL</code>
186
if <em class="parameter"><code>action</code></em> does not implement this interface.</td>
202
<td>a description string, or <code class="literal">NULL</code> if <em class="parameter"><code>action</code></em> does not
203
implement this interface.</td>
193
210
<a name="atk-action-get-name"></a><h3>atk_action_get_name ()</h3>
194
211
<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
212
<em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
214
Returns a non-localized string naming the specified action of the
215
object. This name is generally not descriptive of the end result
216
of the action, but instead names the 'interaction type' which the
217
object supports. By convention, the above strings should be used to
218
represent the actions which correspond to the common point-and-click
219
interaction techniques of the same name: i.e.
220
"click", "press", "release", "drag", "drop", "popup", etc.
221
The "popup" action should be used to pop up a context menu for the
222
object, if one exists.
225
For technical reasons, some toolkits cannot guarantee that the
226
reported action is actually 'bound' to a nontrivial user event;
227
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
196
230
<div class="variablelist"><table border="0">
197
231
<col align="left" valign="top">
217
251
<a name="atk-action-get-localized-name"></a><h3>atk_action_get_localized_name ()</h3>
218
252
<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
253
<em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
255
Returns the localized name of the specified action of the object.
220
257
<div class="variablelist"><table border="0">
221
258
<col align="left" valign="top">
286
323
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
287
<td>the keybinding which can be used to activate this action, or <code class="literal">NULL</code>
288
if there is no keybinding for this action.</td>
324
<td>the keybinding which can be used to activate this action,
325
or <code class="literal">NULL</code> if there is no keybinding for this action.</td>
added
removed
docs/html/AtkAction.html
