2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2002 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 Ximian, Inc.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 #include <cspi/spi-private.h>
27 * AccessibleAction_ref:
28 * @obj: a pointer to the #AccessibleAction on which to operate.
30 * Increment the reference count for an #AccessibleAction.
33 AccessibleAction_ref (AccessibleAction *obj)
35 cspi_object_ref (obj);
39 * AccessibleAction_unref:
40 * @obj: a pointer to the #AccessibleAction on which to operate.
42 * Decrement the reference count for an #AccessibleAction.
45 AccessibleAction_unref (AccessibleAction *obj)
47 cspi_object_unref (obj);
51 * AccessibleAction_getNActions:
52 * @obj: a pointer to the #AccessibleAction to query.
54 * Get the number of actions invokable on an #AccessibleAction implementor.
56 * Returns: a #long integer indicatin the number of invokable actions.
59 AccessibleAction_getNActions (AccessibleAction *obj)
63 cspi_return_val_if_fail (obj != NULL, -1);
65 cspi_dbus_get_property (obj, spi_interface_action, "nActions", NULL, "i", &retval);
67 cspi_return_val_if_ev ("getNActions", -1);
73 * AccessibleAction_getDescription:
74 * @obj: a pointer to the #AccessibleAction implementor to query.
75 * @i: a long integer indicating which action to query.
77 * Get the description of '@i-th' action invokable on an
78 * object implementing #AccessibleAction.
80 * Returns: a UTF-8 string describing the '@i-th' invokable action.
83 AccessibleAction_getDescription (AccessibleAction *obj,
88 cspi_return_val_if_fail (obj != NULL, NULL);
90 cspi_dbus_call (obj, spi_interface_action, "getDescription", NULL, "i=>s", d_i, &retval);
92 cspi_return_val_if_ev ("getDescription", NULL);
98 * AccessibleAction_getKeyBinding:
99 * @obj: a pointer to the #AccessibleAction implementor to query.
100 * @i: a long integer indicating which action to query.
102 * Get the keybindings for the @i-th action invokable on an
103 * object implementing #AccessibleAction, if any are defined.
104 * The keybindings string format is as follows:
105 * there are multiple parts to a keybinding string (typically 3).
106 * They are delimited with ";". The first is the action's
107 * keybinding which is usable if the object implementing the action
108 * is currently posted to the screen, e.g. if a menu is posted
109 * then these keybindings for the corresponding menu-items are
110 * available. The second keybinding substring is the full key sequence
111 * necessary to post the action's widget and activate it, e.g. for
112 * a menu item such as "File->Open" it would both post the menu and
113 * activate the item. Thus the second keybinding string is available
114 * during the lifetime of the containing toplevel window as a whole,
115 * whereas the first keybinding string only works while the object
116 * implementing AtkAction is posted. The third (and optional)
117 * keybinding string is the "keyboard shortcut" which invokes the
118 * action without posting any menus.
119 * Meta-keys are indicated by the conventional strings
120 * "<Control>", "<Alt>", "<Shift>", "<Mod2>",
121 * etc. (we use the same string as gtk_accelerator_name() in
124 * Returns: a UTF-8 string which can be parsed to determine the @i-th
125 * invokable action's keybindings.
128 AccessibleAction_getKeyBinding (AccessibleAction *obj,
131 dbus_int32_t d_i = i;
133 cspi_return_val_if_fail (obj != NULL, NULL);
135 cspi_dbus_call (obj, spi_interface_action, "getKeyBinding", NULL, "i=>s", d_i, &retval);
137 cspi_return_val_if_ev ("getKeyBinding", NULL);
143 * AccessibleAction_getName:
144 * @obj: a pointer to the #AccessibleAction implementor to query.
145 * @i: a long integer indicating which action to query.
147 * Get the name of the '@i-th' action invokable on an
148 * object implementing #AccessibleAction.
150 * Returns: the 'event type' name of the action, as a UTF-8 string.
153 AccessibleAction_getName (AccessibleAction *obj,
156 dbus_int32_t d_i = i;
158 cspi_return_val_if_fail (obj != NULL, NULL);
160 cspi_dbus_call (obj, spi_interface_action, "getName", NULL, "i=>s", d_i, &retval);
162 cspi_return_val_if_ev ("getName", NULL);
168 * AccessibleAction_doAction:
169 * @obj: a pointer to the #AccessibleAction to query.
170 * @i: an integer specifying which action to invoke.
172 * Invoke the action indicated by #index.
174 * Returns: #TRUE if the action is successfully invoked, otherwise #FALSE.
177 AccessibleAction_doAction (AccessibleAction *obj,
180 dbus_int32_t d_i = i;
183 cspi_return_val_if_fail (obj != NULL, FALSE);
185 cspi_dbus_call (obj, spi_interface_action, "doAction", NULL, "i=>b", d_i, &retval);
187 cspi_return_val_if_ev ("doAction", FALSE);