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 #ifndef __ATK_RELATION_H__
  21 #define __ATK_RELATION_H__
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif /* __cplusplus */
  26
  27 #include <glib-object.h>
  28
  29 /*
  30  * An AtkRelation describes a relation between the object and one or more
  31  * other objects. The actual relations that an object has with other objects
  32  * are defined as an AtkRelationSet, which is a set of AtkRelations.
  33  */
  34
  35 /**
  36  *AtkRelationType:
  37  *@ATK_RELATION_NULL:
  38  *@ATK_RELATION_CONTROLLED_BY: Indicates an object controlled by one or more target objects.
  39  *@ATK_RELATION_CONTROLLER_FOR: Indicates an object is an controller for one or more target objects.
  40  *@ATK_RELATION_LABEL_FOR: Indicates an object is a label for one or more target objects.
  41  *@ATK_RELATION_LABELLED_BY: Indicates an object is labelled by one or more target objects.
  42  *@ATK_RELATION_MEMBER_OF: Indicates an object is a member of a group of one or more target objects.
  43  *@ATK_RELATION_NODE_CHILDREN: Indicates an object is a node in a tree or table and a compound object which more than one subobject
  44  *@ATK_RELATION_NODE_PARENT: Indicates an object is a subobject of a compound object which is a node in a tree or table.
  45  *@ATK_RELATION_LAST_DEFINED:
  46  *
  47  *Describes the type of the relation
  48  **/
  49 typedef enum
  50 {
  51   ATK_RELATION_NULL = 0,
  52   ATK_RELATION_CONTROLLED_BY,
  53   ATK_RELATION_CONTROLLER_FOR,
  54   ATK_RELATION_LABEL_FOR,
  55   ATK_RELATION_LABELLED_BY,
  56   ATK_RELATION_MEMBER_OF,
  57   ATK_RELATION_NODE_CHILDREN,
  58   ATK_RELATION_NODE_PARENT,
  59   ATK_RELATION_LAST_DEFINED
  60 } AtkRelationType;
  61
  62 #define ATK_TYPE_RELATION                         (atk_relation_get_type ())
  63 #define ATK_RELATION(obj)                         (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_RELATION, AtkRelation))
  64 #define ATK_RELATION_CLASS(klass)                 (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_RELATION, AtkRelationClass))
  65 #define ATK_IS_RELATION(obj)                      (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_RELATION))
  66 #define ATK_IS_RELATION_CLASS(klass)              (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_RELATION))
  67 #define ATK_RELATION_GET_CLASS(obj)               (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_RELATION, AtkRelationClass))
  68
  69 typedef struct _AtkRelation            AtkRelation;
  70 typedef struct _AtkRelationClass       AtkRelationClass;
  71
  72
  73 struct _AtkRelation
  74 {
  75   GObject parent;
  76
  77   GPtrArray       *target;
  78   AtkRelationType relationship;
  79 };
  80
  81 struct _AtkRelationClass
  82 {
  83   GObjectClass parent;
  84 };
  85
  86 GType atk_relation_get_type (void);
  87
  88 AtkRelationType atk_relation_type_register            (const gchar *name);
  89
  90 AtkRelationType atk_relation_type_from_string         (const gchar *name);
  91
  92 /*
  93  * Create a new relation for the specified key and the specified list
  94  * of targets.
  95  */
  96 AtkRelation*    atk_relation_new                      (AtkObject       **targets,
  97                                                        gint            n_targets,
  98                                                        AtkRelationType relationship);
  99 /*
 100  * Returns the type of a relation.
 101  */
 102 AtkRelationType atk_relation_get_relation_type        (AtkRelation     *relation);
 103 /*
 104  * Returns the target list of a relation.
 105  */
 106 GPtrArray*      atk_relation_get_target               (AtkRelation     *relation);
 107
 108 #ifdef __cplusplus
 109 }
 110 #endif /* __cplusplus */
 111
 112 #endif /* __ATK_RELATION_H__ */