offapi/com/sun/star/accessibility/XAccessible.idl

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