1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_text_AccessibleTextDocumentView_idl__
#define __com_sun_star_text_AccessibleTextDocumentView_idl__
#include <com/sun/star/accessibility/XAccessibleContext.idl>
#include <com/sun/star/accessibility/XAccessibleComponent.idl>
#include <com/sun/star/accessibility/XAccessibleSelection.idl>
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
module com { module sun { module star { module text {
/** The accessible view of a text document.
@since OOo 1.1.2
*/
service AccessibleTextDocumentView
{
/** This interface gives access to any text, table, graphic, embedded
object and drawing that is at least partially visible on the screen.
The tree that arises from the children of this object reflects the
structure of the document as it is displayed.
<ul>
<li>The children returned by
::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
all support the interface XAccessible. Calling
::com::sun::star::accessibility::XAccessible::getAccessibleContext()
for these children returns an object that supports one of the
following services.
<ul>
<li>::com::sun::star::text::AccessibleHeaderFooterView:
A child of this kind is returned for every header
and footer that is at least partially visible.
<li>::com::sun::star::text::AccessibleFootnoteView:
A child of this kind is returned for every footnote
that is at least partially visible.
<li>::com::sun::star::text::AccessibleEndnoteView:
A child of this kind is returned for every endnote
that is at least partially visible.
<li>::com::sun::star::text::AccessibleParagraphView:
A child of this kind is returned for every paragraph
fragment that is contained in the document body and
is at least partially visible. A paragraph fragment is
the part of a paragraph that is displayed on a
certain page.
<li>::com::sun::star::table::AccessibleTableView:
A child of this kind is returned for every table
fragment that is contained in the document body
and is at least partially visible. A table fragment is
the part of a table that is displayed on a certain page.
<li>::com::sun::star::text::AccessibleTextFrameView:
A child of this
kind is returned for every text frame that is at
least partially visible. These objects are children
of the
AccessibleTextDocumentView regardless
whether they are bound to a page, a paragraph, a
frame, or a character. The only exception are text
frames that are bound as character. They are children
of the paragraph they are contained in.
<li>::com::sun::star::text::AccessibleTextGraphicObject:
A child of this kind is returned for every graphic that
is at least partially visible. These objects are
children of the AccessibleTextDocumentView
regardless whether they are bound to a page, paragraph,
a frame or a character. The only exception
are text frames that are bound as character. They are
children of the paragraph they are contained in.
<li>::com::sun::star::text::AccessibleTextEmbeddedObject:
A child of this kind is returned for every embedded
object that is at least partially visible.
These objects are children of the
AccessibleTextDocumentView regardless
whether they are bound to a page, a paragraph, a frame,
or a character. They are children of the paragraph they
are contained in.
<li>::com::sun::star::drawing::AccessibleShape:
A child of this kind (or a
derived interface) is returned for every shape that
is at least partially visible. These objects are
children of the
AccessibleTextDocumentView regardless
whether they are bound to a page, a paragraph, a
frame or a character.
</ul>
<p>The following rules apply to the children order:
<ul>
<li>The logical order of paragraph and table fragments is
never changed.
<li>Headers appear immediately before the first paragraph or
table fragment of the header's page.
<li>Footnotes appear immediately after the last paragraph or
table fragment of the footnote's page. The logical order
of footnotes isn't changed.
<li>Endnotes appear immediately after the last footnote of
the endnote's page or after the last paragraph or
table fragment of this page if there are no footnotes.
The logical order of endnotes isn't changed.
<li>Footers appear immediately after the last endnote,
footnote, paragraph or table fragment of the footer's
page.
<li>Text frames, graphics, embedded objects and shapes that
are painted in the background appear before any other
children. Their order reflects the z order.
<li>Text frames, graphics, embedded objects and shapes
that are painted in the foreground appear behind any
other children. Their order reflects the z order,
with the exception of controls that appear really last,
but also keep the z order.
</ul>
<li>The role is
::com::sun::star::accessibility::AccessibleRole::DOCUMENT_TEXT.
<li>The name is "document view" (or the equivalent term
in application's language).
<li>The description also is "document view" (or the equivalent term
in application's language).
<li>There are no relation sets.
<li>The following states might be contained in the state set
returned by
::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet():
<ul>
<li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
(indicates that the document window has been closed)
<li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE
<li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
(always contained)
<li>::com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE
(always contained)
<li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
(always contained)
<li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
<li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
</ul>
<li>Depending of the application's region setting, the locale is
the western, Asian or complex default language of the document.
</ul>
*/
interface ::com::sun::star::accessibility::XAccessibleContext;
/** This interface describes the graphical representation of a text
document view.
*/
interface ::com::sun::star::accessibility::XAccessibleComponent;
/** This interface is for selecting the document's children. Selectable
are any children with the exception of headers, footers, footnotes
and endnotes, where only the grandchildren might be selectable.
*/
interface ::com::sun::star::accessibility::XAccessibleSelection;
/** This is the interface for listeners
*/
interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
