* Boston, MA 02111-1307, USA.
*/
+#if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
+#error "Only <atk/atk.h> can be included directly."
+#endif
+
#ifndef __ATK_RELATION_H__
#define __ATK_RELATION_H__
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+G_BEGIN_DECLS
#include <glib-object.h>
+#include <atk/atkrelationtype.h>
+#include <atk/atkversion.h>
-typedef enum
-{
- ATK_RELATION_NULL = 0,
-
- ATK_RELATION_CONTROLLED_BY,
- ATK_RELATION_CONTROLLER_FOR,
- ATK_RELATION_LABEL_FOR,
- ATK_RELATION_LABELLED_BY,
- ATK_RELATION_MEMBER_OF,
- ATK_RELATION_LAST_DEFINED
-} AtkRelationType;
+/*
+ * An AtkRelation describes a relation between the object and one or more
+ * other objects. The actual relations that an object has with other objects
+ * are defined as an AtkRelationSet, which is a set of AtkRelations.
+ */
#define ATK_TYPE_RELATION (atk_relation_get_type ())
#define ATK_RELATION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_RELATION, AtkRelation))
typedef struct _AtkRelation AtkRelation;
typedef struct _AtkRelationClass AtkRelationClass;
-
struct _AtkRelation
{
GObject parent;
GObjectClass parent;
};
+ATK_AVAILABLE_IN_ALL
GType atk_relation_get_type (void);
-AtkRelationType atk_relation_type_register (const gchar *name);
+ATK_AVAILABLE_IN_ALL
+AtkRelationType atk_relation_type_register (const gchar *name);
+ATK_AVAILABLE_IN_ALL
+const gchar* atk_relation_type_get_name (AtkRelationType type);
+ATK_AVAILABLE_IN_ALL
+AtkRelationType atk_relation_type_for_name (const gchar *name);
/*
* Create a new relation for the specified key and the specified list
* of targets.
*/
-AtkRelation* atk_relation_new (AtkObject **targets,
+ATK_AVAILABLE_IN_ALL
+AtkRelation* atk_relation_new (AtkObject **targets,
gint n_targets,
AtkRelationType relationship);
/*
* Returns the type of a relation.
*/
-AtkRelationType atk_relation_get_relation_type (AtkRelation *relation);
+ATK_AVAILABLE_IN_ALL
+AtkRelationType atk_relation_get_relation_type (AtkRelation *relation);
/*
* Returns the target list of a relation.
*/
-GPtrArray* atk_relation_get_target (AtkRelation *relation);
-
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+ATK_AVAILABLE_IN_ALL
+GPtrArray* atk_relation_get_target (AtkRelation *relation);
+ATK_AVAILABLE_IN_ALL
+void atk_relation_add_target (AtkRelation *relation,
+ AtkObject *target);
+ATK_AVAILABLE_IN_ALL
+gboolean atk_relation_remove_target (AtkRelation *relation,
+ AtkObject *target);
+
+G_END_DECLS
#endif /* __ATK_RELATION_H__ */