Add selection interface
[platform/upstream/at-spi2-core.git] / atspi / atspi-selection.h
1 /*
2  * AT-SPI - Assistive Technology Service Provider Interface
3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
4  *
5  * Copyright 2002 Ximian, Inc.
6  *           2002 Sun Microsystems Inc.
7  *           
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public
20  * License along with this library; if not, write to the
21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22  * Boston, MA 02111-1307, USA.
23  */
24
25 #ifndef _ATSPI_SELECTION_H_
26 #define _ATSPI_SELECTION_H_
27
28 #include "glib-object.h"
29
30 #include "atspi-constants.h"
31
32 #include "atspi-types.h"
33
34 #define ATSPI_TYPE_SELECTION                    (atspi_selection_get_type ())
35 #define ATSPI_IS_SELECTION(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_SELECTION)
36 #define ATSPI_SELECTION(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_SELECTION, AtspiSelection)
37 #define ATSPI_SELECTION_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATSPI_TYPE_SELECTION, AtspiSelection))
38
39 GType atspi_selection_get_type ();
40
41 struct _AtspiSelection
42 {
43   GTypeInterface parent;
44 };
45
46 gint atspi_selection_get_n_selected_children (AtspiSelection *obj, GError **error);
47
48 AtspiAccessible * atspi_selection_get_selected_child (AtspiSelection *obj, gint selected_child_index, GError **error);
49
50 gboolean atspi_selection_select_child (AtspiSelection *obj, gint child_index, GError **error);
51
52 gboolean atspi_selection_deselect_selected_child (AtspiSelection *obj, gint selected_child_index, GError **error);
53
54 gboolean atspi_selection_deselect_child (AtspiSelection *obj, gint child_index, GError **error);
55
56 gboolean
57 atspi_selection_is_child_selected (AtspiSelection *obj,
58                                    gint child_index, GError **error);
59
60 gboolean atspi_selection_select_all (AtspiSelection *obj, GError **error);
61
62 gboolean atspi_selection_clear_selection (AtspiSelection *obj, GError **error);
63
64 #endif  /* _ATSPI_SELECTION_H_ */