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
24#ifndef __com_sun_star_accessibility_XAccessible_idl__
25#define __com_sun_star_accessibility_XAccessible_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31module com { module sun { module star { module accessibility {
32
33 published interface XAccessibleContext;
34
35/** This interface has to be implemented by any class that wants to be
36    accessible.
37
38    <p>It is used to provide access to the <type>XAccessibleContext</type>
39    interface but allows at the same time that that interface is implemented
40    by another class.</p>
41
42    <p>The distinction between the interfaces <type>XAccessible</type> and
43    <type>XAccessibleContext</type> makes it possible to split up the
44    implementation of the
45    class that is made accessible and the actual accessibility code into two
46    (mostly) independant parts.  The only necessary dependance is the
47    <member scope="XAccessible">getAccessibleContext()</member> function
48    that returns the accessible context.  This one-way link has to be
49    persistant in some sense: As long as there is at least one reference to
50    a specific <type>XAccessibleContext</type> object the
51    <type>XAccessible</type> object has to return the same context for every
52    call to <member scope="XAccessible">getAccessibleContext()</member>.
53    This is necessary to allow the use of object identity for comparing
54    accessibility contexts for being equal.</p>
55
56    @see AccessibleContext
57
58    @since OpenOffice 1.1.2
59*/
60published interface XAccessible : ::com::sun::star::uno::XInterface
61{
62    /** Returns the AccessibleContext associated with this object.
63
64        <p>The idea to let this interface only return an
65        <type>XAccessibleContext</type> instead of directly supporting its
66        functions is to allow the seperation of the implementation of the
67        functions that make a class accessible from the implementation of
68        that class.  You may, of course, implement <type>XAccessible</type>
69        and <type>XAccessibleContext</type> in one class.</p>
70
71        @return
72            A reference to the object that contains the actual accessibility
73            information.
74
75        @see AccessibleContext
76	*/
77    XAccessibleContext getAccessibleContext ();
78};
79
80}; }; }; };
81
82#endif
83