atk-1.0/atk/atkrelation.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_H__
0021 #define __ATK_RELATION_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/atkrelationtype.h>
0030 #include <atk/atkversion.h>
0031 #include <glib-object.h>
0032
0033 /*
0034  * An AtkRelation describes a relation between the object and one or more
0035  * other objects. The actual relations that an object has with other objects
0036  * are defined as an AtkRelationSet, which is a set of AtkRelations.
0037  */
0038
0039 #define ATK_TYPE_RELATION (atk_relation_get_type ())
0040 #define ATK_RELATION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_RELATION, AtkRelation))
0041 #define ATK_RELATION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_RELATION, AtkRelationClass))
0042 #define ATK_IS_RELATION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_RELATION))
0043 #define ATK_IS_RELATION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_RELATION))
0044 #define ATK_RELATION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_RELATION, AtkRelationClass))
0045
0046 typedef struct _AtkRelation AtkRelation;
0047 typedef struct _AtkRelationClass AtkRelationClass;
0048
0049 struct _AtkRelation
0050 {
0051   GObject parent;
0052
0053   GPtrArray *target;
0054   AtkRelationType relationship;
0055 };
0056
0057 struct _AtkRelationClass
0058 {
0059   GObjectClass parent;
0060 };
0061
0062 ATK_AVAILABLE_IN_ALL
0063 GType atk_relation_get_type (void);
0064
0065 ATK_AVAILABLE_IN_ALL
0066 AtkRelationType atk_relation_type_register (const gchar *name);
0067 ATK_AVAILABLE_IN_ALL
0068 const gchar *atk_relation_type_get_name (AtkRelationType type);
0069 ATK_AVAILABLE_IN_ALL
0070 AtkRelationType atk_relation_type_for_name (const gchar *name);
0071
0072 /*
0073  * Create a new relation for the specified key and the specified list
0074  * of targets.
0075  */
0076 ATK_AVAILABLE_IN_ALL
0077 AtkRelation *atk_relation_new (AtkObject **targets,
0078                                gint n_targets,
0079                                AtkRelationType relationship);
0080 /*
0081  * Returns the type of a relation.
0082  */
0083 ATK_AVAILABLE_IN_ALL
0084 AtkRelationType atk_relation_get_relation_type (AtkRelation *relation);
0085 /*
0086  * Returns the target list of a relation.
0087  */
0088 ATK_AVAILABLE_IN_ALL
0089 GPtrArray *atk_relation_get_target (AtkRelation *relation);
0090 ATK_AVAILABLE_IN_ALL
0091 void atk_relation_add_target (AtkRelation *relation,
0092                               AtkObject *target);
0093 ATK_AVAILABLE_IN_ALL
0094 gboolean atk_relation_remove_target (AtkRelation *relation,
0095                                      AtkObject *target);
0096
0097 G_END_DECLS
0098
0099 #endif /* __ATK_RELATION_H__ */