1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10d1766043SAndrew Rist *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12d1766043SAndrew Rist *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19d1766043SAndrew Rist *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_text_AccessibleEndnoteView_idl__
24cdf0e10cSrcweir#define __com_sun_star_text_AccessibleEndnoteView_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
27cdf0e10cSrcweir#include <com/sun/star/accessibility/XAccessibleContext.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
31cdf0e10cSrcweir#include <com/sun/star/accessibility/XAccessibleComponent.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
35cdf0e10cSrcweir#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweirmodule com {  module sun {  module star {  module text {
42cdf0e10cSrcweir
43cdf0e10cSrcweir//=============================================================================
44cdf0e10cSrcweir
45cdf0e10cSrcweir/** The accessible view of endnotes.
46*2a413f17SJürgen Schmidt    @since OpenOffice 1.1.2
47cdf0e10cSrcweir */
48cdf0e10cSrcweirpublished service AccessibleEndnoteView
49cdf0e10cSrcweir{
50cdf0e10cSrcweir	/** This interface gives access to any paragraph fragment and table
51cdf0e10cSrcweir	    fragment that is contained in a endnote and is at least
52cdf0e10cSrcweir		partially visible on the screen.
53cdf0e10cSrcweir
54cdf0e10cSrcweir		<ul>
55cdf0e10cSrcweir			<li>The parent returned by
56cdf0e10cSrcweir                <method scope="::com::sun::star::accessibility"
57cdf0e10cSrcweir                >XAccessibleContext::getAccessibleParent</method>
58cdf0e10cSrcweir				is either the accessible view of a text document,
59cdf0e10cSrcweir				a page of the accessible page preview of a text document,
60cdf0e10cSrcweir				or the accessible page preview of a spreadsheet document.
61cdf0e10cSrcweir			<li>The children returned by
62cdf0e10cSrcweir                <method scope="::com::sun::star::accessibility"
63cdf0e10cSrcweir                >XAccessibleContext::getAccessibleChild</method> all
64cdf0e10cSrcweir				support the interface XAccessible. Calling
65cdf0e10cSrcweir				<method scope="::com::sun::star::accessibility"
66cdf0e10cSrcweir                >XAccessible::getAccessibleContext</method> for these children returns
67cdf0e10cSrcweir				an object that supports one of the following services.
68cdf0e10cSrcweir				<ul>
69cdf0e10cSrcweir					<li><type scope="::com::sun::star::text"
70cdf0e10cSrcweir                        >AccessibleParagraphView</type>:
71cdf0e10cSrcweir						A child of this kind is returned for every paragraph
72cdf0e10cSrcweir						fragment that is contained in the document body and
73cdf0e10cSrcweir						is at least partially visible. A paragraph fragment is
74cdf0e10cSrcweir						the part of a paragraph that is displayed on a
75cdf0e10cSrcweir						certain page.
76cdf0e10cSrcweir					<li><type scope="::com::sun::star::table"
77cdf0e10cSrcweir                        >AccessibleTableView</type>:
78cdf0e10cSrcweir						A child of this kind is returned for every table
79cdf0e10cSrcweir						fragment that is contained in the document body
80cdf0e10cSrcweir						and is at least partially visible. A table fragment is
81cdf0e10cSrcweir						the part of a table that is displayed on a certain page.
82cdf0e10cSrcweir				</ul>
83cdf0e10cSrcweir				<p>The logical order of paragraph and table fragments is never
84cdf0e10cSrcweir				   changed.
85cdf0e10cSrcweir			<li>The role is <const scope="::com::sun::star::accessibility"
86cdf0e10cSrcweir                >AccessibleRole::ENDNOTE</const>
87cdf0e10cSrcweir			<li>The name is "endnote" (or the equivalent term
88cdf0e10cSrcweir				in application's language) with a number appended.
89cdf0e10cSrcweir			<li>The description is endnote" (or the equivalent term
90cdf0e10cSrcweir				in application's language) with the endnote number or
91cdf0e10cSrcweir				character appended in the format that is specified in the
92cdf0e10cSrcweir				endnote settings.
93cdf0e10cSrcweir			<li>There are no relations. <em>TODO: One might specify a relation
94cdf0e10cSrcweir				to the endnote anchor's paragraph.</em>
95cdf0e10cSrcweir			<li>The following states might be contained in the state set
96cdf0e10cSrcweir				returned by <method scope="::com::sun::star::accessibility"
97cdf0e10cSrcweir                >XAccessibleContext::getAccessibleStateSet</method>:
98cdf0e10cSrcweir				<ul>
99cdf0e10cSrcweir					<li><const scope="::com::sun::star::accessibility"
100cdf0e10cSrcweir                        >AccessibleStateType::DEFUNC</const> (indicates that the
101cdf0e10cSrcweir                        document window has been closed or the endnote is
102cdf0e10cSrcweir						not existing any longer)
103cdf0e10cSrcweir					<li><const scope="::com::sun::star::accessibility"
104cdf0e10cSrcweir                        >AccessibleStateType::EDITABLE</const>
105cdf0e10cSrcweir					<li><const scope="::com::sun::star::accessibility"
106cdf0e10cSrcweir                        >AccessibleStateType::ENABLED</const> (always contained)
107cdf0e10cSrcweir					<li><const scope="::com::sun::star::accessibility"
108cdf0e10cSrcweir                        >AccessibleStateType::OPAQUE</const>
109cdf0e10cSrcweir					<li><const scope="::com::sun::star::accessibility"
110cdf0e10cSrcweir                        >AccessibleStateType::SHOWING</const>
111cdf0e10cSrcweir					<li><const scope="::com::sun::star::accessibility"
112cdf0e10cSrcweir                        >AccessibleStateType::VISIBLE</const>
113cdf0e10cSrcweir				</ul>
114cdf0e10cSrcweir			<li>Depending of the application's region setting, the locale is
115cdf0e10cSrcweir				the western, asian or complex default language of the document.
116cdf0e10cSrcweir		</ul>
117cdf0e10cSrcweir
118cdf0e10cSrcweir	 */
119cdf0e10cSrcweir	interface ::com::sun::star::accessibility::XAccessibleContext;
120cdf0e10cSrcweir
121cdf0e10cSrcweir	/** This interface describes the graphical representation of a
122cdf0e10cSrcweir	  	endnote.
123cdf0e10cSrcweir	 */
124cdf0e10cSrcweir	interface ::com::sun::star::accessibility::XAccessibleComponent;
125cdf0e10cSrcweir
126cdf0e10cSrcweir	/** This is the interface for listeners */
127cdf0e10cSrcweir	interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
128cdf0e10cSrcweir};
129cdf0e10cSrcweir
130cdf0e10cSrcweir//=============================================================================
131cdf0e10cSrcweir
132cdf0e10cSrcweir}; }; }; };
133cdf0e10cSrcweir
134cdf0e10cSrcweir#endif
135