offapi/com/sun/star/chart/AccessibleChartDocumentView.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com {  module sun {  module star {  module chart {
  21
  22 /** The AccessibleChartDocumentView service is supported
  23     by a Component that represents the view of a Chart document to
  24     provide an entry point to the document tree for accessibility.
  25
  26     <p>An object that implements the AccessibleChartDocumentView
  27     service provides information about itself and about the chart
  28     subcomponents contained in the chart document displayed in a
  29     window.  This service gives a simplified view on the underlying
  30     implementation.  It tries both to keep the structure of the
  31     accessibility representation tree as simple as possible and
  32     provide as much relevant information as possible.</p>
  33
  34     @since OOo 1.1.2
  35 */
  36 service AccessibleChartDocumentView
  37 {
  38     /** Base interface for being accessible.  It gives access to the
  39         ::com::sun::star::accessibility::XAccessibleContext
  40         interface.
  41     */
  42     interface ::com::sun::star::accessibility::XAccessible;
  43
  44     /** Provide access to a Chart document's view.
  45
  46         <p>You can access the following information:</p>
  47         <dl>
  48          <dt>Role</dt>
  49              <dd>The object's role is
  50              com::sun::star::accessibility::AccessibleRole::DOCUMENT.</dd>
  51          <dt>Name</dt>
  52              <dd>Its name is the document's name or the base name of the filename if
  53              no document name has been set explicitly.</dd>
  54          <dt>Description</dt>
  55              <dd>The description is the document's description or the
  56              full filename if no description has been set
  57              explicitly.</dd>
  58           <dt>Children</dt>
  59              <dd>The subcomponents of a chart.  This includes all kinds of
  60              titles, a legend and the diagram.  The diagram and the legend are
  61              the only children that themselves contain children.  The Chart
  62              subcomponents support the service
  63              AccessibleChartElement.  Additionally, there may be
  64              shapes a user added via the clipboard.  For details see the
  65              ::com::sun::star::drawing::AccessibleShape.
  66              </dd>
  67          <dt>Parent</dt>
  68              <dd>The parent will usually be the window that contains the
  69              Chart document view.  It has to be set via implementation dependent
  70              ways.</dd>
  71          <dt>Relations</dt>
  72              <dd>At the moment relations are not supported.  The method
  73              com::sun::star::accessibility::XAccessibleContext::getAccessibleRelationSet()
  74              will always return an empty set.</dd>
  75          <dt>States</dt>
  76              <dd>The following states are supported:
  77              <ul>
  78               <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
  79                   is set if a document view becomes obsolete like when
  80                   the window, which displays the view, is closed.</li>
  81               <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
  82                   is always set unless the
  83                   com::sun::star::accessibility::AccessibleStateType::DEFUNC
  84                   state is set.</li>
  85               <li>com::sun::star::accessibility::AccessibleStateType::OPAQUE
  86                   is always set.</li>
  87               <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  88                   is always set unless the
  89                   com::sun::star::accessibility::AccessibleStateType::DEFUNC
  90                   state is set.</li>
  91               <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  92                   is always set unless the
  93                   com::sun::star::accessibility::AccessibleStateType::DEFUNC
  94                   state is set.</li>
  95              </ul>
  96              </dd>
  97          <dt>Locale</dt>
  98              <dd>Is the locale set at the document.</dd>
  99          <dt>Property change listeners</dt>
 100              <dd>They are supported to inform the
 101              listeners about changes in this object.</dd>
 102         </dl>
 103     */
 104     interface ::com::sun::star::accessibility::XAccessibleContext;
 105
 106     /** Provide access to a Chart document's graphical representation.
 107
 108         <p>The main purpose of this interface is to provide a bounding
 109         box of the currently visible area and to let the user find the
 110         subcomponents of a chart that cover a given test point.</p>
 111
 112         <p>The accessible Chart subcomponents all support the service
 113         AccessibleChartElement</p>
 114
 115         @see AccessibleChartElement
 116     */
 117     interface ::com::sun::star::accessibility::XAccessibleComponent;
 118 };
 119
 120 }; }; }; };
 121
 122 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */