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 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined(__ATK_H_INSIDE__) && !defined(ATK_COMPILATION)
  24 #error "Only <atk/atk.h> can be included directly."
  25 #endif
  26
  27 G_BEGIN_DECLS
  28
  29 #include <atk/atkobject.h>
  30 #include <atk/atkrelation.h>
  31 #include <glib-object.h>
  32
  33 #define ATK_TYPE_RELATION_SET (atk_relation_set_get_type ())
  34 #define ATK_RELATION_SET(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_RELATION_SET, AtkRelationSet))
  35 #define ATK_RELATION_SET_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_RELATION_SET, AtkRelationSetClass))
  36 #define ATK_IS_RELATION_SET(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_RELATION_SET))
  37 #define ATK_IS_RELATION_SET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_RELATION_SET))
  38 #define ATK_RELATION_SET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_RELATION_SET, AtkRelationSetClass))
  39
  40 typedef struct _AtkRelationSetClass AtkRelationSetClass;
  41
  42 struct _AtkRelationSet
  43 {
  44   GObject parent;
  45
  46   GPtrArray *relations;
  47 };
  48
  49 struct _AtkRelationSetClass
  50 {
  51   GObjectClass parent;
  52
  53   AtkFunction pad1;
  54   AtkFunction pad2;
  55 };
  56
  57 ATK_AVAILABLE_IN_ALL
  58 GType atk_relation_set_get_type (void);
  59
  60 ATK_AVAILABLE_IN_ALL
  61 AtkRelationSet *atk_relation_set_new (void);
  62 ATK_AVAILABLE_IN_ALL
  63 gboolean atk_relation_set_contains (AtkRelationSet *set,
  64                                     AtkRelationType relationship);
  65 ATK_AVAILABLE_IN_ALL
  66 gboolean atk_relation_set_contains_target (AtkRelationSet *set,
  67                                            AtkRelationType relationship,
  68                                            AtkObject *target);
  69 ATK_AVAILABLE_IN_ALL
  70 void atk_relation_set_remove (AtkRelationSet *set,
  71                               AtkRelation *relation);
  72 ATK_AVAILABLE_IN_ALL
  73 void atk_relation_set_add (AtkRelationSet *set,
  74                            AtkRelation *relation);
  75 ATK_AVAILABLE_IN_ALL
  76 gint atk_relation_set_get_n_relations (AtkRelationSet *set);
  77 ATK_AVAILABLE_IN_ALL
  78 AtkRelation *atk_relation_set_get_relation (AtkRelationSet *set,
  79                                             gint i);
  80 ATK_AVAILABLE_IN_ALL
  81 AtkRelation *atk_relation_set_get_relation_by_type (AtkRelationSet *set,
  82                                                     AtkRelationType relationship);
  83 ATK_AVAILABLE_IN_ALL
  84 void atk_relation_set_add_relation_by_type (AtkRelationSet *set,
  85                                             AtkRelationType relationship,
  86                                             AtkObject *target);
  87
  88 G_END_DECLS
  89
  90 #endif /* __ATK_RELATION_SET_H__ */