Revert "Revert "Merge remote-tracking branch 'origin/sandbox/mniesluchow/upstream_2_1...
[platform/upstream/atk.git] / atk / atkrelationset.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_RELATION_SET_H__
25 #define __ATK_RELATION_SET_H__
26
27 G_BEGIN_DECLS
28
29 #include <glib-object.h>
30 #include <atk/atkobject.h>
31 #include <atk/atkrelation.h>
32
33 #define ATK_TYPE_RELATION_SET                     (atk_relation_set_get_type ())
34 #define ATK_RELATION_SET(obj)                     (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_RELATION_SET, AtkRelationSet))
35 #define ATK_RELATION_SET_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_RELATION_SET, AtkRelationSetClass))
36 #define ATK_IS_RELATION_SET(obj)                  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_RELATION_SET))
37 #define ATK_IS_RELATION_SET_CLASS(klass)          (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_RELATION_SET))
38 #define ATK_RELATION_SET_GET_CLASS(obj)           (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_RELATION_SET, AtkRelationSetClass))
39
40 typedef struct _AtkRelationSetClass       AtkRelationSetClass;
41
42
43 struct _AtkRelationSet
44 {
45   GObject parent;
46
47   GPtrArray *relations;
48 };
49
50 struct _AtkRelationSetClass
51 {
52   GObjectClass parent;
53
54   AtkFunction pad1;
55   AtkFunction pad2;
56 };
57
58 ATK_AVAILABLE_IN_ALL
59 GType atk_relation_set_get_type (void);
60
61 ATK_AVAILABLE_IN_ALL
62 AtkRelationSet* atk_relation_set_new                  (void);
63 ATK_AVAILABLE_IN_ALL
64 gboolean        atk_relation_set_contains             (AtkRelationSet  *set,
65                                                        AtkRelationType relationship);
66 ATK_AVAILABLE_IN_ALL
67 gboolean        atk_relation_set_contains_target      (AtkRelationSet  *set,
68                                                        AtkRelationType relationship,
69                                                        AtkObject       *target);
70 ATK_AVAILABLE_IN_ALL
71 void            atk_relation_set_remove               (AtkRelationSet  *set,
72                                                        AtkRelation     *relation);
73 ATK_AVAILABLE_IN_ALL
74 void            atk_relation_set_add                  (AtkRelationSet  *set,
75                                                        AtkRelation     *relation);
76 ATK_AVAILABLE_IN_ALL
77 gint            atk_relation_set_get_n_relations      (AtkRelationSet  *set);
78 ATK_AVAILABLE_IN_ALL
79 AtkRelation*    atk_relation_set_get_relation         (AtkRelationSet  *set,
80                                                        gint            i);
81 ATK_AVAILABLE_IN_ALL
82 AtkRelation*    atk_relation_set_get_relation_by_type (AtkRelationSet  *set,
83                                                        AtkRelationType relationship);
84 ATK_AVAILABLE_IN_ALL
85 void            atk_relation_set_add_relation_by_type (AtkRelationSet  *set,
86                                                        AtkRelationType relationship,
87                                                        AtkObject       *target);
88
89 G_END_DECLS
90
91 #endif /* __ATK_RELATION_SET_H__ */