1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_accessibility_AccessibleRelationType_idl__ 24#define __com_sun_star_accessibility_AccessibleRelationType_idl__ 25 26module com { module sun { module star { module accessibility { 27 28/** Collection of relation types. 29 30 <p>This list of constants defines the availabe types of relations that 31 are usable by <type>AccessibleRelation</type>.</p> 32 33 <p>We are using constants instead of a more typesafe enum. The reason 34 for this is that IDL enums may not be extended. Therefore, in order to 35 include future extensions to the set of roles we have to use constants 36 here.</p> 37 38 @since OOo 1.1.2 39*/ 40published constants AccessibleRelationType 41{ 42 /** Invalid relation type. 43 44 <p>Indicates an invalid relation type. This is used to indicate 45 that a retrieval method could not find a requested relation.</p> 46 */ 47 const short INVALID = 0; 48 49 /** Content-flows-from relation. 50 51 <p>Indicates a content flow between the related objects.</p> 52 */ 53 const short CONTENT_FLOWS_FROM = 1; 54 55 /** Content-flows-to relation. 56 57 <p>Indicates a content flow between the related objects.</p> 58 */ 59 const short CONTENT_FLOWS_TO = 2; 60 61 /** Controlled-by relation type. 62 63 <p>Indicates an object is controlled by one or more target 64 objects.</p> 65 */ 66 const short CONTROLLED_BY = 3; 67 68 /** Controller-for relation type. 69 70 <p>Indicates an object is a controller for one or more target 71 objects.</p> 72 */ 73 const short CONTROLLER_FOR = 4; 74 75 /** Lable-for relation type. 76 77 <p>Indicates an object is a label for one or more target 78 objects.</p> 79 */ 80 const short LABEL_FOR = 5; 81 82 /** Labeled-by relation type. 83 84 <p>Indicates an object is labeled by one or more target objects.</p> 85 */ 86 const short LABELED_BY = 6; 87 88 /** Member-of relation type. 89 90 <p>Indicates an object is a member of a group of one or more target 91 objects.</p> 92 */ 93 const short MEMBER_OF = 7; 94 95 /** Sub-Window-of relation type. 96 97 <p>With this relation you can realize an alternative parent-child 98 relationship. The target of the relation contains the parent 99 window. Note that there is no relation that points the other way, 100 from the parent window to the child window.</p> 101 */ 102 const short SUB_WINDOW_OF = 8; 103 104 /** Node-Child-of relation type. 105 106 <p>Indicates an object is a cell in a tree or treetable which is 107 displayed because a cell in the same column is expanded and 108 identifies that cell.</p> 109 110 @since OOo 3.0 111 */ 112 const short NODE_CHILD_OF = 9; 113 114 /** Described-by relation type. 115 116 <p>Indicates an object is described by the target object.</p> 117 118 @since OOo 3.5 119 */ 120 const short DESCRIBED_BY = 10; 121}; 122 123}; }; }; }; 124 125#endif 126