blob: 4ae18122bdfcb65aed415cd6349f1e41e2aec301 (
plain)
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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_text_AccessibleHeaderFooterView_idl__
#define __com_sun_star_text_AccessibleHeaderFooterView_idl__
#include <com/sun/star/accessibility/XAccessibleContext.idl>
#include <com/sun/star/accessibility/XAccessibleComponent.idl>
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
module com { module sun { module star { module text {
/** The accessible view of headers and footers.
@since OOo 1.1.2
*/
published service AccessibleHeaderFooterView
{
/** This interface gives access to any paragraph and table that is
contained in the header and footer and is at least partially visible
on the screen.
<ul>
<li>The parent returned by
<method scope="::com::sun::star::accessibility"
>XAccessibleContext::getAccessibleParent</method>
is either the accessible view of a text document,
a page of the accessible page preview of a text document,
or the accessible page preview of a spreadsheet document.
<li>The children returned by
<method scope="::com::sun::star::accessibility"
>XAccessibleContext::getAccessibleChild</method> all
support the interface XAccessible. Calling
<method scope="::com::sun::star::accessibility"
>XAccessible::getAccessibleContext</method> for these children returns
an object that supports one of the following services.
<ul>
<li><type scope="::com::sun::star::text"
>AccessibleParagraphView</type>:
A child of this kind is returned for every paragraph
that is contained in the document body and
is at least partially visible. The child always
represents a whole paragraph (and not a fragment only),
because there are no page breaks within headers and
footers.
<li><type scope="::com::sun::star::table"
>AccessibleTableView</type>:
A child of this kind is returned for every table
that is contained in the document body
and is at least partially visible. The child always
represents a whole table (and not a fragment only),
because there are no page breaks within headers and
footers.
</ul>
<p>The logical order of paragraphs and tables is never changed.
<li>The role is either
<const scope="::com::sun::star::accessibility"
>AccessibleRole::HEADER</const> or
<const scope="::com::sun::star::accessibility"
>AccessibleRole::FOOTER</const>.
<li>The name is "header" or "footer" (or the equivalent term
in application's language) with a number appended.
<li>The description is "header" or "footer" (or the equivalent term
in application's language) with the page number appended in
the format that is specified in the page's style.
<li>There are no relations.
<li>The following states might be contained in the state set
returned by <method scope="::com::sun::star::accessibility"
>XAccessible::getAccessibleStateSet</type>:
<ul>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::DEFUNC</const> (indicates that
the document window has been closed or the header or
footer is not existing any longer)
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::EDITABLE</const>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::ENABLED</const> (always contained)
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::OPAQUE</const>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::SHOWING</const>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::VISIBLE</const>
</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 header
or footer.
*/
interface ::com::sun::star::accessibility::XAccessibleComponent;
/** This is the interface for listeners */
interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
