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