offapi/com/sun/star/chart/AccessibleChartElement.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 #ifndef __com_sun_star_chart_AccessibleChartElement_idl__
  21 #define __com_sun_star_chart_AccessibleChartElement_idl__
  22
  23 #include <com/sun/star/accessibility/XAccessible.idl>
  24 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  25 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
  26
  27
  28 module com {  module sun {  module star {  module chart {
  29
  30 /** This service is supported by all components that are contained in
  31     the view of a chart document that are controlled by the chart.
  32     Shapes added by a user via the clipboard are not treated as chart
  33     elements.
  34
  35     <p>The list of objects that implement this service is
  36     ::com::sun::star::chart::ChartTitle,
  37     ::com::sun::star::chart::ChartLegend,
  38     ::com::sun::star::chart::Diagram,
  39     ::com::sun::star::chart::ChartAxis,
  40     ::com::sun::star::chart::ChartDataRowProperties,
  41     ::com::sun::star::chart::ChartDataPointProperties.
  42     </p>
  43
  44     <p>The
  45        ::com::sun::star::accessibility::XAccessibleExtendedComponent
  46        is supported by all chart elements.</p>
  47
  48     @since OOo 1.1.2
  49 */
  50 service AccessibleChartElement
  51 {
  52     /** Base interface for being accessible.  It gives access to the
  53         ::com::sun::star::accessibility::XAccessibleContext
  54         interface.
  55     */
  56     interface ::com::sun::star::accessibility::XAccessible;
  57
  58     /** Give access to the structural information of a chart element.
  59
  60         <p>You can access the following information for the shapes of the above listed types:
  61         <dl>
  62          <dt>Role</dt>
  63              <dd>All chart elements have the role
  64              ::com::sun::star::accessibility::AccessibleRole::SHAPE.
  65              </dd>
  66          <dt>Name</dt>
  67              <dd>For unique elements you get fixed names.  The unique
  68              elements are the titles, legend, diagram and axes.  The
  69              names you get for them are "main-title", "sub-title",
  70              "(x|y|z)-axis-title", "legend", "diagram", "(x|y|z)-axis"
  71              and "second-(x|y)-axis", respectively.</dd>
  72          <dt>Description</dt>
  73              <dd>Descriptions contain a list of selected
  74              attributes.  These attributes are, if applicable:
  75              foreground and background color, line width, font name and
  76              size.  The purpose of these attributes is to give a rough
  77              description of the more simple geometric shapes.  The list
  78              is very restricted in order to avoid overwhelming or
  79              confusing the user.</dd>
  80          <dt>Children</dt>
  81              <dd>The ::com::sun::star::chart::Diagram and
  82              the ::com::sun::star::chart::ChartLegend
  83              contain children, all other objects in a chart do not, i.e., are
  84              leaves in the document representation tree.</dd>
  85          <dt>Parent</dt>
  86              <dd>Because the <code>setParent</code> method from the JAVA has
  87              been removed, the reference to the parent has to be provided in an
  88              implementation specific way.</dd>
  89          <dt>Relations</dt>
  90              <dd>They are not used at the moment.</dd>
  91
  92          <dt>States</dt>
  93              <dd>The states supported by this service are:
  94              <ul>
  95
  96               <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
  97                   is set if an object was removed.  This indicates that the user
  98                   should release all references to the accessible object.  If
  99                   this state is set then no other of the states below is set.
 100                   </li>
 101               <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE</li>
 102               <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
 103                   is always set.<sup>*</sup></li>
 104               <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_LINE
 105                   is set for all titles.</li>
 106               <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
 107                   is set for all elements that do have a transparency
 108                   attributes set to 0% and no transparency gradient.</li>
 109               <li>::com::sun::star::accessibility::AccessibleStateType::RESIZABLE
 110                   Is set for the diagram object only.  All other chart elements may not be resized.</li>
 111               <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE</li>
 112               <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED</li>
 113               <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
 114                   is always set.<sup>*</sup></li>
 115               <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
 116                   is always set.<sup>*</sup></li>
 117              </ul>
 118              <sup>*</sup>always, except if the state
 119              ::com::sun::star::accessibility::AccessibleStateType::DEFUNC
 120              is set.</dd>
 121          <dt>Locale</dt>
 122              <dd>is supported.</dd>
 123          <dt>Property change listeners</dt>
 124              <dd>Property change listeners that are registered with a chart
 125              element are informed if the size or position or an attribute
 126              changed.  The last point needs a short explanation: An attribute
 127              change is signaled even if that attribute is not part of the
 128              shape's description and is therefore not explicitly represented by
 129              the UAA.</dd>
 130         </dl>
 131     */
 132     interface ::com::sun::star::accessibility::XAccessibleContext;
 133
 134     /** Give access to the graphical representation of a chart element.
 135
 136     <p>The coordinate oriented methods <code>contains</code>,
 137         <code>getAccessibleAt</code>, <code>getBounds</code>,
 138         <code>getLocation</code>, <code>getLocationOnScreen</code>, and
 139         <code>getSize</code> work on pixel coordinates.  (To transform between
 140         the internal 100th of mm and pixels a chart element has to have access
 141         to information that allows it to do so.  These information are the
 142         enclosing window's size in pixel, 100th of mm, and its own relative
 143         position in one or the other coordinate system).</p>
 144
 145         <p>Focus handling depends on support of the
 146         ::com::sun::star::accessibility::XAccessibleText and
 147         ::com::sun::star::accessibility::XAccessibleEditableText
 148         interfaces.</p>
 149
 150         <p>Key bindings are not supported at the moment</p>
 151     */
 152     interface ::com::sun::star::accessibility::XAccessibleComponent;
 153
 154     /** Give extended access to the graphical representation of a chart element.
 155
 156         <p>This interface is used primarily to provide the predominant
 157         foreground and background colors and&mdash;if applicable, i.e. the
 158         ::com::sun::star::accessibility::XAccessibleText
 159         interface is supported&mdash;information about the font used to display
 160         text.</p>
 161
 162         <p>The foreground and background colors may in some cases be directly
 163         taken from the object.  In other cases, for example when a gradient or a
 164         texture is used, they have to be interpolated.  The color returned may
 165         not be appropriate in all cases.</p>
 166
 167         <p>Specifying the font used for displaying text depends on the
 168         transformation of UNO API font information into the Java&trade; format.
 169         However, if the UAA is used directly, this is of course not an
 170         issue.</p>
 171
 172         <p>The support of this interface is optional to reduce overhead in case
 173         that no text is displayed and color information can not be determined
 174         with an acceptable cost.</p>
 175     */
 176     [optional] interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
 177 };
 178
 179 }; }; }; };
 180
 181 #endif
 182
 183 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */