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 typedef enum
  30 {
  31   ATK_RELATION_NULL = 0,
  32
  33   ATK_RELATION_CONTROLLED_BY,
  34   ATK_RELATION_CONTROLLER_FOR,
  35   ATK_RELATION_LABEL_FOR,
  36   ATK_RELATION_LABELLED_BY,
  37   ATK_RELATION_MEMBER_OF,
  38   ATK_RELATION_LAST_DEFINED
  39 } AtkRelationType;
  40
  41 #define ATK_TYPE_RELATION                         (atk_relation_get_type ())
  42 #define ATK_RELATION(obj)                         (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_RELATION, AtkRelation))
  43 #define ATK_RELATION_CLASS(klass)                 (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_RELATION, AtkRelationClass))
  44 #define ATK_IS_RELATION(obj)                      (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_RELATION))
  45 #define ATK_IS_RELATION_CLASS(klass)              (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_RELATION))
  46 #define ATK_RELATION_GET_CLASS(obj)               (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_RELATION, AtkRelationClass))
  47
  48 typedef struct _AtkRelation            AtkRelation;
  49 typedef struct _AtkRelationClass       AtkRelationClass;
  50
  51
  52 struct _AtkRelation
  53 {
  54   GObject parent;
  55
  56   GPtrArray       *target;
  57   AtkRelationType relationship;
  58 };
  59
  60 struct _AtkRelationClass
  61 {
  62   GObjectClass parent;
  63 };
  64
  65 GType atk_relation_get_type (void);
  66
  67 AtkRelationType atk_relation_type_register            (const gchar *name);
  68
  69 /*
  70  * Create a new relation for the specified key and the specified list
  71  * of targets.
  72  */
  73 AtkRelation*    atk_relation_new                      (AtkObject       **targets,
  74                                                        gint            n_targets,
  75                                                        AtkRelationType relationship);
  76 /*
  77  * Returns the type of a relation.
  78  */
  79 AtkRelationType atk_relation_get_relation_type        (AtkRelation     *relation);
  80 /*
  81  * Returns the target list of a relation.
  82  */
  83 GPtrArray*      atk_relation_get_target               (AtkRelation     *relation);
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif /* __cplusplus */
  88
  89 #endif /* __ATK_RELATION_H__ */