xref: /trunk/main/offapi/com/sun/star/accessibility/AccessibleRelation.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_AccessibleRelation_idl__
24cdf0e10cSrcweir#define __com_sun_star_accessibility_AccessibleRelation_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweirmodule com { module sun { module star { module accessibility {
31cdf0e10cSrcweir
32cdf0e10cSrcweir/** An <type>AccessibleRelation</type> object defines a one-to-many
33cdf0e10cSrcweir    relation.
34cdf0e10cSrcweir
35cdf0e10cSrcweir    <p>The represented relation points from the implementing object to a set
36cdf0e10cSrcweir    of target objects.</p>
37cdf0e10cSrcweir
38*0d3a54ffSJürgen Schmidt    @since OpenOffice 1.1.2
39cdf0e10cSrcweir*/
40cdf0e10cSrcweirpublished struct AccessibleRelation
41cdf0e10cSrcweir{
42cdf0e10cSrcweir    /** Type of the relation.
43cdf0e10cSrcweir
44cdf0e10cSrcweir        <p>Its value has to be one of the constants defined by
45cdf0e10cSrcweir        <type>AccessibleRelationType</type>.  If that value is INVALID then
46cdf0e10cSrcweir        the whole relation is regarded as invalid.  The content of the
47cdf0e10cSrcweir        targetSet is then undefined.</p>
48cdf0e10cSrcweir
49cdf0e10cSrcweir        @see AccessibleRelationType
50cdf0e10cSrcweir    */
51cdf0e10cSrcweir    short RelationType;
52cdf0e10cSrcweir
53cdf0e10cSrcweir    /** Set of objects that are the relation's targets.
54cdf0e10cSrcweir
55cdf0e10cSrcweir        <p>The content of this set is undefined if the relation's type is
56cdf0e10cSrcweir        INVALID.  The set must not contain references to one object more
57cdf0e10cSrcweir        than once.</p>
58cdf0e10cSrcweir    */
59cdf0e10cSrcweir    sequence< ::com::sun::star::uno::XInterface> TargetSet;
60cdf0e10cSrcweir};
61cdf0e10cSrcweir
62cdf0e10cSrcweir}; }; }; };
63cdf0e10cSrcweir
64cdf0e10cSrcweir#endif
65