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