atk-1.0/atk/atkrelationtype.h

0001 /* ATK -  Accessibility Toolkit
0002  * Copyright 2002 Sun Microsystems Inc.
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Library General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012  * Library General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Library General Public
0015  * License along with this library; if not, write to the
0016  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
0017  * Boston, MA 02111-1307, USA.
0018  */
0019
0020 #ifndef __ATK_RELATION_TYPE_H__
0021 #define __ATK_RELATION_TYPE_H__
0022
0023 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined(__ATK_H_INSIDE__) && !defined(ATK_COMPILATION)
0024 #error "Only <atk/atk.h> can be included directly."
0025 #endif
0026
0027 #include <glib.h>
0028
0029 G_BEGIN_DECLS
0030
0031 /**
0032  *AtkRelationType:
0033  *@ATK_RELATION_NULL: Not used, represens "no relationship" or an error condition.
0034  *@ATK_RELATION_CONTROLLED_BY: Indicates an object controlled by one or more target objects.
0035  *@ATK_RELATION_CONTROLLER_FOR: Indicates an object is an controller for one or more target objects.
0036  *@ATK_RELATION_LABEL_FOR: Indicates an object is a label for one or more target objects.
0037  *@ATK_RELATION_LABELLED_BY: Indicates an object is labelled by one or more target objects.
0038  *@ATK_RELATION_MEMBER_OF: Indicates an object is a member of a group of one or more target objects.
0039  *@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.
0040  *@ATK_RELATION_FLOWS_TO: Indicates that the object has content that flows logically to another
0041  *  AtkObject in a sequential way, (for instance text-flow).
0042  *@ATK_RELATION_FLOWS_FROM: Indicates that the object has content that flows logically from
0043  *  another AtkObject in a sequential way, (for instance text-flow).
0044  *@ATK_RELATION_SUBWINDOW_OF: Indicates a subwindow attached to a component but otherwise has no connection in  the UI heirarchy to that component.
0045  *@ATK_RELATION_EMBEDS: Indicates that the object visually embeds
0046  *  another object's content, i.e. this object's content flows around
0047  *  another's content.
0048  *@ATK_RELATION_EMBEDDED_BY: Reciprocal of %ATK_RELATION_EMBEDS, indicates that
0049  *  this object's content is visualy embedded in another object.
0050  *@ATK_RELATION_POPUP_FOR: Indicates that an object is a popup for another object.
0051  *@ATK_RELATION_PARENT_WINDOW_OF: Indicates that an object is a parent window of another object.
0052  *@ATK_RELATION_DESCRIBED_BY: Reciprocal of %ATK_RELATION_DESCRIPTION_FOR. Indicates that one
0053  * or more target objects provide descriptive information about this object. This relation
0054  * type is most appropriate for information that is not essential as its presentation may
0055  * be user-configurable and/or limited to an on-demand mechanism such as an assistive
0056  * technology command. For brief, essential information such as can be found in a widget's
0057  * on-screen label, use %ATK_RELATION_LABELLED_BY. For an on-screen error message, use
0058  * %ATK_RELATION_ERROR_MESSAGE. For lengthy extended descriptive information contained in
0059  * an on-screen object, consider using %ATK_RELATION_DETAILS as assistive technologies may
0060  * provide a means for the user to navigate to objects containing detailed descriptions so
0061  * that their content can be more closely reviewed.
0062  *@ATK_RELATION_DESCRIPTION_FOR: Reciprocal of %ATK_RELATION_DESCRIBED_BY. Indicates that this
0063  * object provides descriptive information about the target object(s). See also
0064  * %ATK_RELATION_DETAILS_FOR and %ATK_RELATION_ERROR_FOR.
0065  *@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.
0066  *@ATK_RELATION_DETAILS: Reciprocal of %ATK_RELATION_DETAILS_FOR. Indicates that this object
0067  * has a detailed or extended description, the contents of which can be found in the target
0068  * object(s). This relation type is most appropriate for information that is sufficiently
0069  * lengthy as to make navigation to the container of that information desirable. For less
0070  * verbose information suitable for announcement only, see %ATK_RELATION_DESCRIBED_BY. If
0071  * the detailed information describes an error condition, %ATK_RELATION_ERROR_FOR should be
0072  * used instead. @Since: ATK-2.26.
0073  *@ATK_RELATION_DETAILS_FOR: Reciprocal of %ATK_RELATION_DETAILS. Indicates that this object
0074  * provides a detailed or extended description about the target object(s). See also
0075  * %ATK_RELATION_DESCRIPTION_FOR and %ATK_RELATION_ERROR_FOR. @Since: ATK-2.26.
0076  *@ATK_RELATION_ERROR_MESSAGE: Reciprocal of %ATK_RELATION_ERROR_FOR. Indicates that this object
0077  * has one or more errors, the nature of which is described in the contents of the target
0078  * object(s). Objects that have this relation type should also contain %ATK_STATE_INVALID_ENTRY
0079  * in their #AtkStateSet. @Since: ATK-2.26.
0080  *@ATK_RELATION_ERROR_FOR: Reciprocal of %ATK_RELATION_ERROR_MESSAGE. Indicates that this object
0081  * contains an error message describing an invalid condition in the target object(s). @Since:
0082  * ATK_2.26.
0083  *@ATK_RELATION_LAST_DEFINED: Not used, this value indicates the end of the enumeration.
0084  *
0085  *Describes the type of the relation
0086  **/
0087 typedef enum
0088 {
0089   ATK_RELATION_NULL = 0,
0090   ATK_RELATION_CONTROLLED_BY,
0091   ATK_RELATION_CONTROLLER_FOR,
0092   ATK_RELATION_LABEL_FOR,
0093   ATK_RELATION_LABELLED_BY,
0094   ATK_RELATION_MEMBER_OF,
0095   ATK_RELATION_NODE_CHILD_OF,
0096   ATK_RELATION_FLOWS_TO,
0097   ATK_RELATION_FLOWS_FROM,
0098   ATK_RELATION_SUBWINDOW_OF,
0099   ATK_RELATION_EMBEDS,
0100   ATK_RELATION_EMBEDDED_BY,
0101   ATK_RELATION_POPUP_FOR,
0102   ATK_RELATION_PARENT_WINDOW_OF,
0103   ATK_RELATION_DESCRIBED_BY,
0104   ATK_RELATION_DESCRIPTION_FOR,
0105   ATK_RELATION_NODE_PARENT_OF,
0106   ATK_RELATION_DETAILS,
0107   ATK_RELATION_DETAILS_FOR,
0108   ATK_RELATION_ERROR_MESSAGE,
0109   ATK_RELATION_ERROR_FOR,
0110   ATK_RELATION_LAST_DEFINED
0111 } AtkRelationType;
0112
0113 G_END_DECLS
0114
0115 #endif /* __ATK_RELATION_TYPE_H__ */