1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_accessibility_XAccessible_idl__
29#define __com_sun_star_accessibility_XAccessible_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35module com { module sun { module star { module accessibility {
36
37 published interface XAccessibleContext;
38
39/** This interface has to be implemented by any class that wants to be
40    accessible.
41
42    <p>It is used to provide access to the <type>XAccessibleContext</type>
43    interface but allows at the same time that that interface is implemented
44    by another class.</p>
45
46    <p>The distinction between the interfaces <type>XAccessible</type> and
47    <type>XAccessibleContext</type> makes it possible to split up the
48    implementation of the
49    class that is made accessible and the actual accessibility code into two
50    (mostly) independant parts.  The only necessary dependance is the
51    <member scope="XAccessible">getAccessibleContext()</member> function
52    that returns the accessible context.  This one-way link has to be
53    persistant in some sense: As long as there is at least one reference to
54    a specific <type>XAccessibleContext</type> object the
55    <type>XAccessible</type> object has to return the same context for every
56    call to <member scope="XAccessible">getAccessibleContext()</member>.
57    This is necessary to allow the use of object identity for comparing
58    accessibility contexts for being equal.</p>
59
60    @see AccessibleContext
61
62    @since OOo 1.1.2
63*/
64published interface XAccessible : ::com::sun::star::uno::XInterface
65{
66    /** Returns the AccessibleContext associated with this object.
67
68        <p>The idea to let this interface only return an
69        <type>XAccessibleContext</type> instead of directly supporting its
70        functions is to allow the seperation of the implementation of the
71        functions that make a class accessible from the implementation of
72        that class.  You may, of course, implement <type>XAccessible</type>
73        and <type>XAccessibleContext</type> in one class.</p>
74
75        @return
76            A reference to the object that contains the actual accessibility
77            information.
78
79        @see AccessibleContext
80	*/
81    XAccessibleContext getAccessibleContext ();
82};
83
84}; }; }; };
85
86#endif
87