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_AccessibleTextEmbeddedObjectView_idl__
24#define __com_sun_star_text_AccessibleTextEmbeddedObjectView_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_XAccessibleImage_idl__
35#include <com/sun/star/accessibility/XAccessibleImage.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//=============================================================================
45
46module com {  module sun {  module star {  module text {
47
48//=============================================================================
49
50/** The accessible view of an inactive embedded object. If an embedded
51    object gets active, the active document gets an accessible object
52	tree of its own. This tree is not a subtree of the object that supports
53	this service but of the document service itself. The tree exist only
54	until the ovject is deactivated.
55
56	 @since OpenOffice 1.1.2
57 */
58published service AccessibleTextEmbeddedObject
59{
60	/** This interface comprises the basic accessibility of embedded objects.
61
62		<ul>
63			<li>The parent returned by
64                <method scope="::com::sun::star::accessibility"
65                >XAccessibleContext::getAccessibleParent</method> is the
66                accessible view of a paragraph if the embedded object is
67                bound as character, and the accessible view of the document
68                (or of a page in the page preview) in any other case.
69			<li>There are no children returned by
70				<method scope="::com::sun::star::accessibility"
71                >XAccessibleContext::getAccessibleChild</method>. See above.
72			<li>The role is <const scope="::com::sun::star::accessibility"
73                >AccessibleRole::EMBEDDED_OBJECT</const>
74			<li>The name is the one assigned to the object in the text
75				document. This means that it is not internationalized.
76			<li>The description is the one assigned to the object in the text
77				document. This means that it is not internationalized. If no
78				description has been set, the description equals the name.
79			<li>There are no relations.
80			<li>The following states might be contained in the state set
81				returned by <method scope="::com::sun::star::accessibility"
82                >XAccessibleContext::getAccessibleStateSet</method>:
83				<ul>
84					<li><const scope="::com::sun::star::accessibility"
85                        >AccessibleStateType::DEFUNC</const> (indicates that
86                        the document window has been closed or the graphic
87                        is not existing any longer)
88					<li><const scope="::com::sun::star::accessibility"
89                        >AccessibleStateType::EDITABLE</const>
90					<li><const scope="::com::sun::star::accessibility"
91                        >AccessibleStateType::ENABLED</const> (always
92                        contained)
93					<li><const scope="::com::sun::star::accessibility"
94                        >AccessibleStateType::OPAQUE</const>
95					<li><const scope="::com::sun::star::accessibility"
96                        >AccessibleStateType::SELECTABLE</const>
97					<li><const scope="::com::sun::star::accessibility"
98                        >AccessibleStateType::SELECTED</const>
99					<li><const scope="::com::sun::star::accessibility"
100                        >AccessibleStateType::FOCUSABLE</const>
101					<li><const scope="::com::sun::star::accessibility"
102                        >AccessibleStateType::FOCUSED</const>
103					<li><const scope="::com::sun::star::accessibility"
104                        >AccessibleStateType::SHOWING</const>
105					<li><const scope="::com::sun::star::accessibility"
106                        >AccessibleStateType::VISIBLE</const>
107				</ul>
108			<li>The locale is the one the text document itself.
109		</ul>
110
111    */
112	interface ::com::sun::star::accessibility::XAccessibleContext;
113
114	/** This interface describes the graphical representation of an
115	  	embedded object.
116    */
117	interface ::com::sun::star::accessibility::XAccessibleComponent;
118
119	/** This interface gives access to the object's size and its description.
120    */
121	interface ::com::sun::star::accessibility::XAccessibleImage;
122
123	/** This is the interface for listeners
124    */
125	interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
126};
127
128//=============================================================================
129
130}; }; }; };
131
132#endif
133