Add reference to atk/atkrelationtype.h
[platform/upstream/atk.git] / atk / atkrelationtype.h
1 /* ATK -  Accessibility Toolkit
2  * Copyright 2002 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_TYPE_H__
21 #define __ATK_RELATION_TYPE_H__
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif /* __cplusplus */
26
27 /**
28  *AtkRelationType:
29  *@ATK_RELATION_NULL:
30  *@ATK_RELATION_CONTROLLED_BY: Indicates an object controlled by one or more target objects.
31  *@ATK_RELATION_CONTROLLER_FOR: Indicates an object is an controller for one or more target objects.
32  *@ATK_RELATION_LABEL_FOR: Indicates an object is a label for one or more target objects.
33  *@ATK_RELATION_LABELLED_BY: Indicates an object is labelled by one or more target objects.
34  *@ATK_RELATION_MEMBER_OF: Indicates an object is a member of a group of one or more target objects.
35  *@ATK_RELATION_NODE_CHILD_OF: Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell.
36  *@ATK_RELATION_FLOWS_TO: Indicates that the object has content that flows logically to another
37  *  AtkObject in a sequential way, (for instance text-flow).
38  *@ATK_RELATION_FLOWS_FROM: Indicates that the object has content that flows logically from
39  *  another AtkObject in a sequential way, (for instance text-flow).
40  *@ATK_RELATION_SUBWINDOW_OF: [not sure about this one, ask peter]
41  *@ATK_RELATION_LAST_DEFINED:
42  * 
43  *Describes the type of the relation
44  **/
45 typedef enum
46 {
47   ATK_RELATION_NULL = 0,
48   ATK_RELATION_CONTROLLED_BY,
49   ATK_RELATION_CONTROLLER_FOR,
50   ATK_RELATION_LABEL_FOR,
51   ATK_RELATION_LABELLED_BY,
52   ATK_RELATION_MEMBER_OF,
53   ATK_RELATION_NODE_CHILD_OF,
54   ATK_RELATION_FLOWS_TO,
55   ATK_RELATION_FLOWS_FROM,
56   ATK_RELATION_SUBWINDOW_OF, /* not sure about this one, ask Peter */
57   ATK_RELATION_LAST_DEFINED
58 } AtkRelationType;
59
60 #ifdef __cplusplus
61 }
62 #endif /* __cplusplus */
63
64 #endif /* __ATK_RELATION_TYPE_H__ */