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