offapi/com/sun/star/accessibility/AccessibleContext.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: AccessibleContext.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 #ifndef __com_sun_star_accessibility_AccessibleContext_idl__
  31 #define __com_sun_star_accessibility_AccessibleContext_idl__
  32
  33 module com { module sun { module star { module accessibility {
  34
  35  published interface XAccessibleContext;
  36  published interface XAccessibleEventBroadcaster;
  37
  38 /** Central service of the Accessibility API that gives access to various
  39     facets of an object's content.
  40
  41     <p>This service has to be implemented by every class that represents the
  42     actual accessibility information of another UNO service.  It exposes two
  43     kinds of information: A tree structure in which all accessible objects
  44     are organized can be navigated in freely.  It typically represents
  45     spatial relationship of one object containing a set of children like a
  46     dialog box contains a set of buttons.  Additionally the
  47     <type>XAccessibleContext</type> interface of this service exposes
  48     methods that provide access to the actual object's content.  This can be
  49     the object's role, name, description, and so on.</p>
  50
  51     @see XAccessibleContext
  52
  53     @since OOo 1.1.2
  54 */
  55 published service AccessibleContext
  56 {
  57     interface XAccessibleContext;
  58
  59     /** is implemented by accessible contexts that supports broadcasting of
  60         accessible events.
  61
  62         @see AccessibleEventObject
  63         @see AccessibleEventId
  64     */
  65     [optional] interface XAccessibleEventBroadcaster;
  66 };
  67
  68 }; }; }; };
  69
  70 #endif