atk-1.0/atk/atkrelationset.h

0001 /* ATK -  Accessibility Toolkit
0002  * Copyright 2001 Sun Microsystems Inc.
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Library General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012  * Library General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Library General Public
0015  * License along with this library; if not, write to the
0016  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
0017  * Boston, MA 02111-1307, USA.
0018  */
0019
0020 #ifndef __ATK_RELATION_SET_H__
0021 #define __ATK_RELATION_SET_H__
0022
0023 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined(__ATK_H_INSIDE__) && !defined(ATK_COMPILATION)
0024 #error "Only <atk/atk.h> can be included directly."
0025 #endif
0026
0027 G_BEGIN_DECLS
0028
0029 #include <atk/atkobject.h>
0030 #include <atk/atkrelation.h>
0031 #include <glib-object.h>
0032
0033 #define ATK_TYPE_RELATION_SET (atk_relation_set_get_type ())
0034 #define ATK_RELATION_SET(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_RELATION_SET, AtkRelationSet))
0035 #define ATK_RELATION_SET_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_RELATION_SET, AtkRelationSetClass))
0036 #define ATK_IS_RELATION_SET(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_RELATION_SET))
0037 #define ATK_IS_RELATION_SET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_RELATION_SET))
0038 #define ATK_RELATION_SET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_RELATION_SET, AtkRelationSetClass))
0039
0040 typedef struct _AtkRelationSetClass AtkRelationSetClass;
0041
0042 struct _AtkRelationSet
0043 {
0044   GObject parent;
0045
0046   GPtrArray *relations;
0047 };
0048
0049 struct _AtkRelationSetClass
0050 {
0051   GObjectClass parent;
0052
0053   AtkFunction pad1;
0054   AtkFunction pad2;
0055 };
0056
0057 ATK_AVAILABLE_IN_ALL
0058 GType atk_relation_set_get_type (void);
0059
0060 ATK_AVAILABLE_IN_ALL
0061 AtkRelationSet *atk_relation_set_new (void);
0062 ATK_AVAILABLE_IN_ALL
0063 gboolean atk_relation_set_contains (AtkRelationSet *set,
0064                                     AtkRelationType relationship);
0065 ATK_AVAILABLE_IN_ALL
0066 gboolean atk_relation_set_contains_target (AtkRelationSet *set,
0067                                            AtkRelationType relationship,
0068                                            AtkObject *target);
0069 ATK_AVAILABLE_IN_ALL
0070 void atk_relation_set_remove (AtkRelationSet *set,
0071                               AtkRelation *relation);
0072 ATK_AVAILABLE_IN_ALL
0073 void atk_relation_set_add (AtkRelationSet *set,
0074                            AtkRelation *relation);
0075 ATK_AVAILABLE_IN_ALL
0076 gint atk_relation_set_get_n_relations (AtkRelationSet *set);
0077 ATK_AVAILABLE_IN_ALL
0078 AtkRelation *atk_relation_set_get_relation (AtkRelationSet *set,
0079                                             gint i);
0080 ATK_AVAILABLE_IN_ALL
0081 AtkRelation *atk_relation_set_get_relation_by_type (AtkRelationSet *set,
0082                                                     AtkRelationType relationship);
0083 ATK_AVAILABLE_IN_ALL
0084 void atk_relation_set_add_relation_by_type (AtkRelationSet *set,
0085                                             AtkRelationType relationship,
0086                                             AtkObject *target);
0087
0088 G_END_DECLS
0089
0090 #endif /* __ATK_RELATION_SET_H__ */