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      * @index: an %in parameter specifying the index of the action
  38      *   for which a description is desired.
  39      *
  40      * Gets the description of the specified action.
  41      *
  42      * return values: a @wstring containing the description of the specified action.
  43      *
  44      **/
  45     string getDescription (in long index);
  46
  47     /**
  48      * getName:
  49      * @index: an %in parameter specifying the index of the action
  50      *   whose name is requested.
  51      *
  52      * Gets the name of the specified action.
  53      *
  54      * return values: a @string containing the name of the specified action.
  55      *
  56      **/
  57     string getName (in long index);
  58
  59     /**
  60      * doAction:
  61      * @index: an %in parameter specifying the 0-based index of the action to perform.
  62      *
  63      * Causes the object to perform the specified action.
  64      *
  65      * return values: a @boolean indicating success or failure.
  66      *
  67      **/
  68     void doAction (in long index);
  69
  70     /**
  71      * getKeyBinding:
  72      * return values: a @string containing the key binding for the specified action,
  73      *   "" if none exists.
  74      * @index: an %in parameter specifying the 0-based index of the action
  75      *   for which a key binding is requested.
  76      *
  77      * Gets the key binding associated with a specific action.
  78      *
  79      **/
  80     string getKeyBinding (in long index);
  81   };
  82 };