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);
66 Accessibility_Action__get_nActions (CSPI_OBJREF (obj), cspi_ev ());
68 cspi_return_val_if_ev ("getNActions", -1);
74 * AccessibleAction_getDescription:
75 * @obj: a pointer to the #AccessibleAction implementor to query.
76 * @i: a long integer indicating which action to query.
78 * Get the description of '@i-th' action invokable on an
79 * object implementing #AccessibleAction.
81 * Returns: a UTF-8 string describing the '@i-th' invokable action.
84 AccessibleAction_getDescription (AccessibleAction *obj,
88 cspi_return_val_if_fail (obj != NULL, NULL);
91 Accessibility_Action_getDescription (CSPI_OBJREF (obj),
95 cspi_return_val_if_ev ("getDescription", NULL);
101 * AccessibleAction_getKeyBinding:
102 * @obj: a pointer to the #AccessibleAction implementor to query.
103 * @i: a long integer indicating which action to query.
105 * Get the keybindings for the @i-th action invokable on an
106 * object implementing #AccessibleAction, if any are defined.
107 * The keybindings string format is as follows:
108 * there are multiple parts to a keybinding string (typically 3).
109 * They are delimited with ";". The first is the action's
110 * keybinding which is usable if the object implementing the action
111 * is currently posted to the screen, e.g. if a menu is posted
112 * then these keybindings for the corresponding menu-items are
113 * available. The second keybinding substring is the full key sequence
114 * necessary to post the action's widget and activate it, e.g. for
115 * a menu item such as "File->Open" it would both post the menu and
116 * activate the item. Thus the second keybinding string is available
117 * during the lifetime of the containing toplevel window as a whole,
118 * whereas the first keybinding string only works while the object
119 * implementing AtkAction is posted. The third (and optional)
120 * keybinding string is the "keyboard shortcut" which invokes the
121 * action without posting any menus.
122 * Meta-keys are indicated by the conventional strings
123 * "<Control>", "<Alt>", "<Shift>", "<Mod2>",
124 * etc. (we use the same string as gtk_accelerator_name() in
127 * Returns: a UTF-8 string which can be parsed to determine the @i-th
128 * invokable action's keybindings.
131 AccessibleAction_getKeyBinding (AccessibleAction *obj,
136 cspi_return_val_if_fail (obj != NULL, NULL);
139 Accessibility_Action_getKeyBinding (CSPI_OBJREF (obj),
143 cspi_return_val_if_ev ("getKeyBinding", NULL);
149 * AccessibleAction_getName:
150 * @obj: a pointer to the #AccessibleAction implementor to query.
151 * @i: a long integer indicating which action to query.
153 * Get the name of the '@i-th' action invokable on an
154 * object implementing #AccessibleAction.
156 * Returns: the 'event type' name of the action, as a UTF-8 string.
159 AccessibleAction_getName (AccessibleAction *obj,
164 cspi_return_val_if_fail (obj != NULL, NULL);
167 Accessibility_Action_getName (CSPI_OBJREF (obj),
171 cspi_return_val_if_ev ("getName", NULL);
177 * AccessibleAction_doAction:
178 * @obj: a pointer to the #AccessibleAction to query.
179 * @i: an integer specifying which action to invoke.
181 * Invoke the action indicated by #index.
183 * Returns: #TRUE if the action is successfully invoked, otherwise #FALSE.
186 AccessibleAction_doAction (AccessibleAction *obj,
191 cspi_return_val_if_fail (obj != NULL, FALSE);
193 retval = Accessibility_Action_doAction (CSPI_OBJREF (obj),
197 cspi_return_val_if_ev ("doAction", FALSE);