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