atk/atkrelation.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_H__
  25 #define __ATK_RELATION_H__
  26
  27 G_BEGIN_DECLS
  28
  29 #include <glib-object.h>
  30 #include <atk/atkrelationtype.h>
  31
  32 /*
  33  * An AtkRelation describes a relation between the object and one or more
  34  * other objects. The actual relations that an object has with other objects
  35  * are defined as an AtkRelationSet, which is a set of AtkRelations.
  36  */
  37
  38 #define ATK_TYPE_RELATION                         (atk_relation_get_type ())
  39 #define ATK_RELATION(obj)                         (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_RELATION, AtkRelation))
  40 #define ATK_RELATION_CLASS(klass)                 (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_RELATION, AtkRelationClass))
  41 #define ATK_IS_RELATION(obj)                      (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_RELATION))
  42 #define ATK_IS_RELATION_CLASS(klass)              (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_RELATION))
  43 #define ATK_RELATION_GET_CLASS(obj)               (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_RELATION, AtkRelationClass))
  44
  45 typedef struct _AtkRelation            AtkRelation;
  46 typedef struct _AtkRelationClass       AtkRelationClass;
  47
  48 struct _AtkRelation
  49 {
  50   GObject parent;
  51
  52   GPtrArray       *target;
  53   AtkRelationType relationship;
  54 };
  55
  56 struct _AtkRelationClass
  57 {
  58   GObjectClass parent;
  59 };
  60
  61 GType atk_relation_get_type (void);
  62
  63 AtkRelationType       atk_relation_type_register      (const gchar     *name);
  64 G_CONST_RETURN gchar* atk_relation_type_get_name      (AtkRelationType type);
  65 AtkRelationType       atk_relation_type_for_name      (const gchar     *name);
  66
  67 /*
  68  * Create a new relation for the specified key and the specified list
  69  * of targets.
  70  */
  71 AtkRelation*          atk_relation_new                (AtkObject       **targets,
  72                                                        gint            n_targets,
  73                                                        AtkRelationType relationship);
  74 /*
  75  * Returns the type of a relation.
  76  */
  77 AtkRelationType       atk_relation_get_relation_type  (AtkRelation     *relation);
  78 /*
  79  * Returns the target list of a relation.
  80  */
  81 GPtrArray*            atk_relation_get_target         (AtkRelation     *relation);
  82 void                  atk_relation_add_target         (AtkRelation     *relation,
  83                                                        AtkObject       *target);
  84 gboolean              atk_relation_remove_target      (AtkRelation     *relation,
  85                                                        AtkObject       *target);
  86
  87 G_END_DECLS
  88
  89 #endif /* __ATK_RELATION_H__ */