xref: /AOO41X/main/offapi/com/sun/star/text/AccessibleTextDocumentPageView.idl (revision 2a413f170de95afb9972effe5557e28dd83e2121)
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#ifndef __com_sun_star_text_AccessibleTextDocumentPageView_idl__
24#define __com_sun_star_text_AccessibleTextDocumentPageView_idl__
25
26#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
27#include <com/sun/star/accessibility/XAccessibleContext.idl>
28#endif
29
30#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
31#include <com/sun/star/accessibility/XAccessibleComponent.idl>
32#endif
33
34#ifndef __com_sun_star_accessibility_XAccessibleSelection_idl__
35#include <com/sun/star/accessibility/XAccessibleSelection.idl>
36#endif
37
38#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
39#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
40#endif
41
42
43//=============================================================================
44
45module com {  module sun {  module star {  module text {
46
47//=============================================================================
48
49/** The accessible page preview of a text document.
50
51     @since OpenOffice 1.1.2
52 */
53published service AccessibleTextDocumentPageView
54{
55    /** This interface gives access to page that are visible in the
56        page preview of a text document.
57        <ul>
58            <li>The children returned by
59                <method scope="::com::sun::star::accessibility"
60                >XAccessibleContext::getAccessibleChild</type> all support
61                the interface XAccessible. Calling
62                <method scope="::com::sun::star::accessibility"
63                >XAccessible::getAccessibleContext</type> for these children
64                returns an object that supports one of the service
65                <type scope="::com::sun::star::text"
66                >AccessiblePageView</type>.
67            <li>The role is <const scope="::com::sun::star::accessibility"
68                >AccessibleRole::DOCUMENT</const>.
69            <li>The name is "document view" (or the equivalent term
70                in application's language).
71            <li>The description also is "document view" (or the equivalent term
72                in application's language).
73            <li>There are no relation sets.
74            <li>The following states might be contained in the state set
75                returned by <method scope="::com::sun::star::accessibility"
76                >XAccessibleContext::getAccessibleStateSet</method>:
77                <ul>
78                    <li><const scope="::com::sun::star::accessibility"
79                        >AccessibleStateType::DEFUNC</const> (indicates that
80                        the document window has been closed)
81                    <li><const scope="::com::sun::star::accessibility"
82                        >AccessibleStateType::ENABLED</const> (always
83                        contained)
84                    <li><const scope="::com::sun::star::accessibility"
85                        >AccessibleStateType::OPAQUE</const> (always
86                        contained)
87                    <li><const scope="::com::sun::star::accessibility"
88                        >AccessibleStateType::SHOWING</const>
89                    <li><const scope="::com::sun::star::accessibility"
90                        >AccessibleStateType::VISIBLE</const>
91                </ul>
92            <li>The locale is the application's locale.
93        </ul>
94
95    */
96    interface ::com::sun::star::accessibility::XAccessibleContext;
97
98    /** This interface describes the graphical representation of a text
99        document view.
100    */
101    interface ::com::sun::star::accessibility::XAccessibleComponent;
102
103    /** This is the interface for listeners
104    */
105    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
106};
107
108//=============================================================================
109
110}; }; }; };
111
112#endif
113