Tizen 2.4 spin repo configuration
[platform/upstream/atk.git] / atk / atkselection.h
1 /* ATK -  Accessibility Toolkit
2  * Copyright 2001 Sun Microsystems Inc.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
21 #error "Only <atk/atk.h> can be included directly."
22 #endif
23
24 #ifndef __ATK_SELECTION_H__
25 #define __ATK_SELECTION_H__
26
27 #include <atk/atkobject.h>
28
29 G_BEGIN_DECLS
30
31 /*
32  * This AtkSelection interface provides the standard mechanism for an 
33  * assistive technology to determine what the current selected children are, 
34  * as well as modify the selection set. Any object that has children that 
35  * can be selected should support the AtkSelection interface.
36  */
37
38 #define ATK_TYPE_SELECTION                        (atk_selection_get_type ())
39 #define ATK_IS_SELECTION(obj)                     G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_SELECTION)
40 #define ATK_SELECTION(obj)                        G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_SELECTION, AtkSelection)
41 #define ATK_SELECTION_GET_IFACE(obj)              (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_SELECTION, AtkSelectionIface))
42
43 #ifndef _TYPEDEF_ATK_SELECTION_
44 #define _TYPEDEF_ATK_SELECTION_
45 typedef struct _AtkSelection AtkSelection;
46 #endif
47 typedef struct _AtkSelectionIface AtkSelectionIface;
48
49 struct _AtkSelectionIface
50 {
51   GTypeInterface parent;
52
53   gboolean     (* add_selection)        (AtkSelection   *selection,
54                                          gint           i);
55   gboolean     (* clear_selection)      (AtkSelection   *selection);
56   AtkObject*   (* ref_selection)        (AtkSelection   *selection,
57                                          gint           i);
58   gint         (* get_selection_count)  (AtkSelection   *selection);
59   gboolean     (* is_child_selected)    (AtkSelection   *selection,
60                                          gint           i);
61   gboolean     (* remove_selection)     (AtkSelection   *selection,
62                                          gint           i);
63   gboolean     (* select_all_selection) (AtkSelection   *selection);
64
65   /* signal handlers */
66   
67   void         (*selection_changed)     (AtkSelection   *selection);
68 };
69
70 GType atk_selection_get_type (void);
71
72 gboolean     atk_selection_add_selection        (AtkSelection   *selection,
73                                                  gint           i);
74
75 gboolean     atk_selection_clear_selection      (AtkSelection   *selection);
76
77 AtkObject*   atk_selection_ref_selection        (AtkSelection   *selection,
78                                                  gint           i);
79
80 gint         atk_selection_get_selection_count  (AtkSelection   *selection);
81
82 gboolean     atk_selection_is_child_selected    (AtkSelection   *selection,
83                                                  gint           i);
84
85 gboolean     atk_selection_remove_selection     (AtkSelection   *selection,
86                                                  gint           i);
87
88 gboolean     atk_selection_select_all_selection (AtkSelection   *selection);
89
90 G_END_DECLS
91
92 #endif /* __ATK_SELECTION_H__ */