idl/Accessibility_Action.idl

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001 Sun Microsystems, Inc.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  21  */
  22
  23 module Accessibility {
  24
  25   interface Action : Bonobo::Unknown {
  26
  27         /**
  28          * getNActions:
  29          * return values: a @long containing the number of actions this object supports.
  30          *
  31          * Returns the number of actions supported by this object.
  32          **/
  33         long getNActions ();
  34
  35         /**
  36          * getDescription:
  37          * return values: a @wstring containing the description of the specified action.
  38          * @index: an %in parameter specifying the index of the action
  39          *   for which a description is desired.
  40          *
  41          * Gets the description of the specified action.
  42          *
  43          **/
  44         string getDescription (in long index);
  45
  46         /**
  47          * doAction:
  48          * @index: an %in parameter specifying the 0-based index of the action to perform.
  49          *
  50          * Causes the object to perform the specified action.
  51          *
  52          **/
  53         void doAction (in long index);
  54
  55         /**
  56          * getKeyBinding:
  57          * return values: a @wstring containing the key binding for the specified action,
  58          *   "" if none exists.
  59          * @index: an %in parameter specifying the 0-based index of the action
  60          *   for which a key binding is requested.
  61          *
  62          * Gets the key binding associated with a specific action.
  63          *
  64          **/
  65         string getKeyBinding (in long index);
  66   };
  67
  68 };