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