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 module Accessibility {
25 interface Action : Bonobo::Unknown {
28 * nActions: a @long containing the number of actions this object supports.
31 readonly attribute long nActions;
35 * @index: an %in parameter specifying the index of the action
36 * for which a description is desired.
38 * Gets the description of the specified action.
40 * Returns: a @wstring containing the description of the specified action.
43 string getDescription (in long index);
47 * @index: an %in parameter specifying the index of the action
48 * whose name is requested.
50 * Gets the name of the specified action.
52 * Returns: a @string containing the name of the specified action.
55 string getName (in long index);
59 * @index: an %in parameter specifying the 0-based index of the action to perform.
61 * Causes the object to perform the specified action.
63 * Returns: a @boolean indicating success or failure.
66 boolean doAction (in long index);
70 * @index: an %in parameter specifying the 0-based index of the action
71 * for which a key binding is requested.
73 * Gets the key binding associated with a specific action.
75 * Returns: a @string containing the key binding for the specified action,
78 string getKeyBinding (in long index);
83 * placeholders for future expansion.
85 void unImplemented ();
86 void unImplemented2 ();
87 void unImplemented3 ();
88 void unImplemented4 ();