offapi/com/sun/star/drawing/AccessibleShape.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_drawing_AccessibleShape_idl__
  21 #define __com_sun_star_drawing_AccessibleShape_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 module com {  module sun {  module star {  module drawing {
  28
  29 /** The AccessibleShape service is implemented by UNO shapes to
  30     provide accessibility information that describe the shape's features.
  31     A UNO shape is any object that implements the
  32     ::com::sun::star::drawing::XShape interface.
  33
  34     <p>The content of a draw page is modelled as tree of accessible shapes
  35     and accessible text paragraphs.  The root of this (sub-)tree is the
  36     accessible draw document view.  An accessible shape implements either
  37     this service or one of the "derived" services
  38     AccessibleGraphicShape or AccessibleOLEShape.
  39     See the section Children in the description of the
  40     ::com::sun::star::accessibility::XAccessibleContext
  41     interface support for more details.</p>
  42
  43     <p>There are two services that extend this one:  the
  44     AccessibleGraphicShape and the
  45     AccessibleOLEShape services provide additional interfaces.
  46     See there for details.</p>
  47
  48     <p>A shape object is either fully or partially visible on the screen or
  49     has set the ::com::sun::star::accessibility::AccessibleStateType::DEFUNC
  50     state to indicate that it is no longer
  51     actively supported by its parent.</p>
  52
  53     <p>Each shape object that has not set the DEFUNC state has a valid
  54     parent.  That is either the containing draw page or a group shape or a
  55     3D scene object.</p>
  56
  57      @since OOo 1.1.2
  58 */
  59 service AccessibleShape
  60 {
  61     /** Base interface for being accessible.  It gives access to the
  62         ::com::sun::star::accessibility::XAccessibleContext
  63         interface.
  64     */
  65     interface ::com::sun::star::accessibility::XAccessible;
  66
  67     /** Give access to the structural information of a shape.
  68
  69         <p>You can access the following information for the shape being made
  70         accessible:
  71         <ul>
  72         <li>Role: The role of all shapes is
  73         com::sun::star::accessibility::AccessibleRole::SHAPE.</li>
  74         <li>Name: The name of a shape is its localized type name.</li>
  75         <li>Description: Descriptions are localized and start with the
  76             shape's type and style.  After that follow some properties that
  77             differ from the defaults with respect to the style.
  78         <li>Children: The children of a shape are either other accessible
  79             shapes or accessible text paragraphs.  Only group shapes, 3D scene
  80             shapes, and OLE shapes may contain other shapes as children.
  81             Some of the shapes may have text paragraphs as (additional)
  82             children.  See ::com::sun::star::text::AccessibleParagraphView for
  83             details of how this text is represented.</li>
  84         <li>Parent: The parent is either the document view as represented by
  85             AccessibleDrawDocumentView or a group shape, 3D
  86             scene shape, or OLE shape.</li>
  87         <li>Relations: Are set and maintained from the outside.  See the
  88         service description of the object that has accessible shapes as
  89         children for details.</li>
  90         <li>States: The states supported by this service are:
  91             <ul>
  92             <li><p>com::sun::star::accessibility::AccessibleStateType::DEFUNC
  93                 is set if an accessible
  94                 shape is not visible but still existent for some reason.
  95                 This should not really happen and is a sign that someone,
  96                 e.g. an AT-Tool holds references to such a shape.  The
  97                 reason for this is that either the owner of the accessible
  98                 shape did not remove it from its list of children or that
  99                 the AT-Tool does not care for the events indicating
 100                 this.</p>
 101                 <p>Usually an object that has the
 102                 com::sun::star::accessibility::AccessibleStateType::DEFUNC
 103                 state set has already
 104                 been disposed and subsequent calls to this object result in
 105                 ::com::sun::star::lang::DisposedException
 106                 exceptions.</p>
 107                 <p>If this state is set then no other of the states below is
 108                 set.  This  is also true for the states that are otherwise
 109                 always set (which  makes "always" more of a sort of
 110                 "normally").</p></li>
 111             <li>com::sun::star::accessibility::AccessibleStateType::EDITABLE
 112                 is always set.
 113                 This state is interpreted to mean that not only text but
 114                 also other, graphical, properties of a shape can be modified.
 115                 </li>
 116             <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
 117                 is always set.</li>
 118             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
 119                 is always set.</li>
 120             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
 121                 is set according to
 122                 whether the shape currently has the focus.</li>
 123             <li>com::sun::star::accessibility::AccessibleStateType::MULTI_LINE
 124                 is set if a shape supports the
 125                 ::com::sun::star::accessibility::XAccessibleText interface.</li>
 126             <li>com::sun::star::accessibility::AccessibleStateType::OPAQUE
 127                 is set for certain shapes
 128                 with certain attributes like for a filled rectangle.</li>
 129             <li>com::sun::star::accessibility::AccessibleStateType::RESIZABLE
 130                 is always set.</li>
 131             <li>com::sun::star::accessibility::AccessibleStateType::SELECTABLE
 132                 is always set.</li>
 133             <li>com::sun::star::accessibility::AccessibleStateType::SELECTED
 134                 is set according to
 135                 whether the shape is currently selected.</li>
 136             <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
 137                 is always set.</li>
 138             <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
 139                 is always set.</li>
 140             </ul>
 141         <li>Locale: The shape returns the locale of its parent.</li>
 142         <li>Property change listeners: Property change listeners that are
 143             registered with a shape are informed of the usual events.</li>
 144         </ul>
 145     */
 146     interface ::com::sun::star::accessibility::XAccessibleContext;
 147
 148     /** Give access to the graphical representation of a shape.
 149
 150         <p>The bounding box returned by the
 151         ::com::sun::star::accessibility::XAccessibleComponent::getBounds()
 152         function returns the
 153         shape's bounding box clipped at its parent's bounding box</p>
 154
 155         <p>An accessible shape tries as best as it can to return proper
 156         values for calls to the
 157         ::com::sun::star::accessibility::XAccessibleExtendedComponent::getForeground()
 158         and
 159         ::com::sun::star::accessibility::XAccessibleExtendedComponent::getBackground()
 160         functions.
 161         If the shape is painted with a uniform and non-transparent color
 162         then the returned colors may differ from the ones visible on the
 163         screen.</p>
 164
 165         <p>Key bindings are not supported at the moment</p>
 166     */
 167     interface ::com::sun::star::accessibility::XAccessibleComponent;
 168
 169     /** Give extended access to the graphical representation of a shape.
 170
 171         <p>The functions
 172         ::com::sun::star::accessibility::XAccessibleExtendedComponent::getFont(),
 173         ::com::sun::star::accessibility::XAccessibleExtendedComponent::getTitledBorderText(), and
 174         ::com::sun::star::accessibility::XAccessibleExtendedComponent::getToolTipText()
 175         are not supported and return empty references respectively empty
 176         strings.</p>
 177
 178         <p>The support of this interface is optional to reduce overhead in
 179         case that no text is displayed and color information can not be
 180         determined with an acceptable cost.</p>
 181     */
 182     [optional] interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
 183 };
 184
 185 }; }; }; };
 186
 187 #endif
 188
 189 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */