Release v1.91.4
[platform/upstream/at-spi2-core.git] / 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         /* Get the key-binding for the specified action. */
37         method GetKeyBinding {
38                 int32 index;
39         } reply {
40                 string key_binding;
41         }
42
43         /* Retrieves the actions associated with the object. */
44         method GetActions reply {
45                 Action actions [];
46         }
47
48         /* Causes the object to perform the specified action. */
49         method GetActions {
50                 int32 index;
51         } reply {
52                 boolean success;
53         }       
54 }