2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001 Sun Microsystems Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 #include <cspi/spi-private.h>
26 * AccessibleAction_ref:
27 * @obj: a pointer to the #AccessibleAction on which to operate.
29 * Increment the reference count for an #AccessibleAction.
32 AccessibleAction_ref (AccessibleAction *obj)
34 cspi_object_ref (obj);
38 * AccessibleAction_unref:
39 * @obj: a pointer to the #AccessibleAction on which to operate.
41 * Decrement the reference count for an #AccessibleAction.
44 AccessibleAction_unref (AccessibleAction *obj)
46 cspi_object_unref (obj);
50 * AccessibleAction_getNActions:
51 * @obj: a pointer to the #AccessibleAction to query.
53 * Get the number of actions invokable on an #AccessibleAction implementor.
55 * Returns: a #long integer indicatin the number of invokable actions.
58 AccessibleAction_getNActions (AccessibleAction *obj)
62 cspi_return_val_if_fail (obj != NULL, -1);
65 Accessibility_Action__get_nActions (CSPI_OBJREF (obj), cspi_ev ());
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,
87 cspi_return_val_if_fail (obj != NULL, NULL);
90 Accessibility_Action_getDescription (CSPI_OBJREF (obj),
94 cspi_return_val_if_ev ("getDescription", NULL);
100 * AccessibleAction_getKeyBinding:
101 * @obj: a pointer to the #AccessibleAction implementor to query.
102 * @i: a long integer indicating which action to query.
104 * Get the keybindings for the @i-th action invokable on an
105 * object implementing #AccessibleAction, if any are defined.
107 * Returns: a UTF-8 string which can be parsed to determine the @i-th
108 * invokable action's keybindings.
111 AccessibleAction_getKeyBinding (AccessibleAction *obj,
116 cspi_return_val_if_fail (obj != NULL, NULL);
119 Accessibility_Action_getKeyBinding (CSPI_OBJREF (obj),
123 cspi_return_val_if_ev ("getKeyBinding", NULL);
129 * AccessibleAction_getName:
130 * @obj: a pointer to the #AccessibleAction implementor to query.
131 * @i: a long integer indicating which action to query.
133 * Get the name of the '@i-th' action invokable on an
134 * object implementing #AccessibleAction.
136 * Returns: the 'event type' name of the action, as a UTF-8 string.
139 AccessibleAction_getName (AccessibleAction *obj,
144 cspi_return_val_if_fail (obj != NULL, NULL);
147 Accessibility_Action_getName (CSPI_OBJREF (obj),
151 cspi_return_val_if_ev ("getName", NULL);
157 * AccessibleAction_doAction:
158 * @obj: a pointer to the #AccessibleAction to query.
159 * @i: an integer specifying which action to invoke.
161 * Invoke the action indicated by #index.
163 * Returns: #TRUE if the action is successfully invoked, otherwise #FALSE.
166 AccessibleAction_doAction (AccessibleAction *obj,
171 cspi_return_val_if_fail (obj != NULL, FALSE);
173 retval = (SPIBoolean)
174 Accessibility_Action_doAction (CSPI_OBJREF (obj),
178 cspi_return_val_if_ev ("doAction", FALSE);