66fbef7603816f5ec11098813c9712ac230d6015
[platform/upstream/at-spi2-core.git] / idl / selection.didl
1
2 /*
3   An interface which indicates that an object exposes a 'selection' model,
4   allowing the 'selection' of one or more of its children.
5 */
6 interface org.freestandards.atspi.Selection {
7         /* The number of children that are currently selected. */
8         read property int32 NSelectedChildren;
9
10         /* Gets the ith SELECTED child. This is different to the index of all children. */
11         method GetSelectedChild {
12                 int32 index;
13         } reply {
14                 Reference child;
15         }
16
17         /* Select the child, add it to the list of selected children. */ 
18         method SelectChild {
19                 int32 index;
20         } reply {
21                 boolean success;
22         }
23
24         /* Deselect a child. The index refers to the index into the list of selected children. */
25         method DeselectSelectedChild {
26                 int32 index;
27         } reply {
28                 boolean success;
29         }
30
31         /* Determine whether a particular child is currently selected. */
32         method IsChildSelected {
33                 int32 index;
34         } reply {
35                 boolean selected;
36         }
37
38         /* Apptemt to select all of the containers children. */
39         method SelectAll reply {
40                 boolean success;
41         }
42
43         /* Attempt to deselect all selected children. */
44         method ClearSelection reply {
45                 boolean success;
46         }
47
48         /* Deselect a child. The index refers to the index into the list of all children. */
49         method DeselectChild {
50                 int32 index;
51         } reply {
52                 boolean success;
53         }
54 }