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

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