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