offapi/com/sun/star/drawing/AccessibleDrawDocumentView.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessibleDrawDocumentView.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_drawing_AccessibleGraphicShape_idl__
  32 #define __com_sun_star_drawing_AccessibleGraphicShape_idl__
  33
  34 #ifndef __com_sun_star_accessibility_XAccessible_idl__
  35 #include <com/sun/star/accessibility/XAccessible.idl>
  36 #endif
  37 #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
  38 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  39 #endif
  40 #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
  41 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  42 #endif
  43
  44 module com {  module sun {  module star {  module drawing {
  45
  46 /** The <type>AccessibleDrawDocumentView</type> service is implemented by
  47     views of Draw and Impress documents.
  48
  49     <p>An object that implements the <type>AccessibleDrawDocumentView</type>
  50     service provides information about the view of a Draw or Impress
  51     document in one of the various view modes.  With its children it gives
  52     access to the current page and the shapes on that page.</p>
  53
  54     <p>This service gives a simplified view on the underlying document.  It
  55     tries both to keep the structure of the accessibility representation
  56     tree as simple as possible and provide as much relevant information as
  57     possible.  This has the following consequences:
  58     <ol>
  59     <li>Only the current draw page and only the visible shapes are
  60     accessible.  To switch to another page or to access shapes that lie
  61     outside the currently visible area, the user has to issue these requests
  62     manually or programmatically through the usual chanels, e.g. pressing
  63     keys or selecting menu entries.</li>
  64     <li>The hierarchy exposed through the
  65     <type scope="::com::sun::star::accessibility">XAccessibleContext</type>
  66     interface does not necessarily correspond directly to the underlying
  67     draw page structure.  Internal nodes in this hierarchy are introduced
  68     by group shapes, 3D scenes, and OLE objects.</li>
  69     <li>The view modes editing view, outline view, slides view, notes view,
  70     handout view, and presentation view are not exposed explicitly.
  71     However, if there happens to be a view mode change which results in a
  72     rearrangement of the visible shapes, the user gets notified of this.</li>
  73     </ol></p>
  74
  75      @since OOo 1.1.2
  76 */
  77 published service AccessibleDrawDocumentView
  78 {
  79     /** Base interface for being accessible.  It gives access to the
  80         <type scope="::com::sun::star::accessibility">XAccessibleContext</type>
  81         interface.
  82     */
  83     interface ::com::sun::star::accessibility::XAccessible;
  84
  85     /** Provide access to the view of a document.
  86
  87         <p>You can access the following information:
  88         <ul>
  89         <li>Role: The object's role is <const
  90             scope="com::sun::star::accessibility"
  91                 >AccessibleRole::DOCUMENT</const>.</li>
  92         <li>Name: Its name is "AccessibleDrawDocumentView",
  93         "AccessibleOutlineView", or "slide window".</li>
  94         <li>Description: The description is "Draw Document", "Accessible
  95         Draw Document Outline", or "slide window".</li>
  96         <li>Children: The shapes of the current draw page that are currently
  97             visible are direct and indirect children of (an object
  98             implementing)
  99             this service.  Group shapes, 3D scenes, and OLE objects
 100             introduce further levels into the hierarchy.  If the visibility
 101             of shapes changes--due to
 102             scrolling, switching the current draw page, or changing the view
 103             mode--the appropriate listeners are called and the user gets
 104             informed of this.</li>
 105         <li>Parent: The parent will usually be the window that contains the
 106             draw document view.  It has to be set via implementation dependend
 107             ways.</li>
 108         <li>Relations: Relations are set and modified from the outside.</li>
 109         <li>States: <const scope="com::sun::star::accessibility"
 110                 >AccessibleStateType::DEFUNC</const> is set if a document view
 111                 becomes obsolete like when the window, which displays the view,
 112                 is closed.  Otherwise the states
 113                 <const scope="com::sun::star::accessibility"
 114                     >AccessibleStateType::ENABLED</const>,
 115                 <const scope="com::sun::star::accessibility"
 116                     >AccessibleStateType::SHOWING</const>,
 117                 <const scope="com::sun::star::accessibility"
 118                     >AccessibleStateType::VISIBLE</const>,
 119                 <const scope="com::sun::star::accessibility"
 120                     >AccessibleStateType::FOCUSABLE</const>, and
 121                 <const scope="com::sun::star::accessibility"
 122                    >AccessibleStateType::SELECTABLE</const>
 123             are always set.</li>
 124         <li>Locale: Is obtained from the parent and returned unchanged.</li>
 125         </ul></p>
 126     */
 127     interface ::com::sun::star::accessibility::XAccessibleContext;
 128
 129     /** Provide access to a draw document's graphical representation.
 130
 131         <p>The main purpose of this interface is to provide a bounding box
 132         of the currently visible area and to let the user find children
 133         (i.e. shapes) that cover a given test point.  The more interesting
 134         part of the graphical representation of a draw page lies in its
 135         children.  See the <type>AccessibleShape</type> service for more
 136         information about shapes.</p>
 137
 138         @see AccessibleShape
 139     */
 140     interface ::com::sun::star::accessibility::XAccessibleComponent;
 141 };
 142
 143 }; }; }; };
 144
 145 #endif