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

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