1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/*
* AT-SPI - Assistive Technology Service Provider Interface
* (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
*
* Copyright 2001, 2002 Sun Microsystems Inc.,
* Copyright 2001, 2002 Ximian, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#include "atspi-private.h"
/**
* atspi_action_get_n_actions:
* @obj: a pointer to the #AtspiAction to query.
*
* Get the number of actions invokable on an #AtspiAction implementor.
*
* Returns: an integer indicating the number of invocable actions.
**/
gint
atspi_action_get_n_actions (AtspiAction *obj, GError **error)
{
dbus_int32_t retval = 0;
g_return_val_if_fail (obj != NULL, -1);
_atspi_dbus_get_property (obj, atspi_interface_action, "NActions", error, "i", &retval);
return retval;
}
/**
* atspi_action_get_description: (rename-to atspi_action_get_action_description)
* @obj: a pointer to the #AtspiAction implementor to query.
* @i: an integer indicating which action to query.
*
* Get the description of '@i-th' action invocable on an
* object implementing #AtspiAction.
*
* Returns: a UTF-8 string describing the '@i-th' invocable action.
*
* Deprecated: 2.10: Use atspi_action_get_action_description instead.
**/
gchar *
atspi_action_get_description (AtspiAction *obj, int i, GError **error)
{
return atspi_action_get_action_description (obj, i, error);
}
/**
* atspi_action_get_action_description:
* @obj: a pointer to the #AtspiAction implementor to query.
* @i: an integer indicating which action to query.
*
* Get the description of '@i-th' action invocable on an
* object implementing #AtspiAction.
*
* Returns: a UTF-8 string describing the '@i-th' invocable action.
**/
gchar *
atspi_action_get_action_description (AtspiAction *obj, int i, GError **error)
{
dbus_int32_t d_i = i;
char *retval = NULL;
g_return_val_if_fail (obj != NULL, NULL);
_atspi_dbus_call (obj, atspi_interface_action, "GetDescription", error, "i=>s", d_i, &retval);
return retval;
}
/**
* atspi_action_get_key_binding:
* @obj: a pointer to the #AtspiAction implementor to query.
* @i: an integer indicating which action to query.
*
* Get the keybindings for the @i-th action invocable on an
* object implementing #AtspiAction, 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 gtk_accelerator_name() in
* gtk+-2.X.
*
* Returns: a UTF-8 string which can be parsed to determine the @i-th
* invocable action's keybindings.
**/
gchar *
atspi_action_get_key_binding (AtspiAction *obj, gint i, GError **error)
{
dbus_int32_t d_i = i;
char *retval = NULL;
g_return_val_if_fail (obj != NULL, NULL);
_atspi_dbus_call (obj, atspi_interface_action, "GetKeyBinding", error, "i=>s", d_i, &retval);
return retval;
}
/**
* atspi_action_get_name: (rename-to atspi_action_get_action_name)
* @obj: a pointer to the #AtspiAction implementor to query.
* @i: an integer indicating which action to query.
*
* Get the name of the '@i-th' action invocable on an
* object implementing #AtspiAction.
*
* Returns: the non-localized name of the action, as a UTF-8 string.
*
* Deprecated: 2.10: Use atspi_action_get_action_name instead.
**/
gchar *
atspi_action_get_name (AtspiAction *obj, gint i, GError **error)
{
return atspi_action_get_action_name (obj, i, error);
}
/**
* atspi_action_get_action_name:
* @obj: a pointer to the #AtspiAction implementor to query.
* @i: an integer indicating which action to query.
*
* Get the name of the '@i-th' action invocable on an
* object implementing #AtspiAction.
*
* Returns: the non-localized name of the action, as a UTF-8 string.
**/
gchar *
atspi_action_get_action_name (AtspiAction *obj, gint i, GError **error)
{
dbus_int32_t d_i = i;
char *retval = NULL;
g_return_val_if_fail (obj != NULL, NULL);
_atspi_dbus_call (obj, atspi_interface_action, "GetName", error, "i=>s", d_i, &retval);
return retval;
}
/**
* atspi_action_get_localized_name:
* @obj: a pointer to the #AtspiAction implementor to query.
* @i: an integer indicating which action to query.
*
* Get the name of the '@i-th' action invocable on an
* object implementing #AtspiAction.
*
* Returns: the name of the action, as a UTF-8 string.
**/
gchar *
atspi_action_get_localized_name (AtspiAction *obj, gint i, GError **error)
{
dbus_int32_t d_i = i;
char *retval = NULL;
g_return_val_if_fail (obj != NULL, NULL);
_atspi_dbus_call (obj, atspi_interface_action, "GetLocalizedName", error,
"i=>s", d_i, &retval);
return retval;
}
/**
* atspi_action_do_action:
* @obj: a pointer to the #AtspiAction to query.
* @i: an integer specifying which action to invoke.
*
* Invoke the action indicated by #index.
*
* Returns: #TRUE if the action is successfully invoked, otherwise #FALSE.
**/
gboolean
atspi_action_do_action (AtspiAction *obj, gint i, GError **error)
{
dbus_int32_t d_i = i;
dbus_bool_t retval = FALSE;
g_return_val_if_fail (obj != NULL, FALSE);
_atspi_dbus_call (obj, atspi_interface_action, "DoAction", error, "i=>b", d_i, &retval);
return retval;
}
static void
atspi_action_base_init (AtspiAction *klass)
{
}
GType
atspi_action_get_type (void)
{
static GType type = 0;
if (!type)
{
static const GTypeInfo tinfo = {
sizeof (AtspiAction),
(GBaseInitFunc) atspi_action_base_init,
(GBaseFinalizeFunc) NULL,
};
type = g_type_register_static (G_TYPE_INTERFACE, "AtspiAction", &tinfo, 0);
}
return type;
}
|
