1 /* ATK - Accessibility Toolkit
2 * Copyright 2001 Sun Microsystems Inc.
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.
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.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
19 #error "Only <atk/atk.h> can be included directly."
22 #ifndef __ATK_RELATION_H__
23 #define __ATK_RELATION_H__
27 #include <glib-object.h>
28 #include <atk/atkrelationtype.h>
31 * An AtkRelation describes a relation between the object and one or more
32 * other objects. The actual relations that an object has with other objects
33 * are defined as an AtkRelationSet, which is a set of AtkRelations.
36 #define ATK_TYPE_RELATION (atk_relation_get_type ())
37 #define ATK_RELATION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_RELATION, AtkRelation))
38 #define ATK_RELATION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_RELATION, AtkRelationClass))
39 #define ATK_IS_RELATION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_RELATION))
40 #define ATK_IS_RELATION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_RELATION))
41 #define ATK_RELATION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_RELATION, AtkRelationClass))
43 typedef struct _AtkRelation AtkRelation;
44 typedef struct _AtkRelationClass AtkRelationClass;
51 AtkRelationType relationship;
54 struct _AtkRelationClass
59 GType atk_relation_get_type (void);
61 AtkRelationType atk_relation_type_register (const gchar *name);
62 const gchar* atk_relation_type_get_name (AtkRelationType type);
63 AtkRelationType atk_relation_type_for_name (const gchar *name);
66 * Create a new relation for the specified key and the specified list
69 AtkRelation* atk_relation_new (AtkObject **targets,
71 AtkRelationType relationship);
73 * Returns the type of a relation.
75 AtkRelationType atk_relation_get_relation_type (AtkRelation *relation);
77 * Returns the target list of a relation.
79 GPtrArray* atk_relation_get_target (AtkRelation *relation);
80 void atk_relation_add_target (AtkRelation *relation,
82 gboolean atk_relation_remove_target (AtkRelation *relation,
87 #endif /* __ATK_RELATION_H__ */