idl/action.didl

   1
   2 /*
   3   An interface through which a user-actionable UI component can be manipulated.
   4
   5   Typical actions include "click", "press", "release" or "open".
   6 */
   7 interface org.freestandards.atspi.Action {
   8         /*
   9           Represents a single action.
  10         */
  11         struct Action {
  12                 /* String containing short description of action. */
  13                 string name;
  14                 /* The description of an action may provide information about the result. */
  15                 string description;
  16                 /* A string containing the key-binding or "" if none exists */
  17                 string key_binding;
  18         }
  19
  20         property read int32 NActions;
  21
  22         /* Get the description for the specified action. */
  23         method GetDescription {
  24                 int32 index;
  25         } reply {
  26                 string description
  27         }
  28
  29         /* Get the name of the specified action */
  30         method GetName {
  31                 int32 index;
  32         } reply {
  33                 string name;
  34         }
  35
  36         method GetLocalizedName {
  37                 int32 index;
  38         } reply {
  39                 string name;
  40         }
  41
  42         /* Get the key-binding for the specified action. */
  43         method GetKeyBinding {
  44                 int32 index;
  45         } reply {
  46                 string key_binding;
  47         }
  48
  49         /* Retrieves the actions associated with the object. */
  50         method GetActions reply {
  51                 Action actions [];
  52         }
  53
  54         /* Causes the object to perform the specified action. */
  55         method GetActions {
  56                 int32 index;
  57         } reply {
  58                 boolean success;
  59         }
  60 }