offapi/com/sun/star/drawing/AccessibleDrawDocumentView.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 drawing {
  21
  22 /** The AccessibleDrawDocumentView service is implemented by
  23     views of Draw and Impress documents.
  24
  25     <p>An object that implements the AccessibleDrawDocumentView
  26     service provides information about the view of a Draw or Impress
  27     document in one of the various view modes.  With its children it gives
  28     access to the current page and the shapes on that page.</p>
  29
  30     <p>This service gives a simplified view on the underlying document.  It
  31     tries both to keep the structure of the accessibility representation
  32     tree as simple as possible and provide as much relevant information as
  33     possible.  This has the following consequences:
  34     <ol>
  35     <li>Only the current draw page and only the visible shapes are
  36     accessible.  To switch to another page or to access shapes that lie
  37     outside the currently visible area, the user has to issue these requests
  38     manually or programmatically through the usual channels, e.g. pressing
  39     keys or selecting menu entries.</li>
  40     <li>The hierarchy exposed through the
  41     ::com::sun::star::accessibility::XAccessibleContext
  42     interface does not necessarily correspond directly to the underlying
  43     draw page structure.  Internal nodes in this hierarchy are introduced
  44     by group shapes, 3D scenes, and OLE objects.</li>
  45     <li>The view modes editing view, outline view, slides view, notes view,
  46     handout view, and presentation view are not exposed explicitly.
  47     However, if there happens to be a view mode change which results in a
  48     rearrangement of the visible shapes, the user gets notified of this.</li>
  49     </ol></p>
  50
  51      @since OOo 1.1.2
  52 */
  53 service AccessibleDrawDocumentView
  54 {
  55     /** Base interface for being accessible.  It gives access to the
  56         ::com::sun::star::accessibility::XAccessibleContext
  57         interface.
  58     */
  59     interface ::com::sun::star::accessibility::XAccessible;
  60
  61     /** Provide access to the view of a document.
  62
  63         <p>You can access the following information:
  64         <ul>
  65         <li>Role: The object's role might be
  66             com::sun::star::accessibility::AccessibleRole::DOCUMENT or
  67             com::sun::star::accessibility::AccessibleRole::DOCUMENT_PRESENTATION
  68             , the former for a Draw and the latter for an Impress document.</li>
  69         <li>Name: Its name is "AccessibleDrawDocumentView",
  70         "AccessibleOutlineView", or "slide window".</li>
  71         <li>Description: The description is "Draw Document", "Accessible
  72         Draw Document Outline", or "slide window".</li>
  73         <li>Children: The shapes of the current draw page that are currently
  74             visible are direct and indirect children of (an object
  75             implementing)
  76             this service.  Group shapes, 3D scenes, and OLE objects
  77             introduce further levels into the hierarchy.  If the visibility
  78             of shapes changes--due to
  79             scrolling, switching the current draw page, or changing the view
  80             mode--the appropriate listeners are called and the user gets
  81             informed of this.</li>
  82         <li>Parent: The parent will usually be the window that contains the
  83             draw document view.  It has to be set via implementation dependent
  84             ways.</li>
  85         <li>Relations: Relations are set and modified from the outside.</li>
  86         <li>States: com::sun::star::accessibility::AccessibleStateType::DEFUNC
  87             is set if a document view
  88                 becomes obsolete like when the window, which displays the view,
  89                 is closed.  Otherwise the states
  90                 com::sun::star::accessibility::AccessibleStateType::ENABLED,
  91                 com::sun::star::accessibility::AccessibleStateType::SHOWING,
  92                 com::sun::star::accessibility::AccessibleStateType::VISIBLE,
  93                 com::sun::star::accessibility::AccessibleStateType::FOCUSABLE,
  94                 and
  95                 com::sun::star::accessibility::AccessibleStateType::SELECTABLE
  96             are always set.</li>
  97         <li>Locale: Is obtained from the parent and returned unchanged.</li>
  98         </ul></p>
  99     */
 100     interface ::com::sun::star::accessibility::XAccessibleContext;
 101
 102     /** Provide access to a draw document's graphical representation.
 103
 104         <p>The main purpose of this interface is to provide a bounding box
 105         of the currently visible area and to let the user find children
 106         (i.e. shapes) that cover a given test point.  The more interesting
 107         part of the graphical representation of a draw page lies in its
 108         children.  See the AccessibleShape service for more
 109         information about shapes.</p>
 110
 111         @see AccessibleShape
 112     */
 113     interface ::com::sun::star::accessibility::XAccessibleComponent;
 114 };
 115
 116 }; }; }; };
 117
 118 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */