offapi/com/sun/star/chart/AccessibleChartDocumentView.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: AccessibleChartDocumentView.idl,v $
  10  * $Revision: 1.8 $
  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_chart_AccessibleChartDocumentView_idl__
  32 #define __com_sun_star_chart_AccessibleChartDocumentView_idl__
  33
  34 #ifndef __com_sun_star_accessibility_XAccessible_idl__
  35 #include <com/sun/star/accessibility/XAccessible.idl>
  36 #endif
  37 #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
  38 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  39 #endif
  40 #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
  41 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  42 #endif
  43
  44 module com {  module sun {  module star {  module chart {
  45
  46 /** The <type>AccessibleChartDocumentView</type> service is supported
  47     by a Component that represents the view of a Chart document to
  48     provide an entry point to the document tree for accessibility.
  49
  50     <p>An object that implements the <type>AccessibleChartDocumentView</type>
  51     service provides information about itself and about the chart
  52     subcomponents contained in the chart document displayed in a
  53     window.  This service gives a simplified view on the underlying
  54     implementation.  It tries both to keep the structure of the
  55     accessibility representation tree as simple as possible and
  56     provide as much relevant information as possible.</p>
  57
  58     @since OOo 1.1.2
  59 */
  60 published service AccessibleChartDocumentView
  61 {
  62     /** Base interface for being accessible.  It gives access to the
  63         <type scope="::com::sun::star::accessibility">XAccessibleContext</type>
  64         interface.
  65     */
  66     interface ::com::sun::star::accessibility::XAccessible;
  67
  68     /** Provide access to a Chart document's view.
  69
  70         <p>You can access the following information:</p>
  71         <dl>
  72          <dt>Role</dt>
  73              <dd>The object's role is
  74              <const scope="com::sun::star::accessibility">AccessibleRole::DOCUMENT</const>.</dd>
  75          <dt>Name</dt>
  76              <dd>Its name is the document's name or the base name of the filename if
  77              no document name has been set explicitly.</dd>
  78          <dt>Description</dt>
  79              <dd>The description is the document's description or the
  80              full filename if no description has been set
  81              explicitly.</dd>
  82           <dt>Children</dt>
  83              <dd>The subcomponents of a chart.  This includes all kinds of
  84              titles, a legend and the diagram.  The diagram and the legend are
  85              the only children that themselves contain children.  The Chart
  86              subcomponents support the service
  87              <type>AccessibleChartElement</type>.  Additionally, there may be
  88              shapes a user added via the clipboard.  For details see the
  89              <type scope="::com::sun::star::drawing">AccessibleShape</type>.
  90              </dd>
  91          <dt>Parent</dt>
  92              <dd>The parent will usually be the window that contains the
  93              Chart document view.  It has to be set via implementation dependent
  94              ways.</dd>
  95          <dt>Relations</dt>
  96              <dd>At the moment relations are not supported.  The method
  97              <member scope="com::sun::star::accessibility">XAccessibleContext::getAccessibleRelationSet</member>
  98              will always return an empty set.</dd>
  99          <dt>States</dt>
 100              <dd>The following states are supported:
 101              <ul>
 102               <li><const scope="com::sun::star::accessibility">AccessibleStateType::DEFUNC</const>
 103                   is set if a document view becomes obsolete like when
 104                   the window, which displays the view, is closed.</li>
 105               <li><const scope="com::sun::star::accessibility">AccessibleStateType::ENABLED</const>
 106                   is always set unless the
 107                   <const scope="com::sun::star::accessibility">AccessibleStateType::DEFUNC</const>
 108                   state is set.</li>
 109               <li><const scope="com::sun::star::accessibility">AccessibleStateType::OPAQUE</const>
 110                   is always set.</li>
 111               <li><const scope="com::sun::star::accessibility">AccessibleStateType::SHOWING</const>
 112                   is always set unless the
 113                   <const scope="com::sun::star::accessibility">AccessibleStateType::DEFUNC</const>
 114                   state is set.</li>
 115               <li><const scope="com::sun::star::accessibility">AccessibleStateType::VISIBLE</const>
 116                   is always set unless the
 117                   <const scope="com::sun::star::accessibility">AccessibleStateType::DEFUNC</const>
 118                   state is set.</li>
 119              </ul>
 120              </dd>
 121          <dt>Locale</dt>
 122              <dd>Is the locale set at the document.</dd>
 123          <dt>Property change listeners</dt>
 124              <dd>They are supported to inform the
 125              listeners about changes in this object.</dd>
 126         </dl>
 127     */
 128     interface ::com::sun::star::accessibility::XAccessibleContext;
 129
 130     /** Provide access to a Chart document's graphical representation.
 131
 132         <p>The main purpose of this interface is to provide a bounding
 133         box of the currently visible area and to let the user find the
 134         subcomponents of a chart that cover a given test point.</p>
 135
 136         <p>The accessible Chart subcomponents all support the service
 137         <type>AccessibleChartElement</type></p>
 138
 139         @see AccessibleChartElement
 140     */
 141     interface ::com::sun::star::accessibility::XAccessibleComponent;
 142 };
 143
 144 }; }; }; };
 145
 146 #endif