atk/atkrelationset.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_SET_H__
  21 #define __ATK_RELATION_SET_H__
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif /* __cplusplus */
  26
  27 #include <glib-object.h>
  28 #include <atk/atkobject.h>
  29 #include <atk/atkrelation.h>
  30
  31 #define ATK_TYPE_RELATION_SET                     (atk_relation_set_get_type ())
  32 #define ATK_RELATION_SET(obj)                     (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_RELATION_SET, AtkRelationSet))
  33 #define ATK_RELATION_SET_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_RELATION_SET, AtkRelationSetClass))
  34 #define ATK_IS_RELATION_SET(obj)                  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_RELATION_SET))
  35 #define ATK_IS_RELATION_SET_CLASS(klass)          (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_RELATION_SET))
  36 #define ATK_RELATION_SET_GET_CLASS(obj)           (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_RELATION_SET, AtkRelationSetClass))
  37
  38 typedef struct _AtkRelationSetClass       AtkRelationSetClass;
  39
  40
  41 struct _AtkRelationSet
  42 {
  43   GObject parent;
  44
  45   GPtrArray *relations;
  46 };
  47
  48 struct _AtkRelationSetClass
  49 {
  50   GObjectClass parent;
  51 };
  52
  53 GType atk_relation_set_get_type (void);
  54
  55 /*
  56  * Create a new relation set.
  57  */
  58 AtkRelationSet*    atk_relation_set_new               (void);
  59 /*
  60  * Returns whether the relation set contains a relation that matches the
  61  * specified type.
  62  */
  63 gboolean        atk_relation_set_contains             (AtkRelationSet  *set,
  64                                                        AtkRelationType relationship);
  65 /*
  66  * Remove a relation from the relation set.
  67  *
  68  * This function unref's the AtkRelation so it will be deleted unless there
  69  * is another reference to it.
  70  */
  71 void            atk_relation_set_remove               (AtkRelationSet  *set,
  72                                                        AtkRelation     *relation);
  73 /*
  74  * Add a new relation to the current relation set if it is not already
  75  * present.
  76  *
  77  * This function ref's the AtkRelation so the caller of this function
  78  * should unref it to ensure that it will be destroyed when the AtkRelationSet
  79  * is destroyed.
  80  */
  81 void            atk_relation_set_add                  (AtkRelationSet  *set,
  82                                                        AtkRelation     *relation);
  83 /*
  84  * Returns the number of relations in a relation set.
  85  */
  86 gint            atk_relation_set_get_n_relations      (AtkRelationSet  *set);
  87 /*
  88  * Returns the relation at the specified position in the relation set.
  89  */
  90 AtkRelation*    atk_relation_set_get_relation         (AtkRelationSet  *set,
  91                                                        gint            i);
  92 /*
  93  * Returns a relation that matches the specified type.
  94  */
  95 AtkRelation*    atk_relation_set_get_relation_by_type (AtkRelationSet  *set,
  96                                                        AtkRelationType relationship);
  97
  98 #ifdef __cplusplus
  99 }
 100 #endif /* __cplusplus */
 101
 102
 103 #endif /* __ATK_RELATION_SET_H__ */