← Back to branch summary

~ubuntu-branches/ubuntu/lucid/at-spi/lucid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/cspi/xml/spi_action.xml

  • Committer: Bazaar Package Importer
  • Author(s): Luke Yelavich
  • Date: 2010-07-02 15:50:32 UTC
  • mfrom: (1.2.1 upstream) (0.1.2 experimental)
  • Revision ID: james.westby@ubuntu.com-20100702155032-mw7vioq2owm3a809
Tags: 1.30.1-0ubuntu1
https://launchpad.net/bugs/600906
* New upstream release (LP: #600906)
  -  Fixes GNOME bugzilla #538680, collection.getMatchesTo() seems to ignore
     the count.
  - Updated translations:

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/cspi/xml/spi_action.xml
1
 
<refentry id="at-spi-cspi-AccessibleAction-Interface">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="at-spi-cspi-AccessibleAction-Interface.top_of_page">AccessibleAction Interface</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>AT-SPI-CSPI Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>AccessibleAction Interface</refname>
10
 
<refpurpose>The interface implemented by interface elements which are 'actionable' by the
11
 
user.</refpurpose>
12
 
</refnamediv>
13
 
 
14
 
<refsynopsisdiv id="at-spi-cspi-AccessibleAction-Interface.synopsis" role="synopsis">
15
 
<title role="synopsis.title">Synopsis</title>
16
 
 
17
 
<synopsis>
18
 
<link linkend="void">void</link>                <link linkend="AccessibleAction-ref">AccessibleAction_ref</link>                (<link linkend="AccessibleAction">AccessibleAction</link> *obj);
19
 
<link linkend="void">void</link>                <link linkend="AccessibleAction-unref">AccessibleAction_unref</link>              (<link linkend="AccessibleAction">AccessibleAction</link> *obj);
20
 
<link linkend="long">long</link>                <link linkend="AccessibleAction-getNActions">AccessibleAction_getNActions</link>        (<link linkend="AccessibleAction">AccessibleAction</link> *obj);
21
 
<link linkend="SPIBoolean">SPIBoolean</link>          <link linkend="AccessibleAction-doAction">AccessibleAction_doAction</link>           (<link linkend="AccessibleAction">AccessibleAction</link> *obj,
22
 
                                                         long <link linkend="int">int</link> i);
23
 
<link linkend="char">char</link> *              <link linkend="AccessibleAction-getKeyBinding">AccessibleAction_getKeyBinding</link>      (<link linkend="AccessibleAction">AccessibleAction</link> *obj,
24
 
                                                         long <link linkend="int">int</link> i);
25
 
<link linkend="char">char</link> *              <link linkend="AccessibleAction-getName">AccessibleAction_getName</link>            (<link linkend="AccessibleAction">AccessibleAction</link> *obj,
26
 
                                                         long <link linkend="int">int</link> i);
27
 
<link linkend="char">char</link> *              <link linkend="AccessibleAction-getDescription">AccessibleAction_getDescription</link>     (<link linkend="AccessibleAction">AccessibleAction</link> *obj,
28
 
                                                         long <link linkend="int">int</link> i);
29
 
</synopsis>
30
 
</refsynopsisdiv>
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
<refsect1 id="at-spi-cspi-AccessibleAction-Interface.description" role="desc">
41
 
<title role="desc.title">Description</title>
42
 
<para>
43
 
The Action interface is implemented by objects with which the user may
44
 
interact using common graphical-user-interface metaphors such as "click",
45
 
"toggle", "activate", and other gestures which are usually invoked via
46
 
interaction with the system pointer or keyboard.  The Action interface allows
47
 
clients and/or assistive technologies to expose these actions to the end user
48
 
for invocation via alternative mechanisms, and to inform the end user or
49
 
assistive technology client that the implementing Accessible object is
50
 
reactive to user input.
51
 
</para>
52
 
</refsect1>
53
 
 
54
 
<refsect1 id="at-spi-cspi-AccessibleAction-Interface.details" role="details">
55
 
<title role="details.title">Details</title>
56
 
<refsect2 id="AccessibleAction-ref" role="function">
57
 
<title>AccessibleAction_ref ()</title>
58
 
<indexterm zone="AccessibleAction-ref"><primary sortas="AccessibleAction_ref">AccessibleAction_ref</primary></indexterm><programlisting><link linkend="void">void</link>                AccessibleAction_ref                (<link linkend="AccessibleAction">AccessibleAction</link> *obj);</programlisting>
59
 
<para>
60
 
Increment the reference count for an <link linkend="AccessibleAction"><type>AccessibleAction</type></link>.</para>
61
 
<para>
62
 
</para><variablelist role="params">
63
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
64
 
<listitem><simpara> a pointer to the <link linkend="AccessibleAction"><type>AccessibleAction</type></link> on which to operate.
65
 
</simpara></listitem></varlistentry>
66
 
</variablelist></refsect2>
67
 
<refsect2 id="AccessibleAction-unref" role="function">
68
 
<title>AccessibleAction_unref ()</title>
69
 
<indexterm zone="AccessibleAction-unref"><primary sortas="AccessibleAction_unref">AccessibleAction_unref</primary></indexterm><programlisting><link linkend="void">void</link>                AccessibleAction_unref              (<link linkend="AccessibleAction">AccessibleAction</link> *obj);</programlisting>
70
 
<para>
71
 
Decrement the reference count for an <link linkend="AccessibleAction"><type>AccessibleAction</type></link>.</para>
72
 
<para>
73
 
</para><variablelist role="params">
74
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
75
 
<listitem><simpara> a pointer to the <link linkend="AccessibleAction"><type>AccessibleAction</type></link> on which to operate.
76
 
</simpara></listitem></varlistentry>
77
 
</variablelist></refsect2>
78
 
<refsect2 id="AccessibleAction-getNActions" role="function">
79
 
<title>AccessibleAction_getNActions ()</title>
80
 
<indexterm zone="AccessibleAction-getNActions"><primary sortas="AccessibleAction_getNActions">AccessibleAction_getNActions</primary></indexterm><programlisting><link linkend="long">long</link>                AccessibleAction_getNActions        (<link linkend="AccessibleAction">AccessibleAction</link> *obj);</programlisting>
81
 
<para>
82
 
Get the number of actions invokable on an <link linkend="AccessibleAction"><type>AccessibleAction</type></link> implementor.</para>
83
 
<para>
84
 
</para><variablelist role="params">
85
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
86
 
<listitem><simpara> a pointer to the <link linkend="AccessibleAction"><type>AccessibleAction</type></link> to query.
87
 
</simpara></listitem></varlistentry>
88
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="long"><type>long</type></link> integer indicatin the number of invokable actions.
89
 
</simpara></listitem></varlistentry>
90
 
</variablelist></refsect2>
91
 
<refsect2 id="AccessibleAction-doAction" role="function">
92
 
<title>AccessibleAction_doAction ()</title>
93
 
<indexterm zone="AccessibleAction-doAction"><primary sortas="AccessibleAction_doAction">AccessibleAction_doAction</primary></indexterm><programlisting><link linkend="SPIBoolean">SPIBoolean</link>          AccessibleAction_doAction           (<link linkend="AccessibleAction">AccessibleAction</link> *obj,
94
 
                                                         long <link linkend="int">int</link> i);</programlisting>
95
 
<para>
96
 
Invoke the action indicated by <link linkend="index"><type>index</type></link>.</para>
97
 
<para>
98
 
</para><variablelist role="params">
99
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
100
 
<listitem><simpara> a pointer to the <link linkend="AccessibleAction"><type>AccessibleAction</type></link> to query.
101
 
</simpara></listitem></varlistentry>
102
 
<varlistentry><term><parameter>i</parameter>&#160;:</term>
103
 
<listitem><simpara> an integer specifying which action to invoke.
104
 
</simpara></listitem></varlistentry>
105
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><type>TRUE</type></link> if the action is successfully invoked, otherwise <link linkend="FALSE--CAPS"><type>FALSE</type></link>.
106
 
</simpara></listitem></varlistentry>
107
 
</variablelist></refsect2>
108
 
<refsect2 id="AccessibleAction-getKeyBinding" role="function">
109
 
<title>AccessibleAction_getKeyBinding ()</title>
110
 
<indexterm zone="AccessibleAction-getKeyBinding"><primary sortas="AccessibleAction_getKeyBinding">AccessibleAction_getKeyBinding</primary></indexterm><programlisting><link linkend="char">char</link> *              AccessibleAction_getKeyBinding      (<link linkend="AccessibleAction">AccessibleAction</link> *obj,
111
 
                                                         long <link linkend="int">int</link> i);</programlisting>
112
 
<para>
113
 
Get the keybindings for the <parameter>i</parameter>-th action invokable on an
114
 
     object implementing <link linkend="AccessibleAction"><type>AccessibleAction</type></link>, if any are defined.
115
 
     The keybindings string format is as follows:
116
 
       there are multiple parts to a keybinding string (typically 3).
117
 
       They are delimited with ";".  The first is the action's
118
 
       keybinding which is usable if the object implementing the action
119
 
       is currently posted to the screen, e.g. if a menu is posted 
120
 
       then these keybindings for the corresponding menu-items are
121
 
       available.  The second keybinding substring is the full key sequence
122
 
       necessary to post the action's widget and activate it, e.g. for
123
 
       a menu item such as "File-&gt;Open" it would both post the menu and
124
 
       activate the item.  Thus the second keybinding string is available
125
 
       during the lifetime of the containing toplevel window as a whole,
126
 
       whereas the first keybinding string only works while the object
127
 
       implementing AtkAction is posted.  The third (and optional)
128
 
       keybinding string is the "keyboard shortcut" which invokes the 
129
 
       action without posting any menus. 
130
 
       Meta-keys are indicated by the conventional strings
131
 
       "&lt;Control&gt;", "&lt;Alt&gt;", "&lt;Shift&gt;", "&lt;Mod2&gt;",
132
 
       etc. (we use the same string as <link linkend="gtk-accelerator-name"><function>gtk_accelerator_name()</function></link> in 
133
 
       gtk+-2.X.</para>
134
 
<para>
135
 
</para><variablelist role="params">
136
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
137
 
<listitem><simpara> a pointer to the <link linkend="AccessibleAction"><type>AccessibleAction</type></link> implementor to query.
138
 
</simpara></listitem></varlistentry>
139
 
<varlistentry><term><parameter>i</parameter>&#160;:</term>
140
 
<listitem><simpara> a long integer indicating which action to query.
141
 
</simpara></listitem></varlistentry>
142
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a UTF-8 string which can be parsed to determine the <parameter>i</parameter>-th
143
 
      invokable action's keybindings.
144
 
</simpara></listitem></varlistentry>
145
 
</variablelist></refsect2>
146
 
<refsect2 id="AccessibleAction-getName" role="function">
147
 
<title>AccessibleAction_getName ()</title>
148
 
<indexterm zone="AccessibleAction-getName"><primary sortas="AccessibleAction_getName">AccessibleAction_getName</primary></indexterm><programlisting><link linkend="char">char</link> *              AccessibleAction_getName            (<link linkend="AccessibleAction">AccessibleAction</link> *obj,
149
 
                                                         long <link linkend="int">int</link> i);</programlisting>
150
 
<para>
151
 
Get the name of the '<parameter>i</parameter>-th' action invokable on an
152
 
     object implementing <link linkend="AccessibleAction"><type>AccessibleAction</type></link>.</para>
153
 
<para>
154
 
</para><variablelist role="params">
155
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
156
 
<listitem><simpara> a pointer to the <link linkend="AccessibleAction"><type>AccessibleAction</type></link> implementor to query.
157
 
</simpara></listitem></varlistentry>
158
 
<varlistentry><term><parameter>i</parameter>&#160;:</term>
159
 
<listitem><simpara> a long integer indicating which action to query.
160
 
</simpara></listitem></varlistentry>
161
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the 'event type' name of the action, as a UTF-8 string.
162
 
</simpara></listitem></varlistentry>
163
 
</variablelist></refsect2>
164
 
<refsect2 id="AccessibleAction-getDescription" role="function">
165
 
<title>AccessibleAction_getDescription ()</title>
166
 
<indexterm zone="AccessibleAction-getDescription"><primary sortas="AccessibleAction_getDescription">AccessibleAction_getDescription</primary></indexterm><programlisting><link linkend="char">char</link> *              AccessibleAction_getDescription     (<link linkend="AccessibleAction">AccessibleAction</link> *obj,
167
 
                                                         long <link linkend="int">int</link> i);</programlisting>
168
 
<para>
169
 
Get the description of '<parameter>i</parameter>-th' action invokable on an
170
 
     object implementing <link linkend="AccessibleAction"><type>AccessibleAction</type></link>.</para>
171
 
<para>
172
 
</para><variablelist role="params">
173
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
174
 
<listitem><simpara> a pointer to the <link linkend="AccessibleAction"><type>AccessibleAction</type></link> implementor to query.
175
 
</simpara></listitem></varlistentry>
176
 
<varlistentry><term><parameter>i</parameter>&#160;:</term>
177
 
<listitem><simpara> a long integer indicating which action to query.
178
 
</simpara></listitem></varlistentry>
179
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a UTF-8 string describing the '<parameter>i</parameter>-th' invokable action.
180
 
</simpara></listitem></varlistentry>
181
 
</variablelist></refsect2>
182
 
 
183
 
</refsect1>
184
 
 
185
 
 
186
 
 
187
 
 
188
 
</refentry>