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 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  21 #error "Only <atk/atk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __ATK_RELATION_TYPE_H__
  25 #define __ATK_RELATION_TYPE_H__
  26
  27 #include <glib.h>
  28
  29 G_BEGIN_DECLS
  30
  31 /**
  32  *AtkRelationType:
  33  *@ATK_RELATION_NULL: Not used, represens "no relationship" or an error condition.
  34  *@ATK_RELATION_CONTROLLED_BY: Indicates an object controlled by one or more target objects.
  35  *@ATK_RELATION_CONTROLLER_FOR: Indicates an object is an controller for one or more target objects.
  36  *@ATK_RELATION_LABEL_FOR: Indicates an object is a label for one or more target objects.
  37  *@ATK_RELATION_LABELLED_BY: Indicates an object is labelled by one or more target objects.
  38  *@ATK_RELATION_MEMBER_OF: Indicates an object is a member of a group of one or more target objects.
  39  *@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.
  40  *@ATK_RELATION_FLOWS_TO: Indicates that the object has content that flows logically to another
  41  *  AtkObject in a sequential way, (for instance text-flow).
  42  *@ATK_RELATION_FLOWS_FROM: Indicates that the object has content that flows logically from
  43  *  another AtkObject in a sequential way, (for instance text-flow).
  44  *@ATK_RELATION_SUBWINDOW_OF: Indicates a subwindow attached to a component but otherwise has no connection in  the UI heirarchy to that component.
  45  *@ATK_RELATION_EMBEDS: Indicates that the object visually embeds
  46  *  another object's content, i.e. this object's content flows around
  47  *  another's content.
  48  *@ATK_RELATION_EMBEDDED_BY: Inverse of %ATK_RELATION_EMBEDS, indicates that
  49  *  this object's content is visualy embedded in another object.
  50  *@ATK_RELATION_POPUP_FOR: Indicates that an object is a popup for another object.
  51  *@ATK_RELATION_PARENT_WINDOW_OF: Indicates that an object is a parent window of another object.
  52  *@ATK_RELATION_DESCRIBED_BY: Indicates that another object provides descriptive information about this object; more verbose than ATK_RELATION_LABELLED_BY.
  53  *@ATK_RELATION_DESCRIPTION_FOR: Indicates that an object provides descriptive information about another object; more verbose than ATK_RELATION_LABEL_FOR.
  54  *@ATK_RELATION_NODE_PARENT_OF: Indicates an object is a cell in a treetable and is expanded to display other cells in the same column.
  55  *@ATK_RELATION_LAST_DEFINED: Not used, this value indicates the end of the enumeration.
  56  *
  57  *Describes the type of the relation
  58  **/
  59 typedef enum
  60 {
  61   ATK_RELATION_NULL = 0,
  62   ATK_RELATION_CONTROLLED_BY,
  63   ATK_RELATION_CONTROLLER_FOR,
  64   ATK_RELATION_LABEL_FOR,
  65   ATK_RELATION_LABELLED_BY,
  66   ATK_RELATION_MEMBER_OF,
  67   ATK_RELATION_NODE_CHILD_OF,
  68   ATK_RELATION_FLOWS_TO,
  69   ATK_RELATION_FLOWS_FROM,
  70   ATK_RELATION_SUBWINDOW_OF,
  71   ATK_RELATION_EMBEDS,
  72   ATK_RELATION_EMBEDDED_BY,
  73   ATK_RELATION_POPUP_FOR,
  74   ATK_RELATION_PARENT_WINDOW_OF,
  75   ATK_RELATION_DESCRIBED_BY,
  76   ATK_RELATION_DESCRIPTION_FOR,
  77   ATK_RELATION_NODE_PARENT_OF,
  78   ATK_RELATION_LAST_DEFINED
  79 } AtkRelationType;
  80
  81 G_END_DECLS
  82
  83 #endif /* __ATK_RELATION_TYPE_H__ */